257 lines
14 KiB
HTML
257 lines
14 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
|
|
<HTML>
|
|
<HEAD>
|
|
<TITLE>class osg::Vec2f</TITLE>
|
|
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.6">
|
|
</HEAD>
|
|
<BODY BGCOLOR="#ffffff">
|
|
|
|
<H2>class <A HREF="#DOC.DOCU">osg::Vec2f</A></H2></H2><BLOCKQUOTE>General purpose float pair, uses include representation of texture coordinates.</BLOCKQUOTE>
|
|
<HR>
|
|
|
|
<DL>
|
|
<P><DL>
|
|
<DT><H3>Public Fields</H3><DD><DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> <B><A HREF="#DOC.2.261.2">_v</A></B>[2]
|
|
</DL></P>
|
|
|
|
<P><DL>
|
|
<DT><H3>Public Methods</H3><DD><DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.261.3">Vec2f</A></B>()
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.261.4">Vec2f</A></B>(<!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> <!1><A HREF="Vec2f.html#DOC.2.261.13">x</A>, <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> <!1><A HREF="Vec2f.html#DOC.2.261.14">y</A>)
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline bool <B><A HREF="#DOC.2.261.5">operator == </A></B>(const <!1><A HREF="Vec2f.html">Vec2f</A>& v) const
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline bool <B><A HREF="#DOC.2.261.6">operator != </A></B>(const <!1><A HREF="Vec2f.html">Vec2f</A>& v) const
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline bool <B><A HREF="#DOC.2.261.7">operator < </A></B>(const <!1><A HREF="Vec2f.html">Vec2f</A>& v) const
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A>* <B><A HREF="#DOC.2.261.8">ptr</A></B>()
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A>* <B><A HREF="#DOC.2.261.9">ptr</A></B>() const
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline void <B><A HREF="#DOC.2.261.10">set</A></B>( <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> <!1><A HREF="Vec2f.html#DOC.2.261.13">x</A>, <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> <!1><A HREF="Vec2f.html#DOC.2.261.14">y</A> )
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A>& <B><A HREF="#DOC.2.261.11">operator [] </A></B>(int i)
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> <B><A HREF="#DOC.2.261.12">operator [] </A></B>(int i) const
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A>& <B><A HREF="#DOC.2.261.13">x</A></B>()
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A>& <B><A HREF="#DOC.2.261.14">y</A></B>()
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> <B><A HREF="#DOC.2.261.15">x</A></B>() const
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> <B><A HREF="#DOC.2.261.16">y</A></B>() const
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline bool <B><A HREF="#DOC.2.261.17">valid</A></B>() const
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline bool <B><A HREF="#DOC.2.261.18">isNaN</A></B>() const
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> <B><A HREF="#DOC.2.261.19">operator * </A></B>(const <!1><A HREF="Vec2f.html">Vec2f</A>& rhs) const
|
|
<DD><I>dot product</I>
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="Vec2f.html">Vec2f</A> <B><A HREF="#DOC.2.261.20">operator * </A></B>(<!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> rhs) const
|
|
<DD><I>multiply by scalar</I>
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Vec2f.html">Vec2f</A>& <B><A HREF="#DOC.2.261.21">operator *= </A></B>(<!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> rhs)
|
|
<DD><I>unary multiply by scalar</I>
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="Vec2f.html">Vec2f</A> <B><A HREF="#DOC.2.261.22">operator / </A></B>(<!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> rhs) const
|
|
<DD><I>divide by scalar</I>
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Vec2f.html">Vec2f</A>& <B><A HREF="#DOC.2.261.23">operator /= </A></B>(<!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> rhs)
|
|
<DD><I>unary divide by scalar</I>
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="Vec2f.html">Vec2f</A> <B><A HREF="#DOC.2.261.24">operator + </A></B>(const <!1><A HREF="Vec2f.html">Vec2f</A>& rhs) const
|
|
<DD><I>binary vector add</I>
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Vec2f.html">Vec2f</A>& <B><A HREF="#DOC.2.261.25">operator += </A></B>(const <!1><A HREF="Vec2f.html">Vec2f</A>& rhs)
|
|
<DD><I>unary vector add.</I>
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="Vec2f.html">Vec2f</A> <B><A HREF="#DOC.2.261.26">operator - </A></B>(const <!1><A HREF="Vec2f.html">Vec2f</A>& rhs) const
|
|
<DD><I>binary vector subtract</I>
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Vec2f.html">Vec2f</A>& <B><A HREF="#DOC.2.261.27">operator -= </A></B>(const <!1><A HREF="Vec2f.html">Vec2f</A>& rhs)
|
|
<DD><I>unary vector subtract</I>
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline const <!1><A HREF="Vec2f.html">Vec2f</A> <B><A HREF="#DOC.2.261.28">operator - </A></B>() const
|
|
<DD><I>negation operator.</I>
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> <B><A HREF="#DOC.2.261.29">length</A></B>() const
|
|
<DD><I>Length of the vector = sqrt( vec .</I>
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> <B><A HREF="#DOC.2.261.30">length2</A></B>( void ) const
|
|
<DD><I>Length squared of the vector = vec .</I>
|
|
<DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> <B><A HREF="#DOC.2.261.31">normalize</A></B>()
|
|
<DD><I>normalize the vector so that it has length unity returns the previous length of the vector</I>
|
|
</DL></P>
|
|
|
|
<P><DL>
|
|
<DT><H3>Public</H3><DD><DT>
|
|
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>typedef float <B><A HREF="#DOC.2.261.1">value_type</A></B>
|
|
</DL></P>
|
|
|
|
</DL>
|
|
|
|
<A NAME="DOC.DOCU"></A>
|
|
<HR>
|
|
<H2>Documentation</H2>
|
|
<BLOCKQUOTE>General purpose float pair, uses include representation of
|
|
texture coordinates.
|
|
No support yet added for float * Vec2f - is it necessary?
|
|
Need to define a non-member non-friend operator* etc.
|
|
BTW: Vec2f * float is okay</BLOCKQUOTE>
|
|
<DL>
|
|
|
|
<A NAME="value_type"></A>
|
|
<A NAME="DOC.2.261.1"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>typedef float value_type</B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="_v"></A>
|
|
<A NAME="DOC.2.261.2"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> _v[2]</B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="Vec2f"></A>
|
|
<A NAME="DOC.2.261.3"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> Vec2f()</B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="Vec2f"></A>
|
|
<A NAME="DOC.2.261.4"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> Vec2f(<!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> <!1><A HREF="Vec2f.html#DOC.2.261.13">x</A>, <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> <!1><A HREF="Vec2f.html#DOC.2.261.14">y</A>)</B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="operator == "></A>
|
|
<A NAME="DOC.2.261.5"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline bool operator == (const <!1><A HREF="Vec2f.html">Vec2f</A>& v) const </B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="operator != "></A>
|
|
<A NAME="DOC.2.261.6"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline bool operator != (const <!1><A HREF="Vec2f.html">Vec2f</A>& v) const </B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="operator < "></A>
|
|
<A NAME="DOC.2.261.7"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline bool operator < (const <!1><A HREF="Vec2f.html">Vec2f</A>& v) const </B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="ptr"></A>
|
|
<A NAME="DOC.2.261.8"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A>* ptr()</B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="ptr"></A>
|
|
<A NAME="DOC.2.261.9"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A>* ptr() const </B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="set"></A>
|
|
<A NAME="DOC.2.261.10"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline void set( <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> <!1><A HREF="Vec2f.html#DOC.2.261.13">x</A>, <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> <!1><A HREF="Vec2f.html#DOC.2.261.14">y</A> )</B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="operator [] "></A>
|
|
<A NAME="DOC.2.261.11"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A>& operator [] (int i)</B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="operator [] "></A>
|
|
<A NAME="DOC.2.261.12"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> operator [] (int i) const </B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="x"></A>
|
|
<A NAME="DOC.2.261.13"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A>& x()</B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="y"></A>
|
|
<A NAME="DOC.2.261.14"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A>& y()</B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="x"></A>
|
|
<A NAME="DOC.2.261.15"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> x() const </B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="y"></A>
|
|
<A NAME="DOC.2.261.16"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> y() const </B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="valid"></A>
|
|
<A NAME="DOC.2.261.17"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline bool valid() const </B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="isNaN"></A>
|
|
<A NAME="DOC.2.261.18"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline bool isNaN() const </B></TT>
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="operator * "></A>
|
|
<A NAME="DOC.2.261.19"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> operator * (const <!1><A HREF="Vec2f.html">Vec2f</A>& rhs) const </B></TT>
|
|
<DD>dot product
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="operator * "></A>
|
|
<A NAME="DOC.2.261.20"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="Vec2f.html">Vec2f</A> operator * (<!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> rhs) const </B></TT>
|
|
<DD>multiply by scalar
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="operator *= "></A>
|
|
<A NAME="DOC.2.261.21"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Vec2f.html">Vec2f</A>& operator *= (<!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> rhs)</B></TT>
|
|
<DD>unary multiply by scalar
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="operator / "></A>
|
|
<A NAME="DOC.2.261.22"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="Vec2f.html">Vec2f</A> operator / (<!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> rhs) const </B></TT>
|
|
<DD>divide by scalar
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="operator /= "></A>
|
|
<A NAME="DOC.2.261.23"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Vec2f.html">Vec2f</A>& operator /= (<!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> rhs)</B></TT>
|
|
<DD>unary divide by scalar
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="operator + "></A>
|
|
<A NAME="DOC.2.261.24"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="Vec2f.html">Vec2f</A> operator + (const <!1><A HREF="Vec2f.html">Vec2f</A>& rhs) const </B></TT>
|
|
<DD>binary vector add
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="operator += "></A>
|
|
<A NAME="DOC.2.261.25"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Vec2f.html">Vec2f</A>& operator += (const <!1><A HREF="Vec2f.html">Vec2f</A>& rhs)</B></TT>
|
|
<DD>unary vector add. Slightly more efficient because no temporary
|
|
intermediate object.
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="operator - "></A>
|
|
<A NAME="DOC.2.261.26"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="Vec2f.html">Vec2f</A> operator - (const <!1><A HREF="Vec2f.html">Vec2f</A>& rhs) const </B></TT>
|
|
<DD>binary vector subtract
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="operator -= "></A>
|
|
<A NAME="DOC.2.261.27"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Vec2f.html">Vec2f</A>& operator -= (const <!1><A HREF="Vec2f.html">Vec2f</A>& rhs)</B></TT>
|
|
<DD>unary vector subtract
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="operator - "></A>
|
|
<A NAME="DOC.2.261.28"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline const <!1><A HREF="Vec2f.html">Vec2f</A> operator - () const </B></TT>
|
|
<DD>negation operator. Returns the negative of the Vec2f
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="length"></A>
|
|
<A NAME="DOC.2.261.29"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> length() const </B></TT>
|
|
<DD>Length of the vector = sqrt( vec . vec )
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="length2"></A>
|
|
<A NAME="DOC.2.261.30"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> length2( void ) const </B></TT>
|
|
<DD>Length squared of the vector = vec . vec
|
|
<DL><DT><DD></DL><P>
|
|
<A NAME="normalize"></A>
|
|
<A NAME="DOC.2.261.31"></A>
|
|
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>inline <!1><A HREF="Vec2f.html#DOC.2.261.1">value_type</A> normalize()</B></TT>
|
|
<DD>normalize the vector so that it has length unity
|
|
returns the previous length of the vector
|
|
<DL><DT><DD></DL><P></DL>
|
|
|
|
<HR><DL><DT><B>This class has no child classes.</B></DL>
|
|
|
|
<DL><DT><DT><B>Friends:</B><DD> inline std::ostream& operator << (std::ostream& output, const <!1><A HREF="Vec2f.html">Vec2f</A>& vec)<BR><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I> <I><A HREF="HIER.html">HTML hierarchy of classes</A> or <A HREF="HIERjava.html">Java</A></I></P><HR>
|
|
<BR>
|
|
This page was generated with the help of <A HREF="http://www.linuxsupportline.com/~doc++">DOC++</A>.
|
|
</BODY>
|
|
</HTML>
|