.TH "SbVec2f" 3 "Thu May 29 2014" "Version 4.0.0a" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SbVec2f \- 
.PP
The \fBSbVec2f\fP class is a 2 dimensional vector with floating point coordinates\&.
.PP
This vector class is used by many other classes in Coin\&. It provides storage for a vector in 2 dimensions aswell as simple floating point arithmetic operations on this vector\&.  

.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSbVec2f\fP (void)"
.br
.ti -1c
.RI "\fBSbVec2f\fP (const float v[2])"
.br
.ti -1c
.RI "\fBSbVec2f\fP (float x, float y)"
.br
.ti -1c
.RI "\fBSbVec2f\fP (const \fBSbVec2d\fP &v)"
.br
.ti -1c
.RI "\fBSbVec2f\fP (const \fBSbVec2b\fP &v)"
.br
.ti -1c
.RI "\fBSbVec2f\fP (const \fBSbVec2s\fP &v)"
.br
.ti -1c
.RI "\fBSbVec2f\fP (const \fBSbVec2i32\fP &v)"
.br
.ti -1c
.RI "\fBSbVec2f\fP & \fBsetValue\fP (const float v[2])"
.br
.ti -1c
.RI "\fBSbVec2f\fP & \fBsetValue\fP (float x, float y)"
.br
.ti -1c
.RI "\fBSbVec2f\fP & \fBsetValue\fP (const \fBSbVec2d\fP &v)"
.br
.ti -1c
.RI "\fBSbVec2f\fP & \fBsetValue\fP (const \fBSbVec2b\fP &v)"
.br
.ti -1c
.RI "\fBSbVec2f\fP & \fBsetValue\fP (const \fBSbVec2s\fP &v)"
.br
.ti -1c
.RI "\fBSbVec2f\fP & \fBsetValue\fP (const \fBSbVec2i32\fP &v)"
.br
.ti -1c
.RI "const float * \fBgetValue\fP (void) const "
.br
.ti -1c
.RI "void \fBgetValue\fP (float &x, float &y) const "
.br
.ti -1c
.RI "float & \fBoperator[]\fP (int i)"
.br
.ti -1c
.RI "const float & \fBoperator[]\fP (int i) const "
.br
.ti -1c
.RI "float \fBdot\fP (const \fBSbVec2f\fP &v) const "
.br
.ti -1c
.RI "SbBool \fBequals\fP (const \fBSbVec2f\fP &v, float tolerance) const "
.br
.ti -1c
.RI "float \fBlength\fP (void) const "
.br
.ti -1c
.RI "float \fBsqrLength\fP (void) const "
.br
.ti -1c
.RI "void \fBnegate\fP (void)"
.br
.ti -1c
.RI "float \fBnormalize\fP (void)"
.br
.ti -1c
.RI "\fBSbVec2f\fP & \fBoperator*=\fP (float d)"
.br
.ti -1c
.RI "\fBSbVec2f\fP & \fBoperator/=\fP (float d)"
.br
.ti -1c
.RI "\fBSbVec2f\fP & \fBoperator+=\fP (const \fBSbVec2f\fP &v)"
.br
.ti -1c
.RI "\fBSbVec2f\fP & \fBoperator-=\fP (const \fBSbVec2f\fP &v)"
.br
.ti -1c
.RI "\fBSbVec2f\fP \fBoperator-\fP (void) const "
.br
.ti -1c
.RI "\fBSbString\fP \fBtoString\fP () const "
.br
.ti -1c
.RI "SbBool \fBfromString\fP (const \fBSbString\fP &str)"
.br
.ti -1c
.RI "void \fBprint\fP (FILE *fp) const "
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "float \fBvec\fP [2]"
.br
.in -1c
.SS "Related Functions"
(Note that these are not member functions\&.) 
.in +1c
.ti -1c
.RI "\fBSbVec2f\fP \fBoperator*\fP (const \fBSbVec2f\fP &v, float d)"
.br
.ti -1c
.RI "\fBSbVec2f\fP \fBoperator*\fP (float d, const \fBSbVec2f\fP &v)"
.br
.ti -1c
.RI "\fBSbVec2f\fP \fBoperator/\fP (const \fBSbVec2f\fP &v, float d)"
.br
.ti -1c
.RI "\fBSbVec2f\fP \fBoperator+\fP (const \fBSbVec2f\fP &v1, const \fBSbVec2f\fP &v2)"
.br
.ti -1c
.RI "\fBSbVec2f\fP \fBoperator-\fP (const \fBSbVec2f\fP &v1, const \fBSbVec2f\fP &v2)"
.br
.ti -1c
.RI "int \fBoperator==\fP (const \fBSbVec2f\fP &v1, const \fBSbVec2f\fP &v2)"
.br
.ti -1c
.RI "int \fBoperator!=\fP (const \fBSbVec2f\fP &v1, const \fBSbVec2f\fP &v2)"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSbVec2f\fP class is a 2 dimensional vector with floating point coordinates\&.
.PP
This vector class is used by many other classes in Coin\&. It provides storage for a vector in 2 dimensions aswell as simple floating point arithmetic operations on this vector\&. 


.PP
\fBSee also:\fP
.RS 4
\fBSbVec2s\fP, \fBSbVec2d\fP, \fBSbVec3s\fP, \fBSbVec3f\fP, \fBSbVec3d\fP, \fBSbVec4f\fP, \fBSbVec4d\fP\&. 
.RE
.PP

.SH "Constructor & Destructor Documentation"
.PP 
.SS "SbVec2f::SbVec2f (void)\fC [inline]\fP"
The default constructor does nothing\&. The vector coordinates will be uninitialized until you do a \fBsetValue()\fP\&. 
.SS "SbVec2f::SbVec2f (const floatv[2])\fC [inline]\fP"
Constructs an \fBSbVec2f\fP instance with initial values from \fIv\fP\&. 
.SS "SbVec2f::SbVec2f (floatx, floaty)\fC [inline]\fP"
Constructs an \fBSbVec2f\fP instance with the initial vector endpoints from \fIx\fP and \fIy\fP\&. 
.SS "SbVec2f::SbVec2f (const \fBSbVec2d\fP &v)\fC [inline]\fP, \fC [explicit]\fP"
Constructs an instance from an \fBSbVec2d\fP instance\&.
.PP
\fBSince:\fP
.RS 4
Coin 2\&.5 
.RE
.PP

.SS "SbVec2f::SbVec2f (const \fBSbVec2b\fP &v)\fC [inline]\fP, \fC [explicit]\fP"
Constructs an instance from an \fBSbVec2d\fP instance\&.
.PP
\fBSince:\fP
.RS 4
Coin 2\&.5 
.RE
.PP

.SS "SbVec2f::SbVec2f (const \fBSbVec2s\fP &v)\fC [inline]\fP, \fC [explicit]\fP"
Constructs an instance from an \fBSbVec2d\fP instance\&.
.PP
\fBSince:\fP
.RS 4
Coin 2\&.5 
.RE
.PP

.SS "SbVec2f::SbVec2f (const \fBSbVec2i32\fP &v)\fC [inline]\fP, \fC [explicit]\fP"
Constructs an instance from an \fBSbVec2d\fP instance\&.
.PP
\fBSince:\fP
.RS 4
Coin 2\&.5 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "\fBSbVec2f\fP & SbVec2f::setValue (const floatv[2])\fC [inline]\fP"
Set new x and y coordinates for the vector from \fIv\fP\&. Returns reference to self\&.
.PP
\fBSee also:\fP
.RS 4
\fBgetValue()\fP\&. 
.RE
.PP

.SS "\fBSbVec2f\fP & SbVec2f::setValue (floatx, floaty)\fC [inline]\fP"
Set new x and y coordinates for the vector\&. Returns reference to self\&.
.PP
\fBSee also:\fP
.RS 4
\fBgetValue()\fP\&. 
.RE
.PP

.SS "\fBSbVec2f\fP & SbVec2f::setValue (const \fBSbVec2d\fP &v)"
Sets the value from an \fBSbVec2d\fP instance\&.
.PP
\fBSince:\fP
.RS 4
Coin 2\&.5 
.RE
.PP

.SS "\fBSbVec2f\fP & SbVec2f::setValue (const \fBSbVec2b\fP &v)"
Sets the value from an \fBSbVec2b\fP instance\&.
.PP
\fBSince:\fP
.RS 4
Coin 2\&.5 
.RE
.PP

.SS "\fBSbVec2f\fP & SbVec2f::setValue (const \fBSbVec2s\fP &v)"
Sets the value from an \fBSbVec2s\fP instance\&.
.PP
\fBSince:\fP
.RS 4
Coin 2\&.5 
.RE
.PP

.SS "\fBSbVec2f\fP & SbVec2f::setValue (const \fBSbVec2i32\fP &v)"
Sets the value from an \fBSbVec2i32\fP instance\&.
.PP
\fBSince:\fP
.RS 4
Coin 2\&.5 
.RE
.PP

.SS "const float * SbVec2f::getValue (void) const\fC [inline]\fP"
Returns a pointer to an array of two floats containing the x and y coordinates of the vector\&.
.PP
\fBSee also:\fP
.RS 4
\fBsetValue()\fP\&. 
.RE
.PP

.SS "void SbVec2f::getValue (float &x, float &y) const\fC [inline]\fP"
Returns the x and y coordinates of the vector\&.
.PP
\fBSee also:\fP
.RS 4
\fBsetValue()\fP\&. 
.RE
.PP

.SS "float & SbVec2f::operator[] (inti)\fC [inline]\fP"
Index operator\&. Returns modifiable x or y coordinate\&.
.PP
\fBSee also:\fP
.RS 4
\fBgetValue()\fP and \fBsetValue()\fP\&. 
.RE
.PP

.SS "const float & SbVec2f::operator[] (inti) const\fC [inline]\fP"
Index operator\&. Returns x or y coordinate\&.
.PP
\fBSee also:\fP
.RS 4
\fBgetValue()\fP\&. 
.RE
.PP

.SS "float SbVec2f::dot (const \fBSbVec2f\fP &v) const\fC [inline]\fP"
Calculates and returns the result of taking the dot product of this vector and \fIv\fP\&. 
.SS "SbBool SbVec2f::equals (const \fBSbVec2f\fP &v, floattolerance) const"
Compares the vector with \fIv\fP and returns \fCTRUE\fP if the distance between the vectors is smaller or equal to the square root of \fItolerance\fP\&. 
.SS "float SbVec2f::length (void) const"
Return length of vector\&. 
.SS "float SbVec2f::sqrLength (void) const\fC [inline]\fP"
Returns the square of the length of the vector\&.
.PP
\fBSince:\fP
.RS 4
Coin 2\&.5 
.RE
.PP

.SS "void SbVec2f::negate (void)\fC [inline]\fP"
Negate the vector (i\&.e\&. point it in the opposite direction)\&. 
.SS "float SbVec2f::normalize (void)"
Normalize the vector to unit length\&. Return value is the original length of the vector before normalization\&. 
.SS "\fBSbVec2f\fP & SbVec2f::operator*= (floatd)\fC [inline]\fP"
Multiply components of vector with value \fId\fP\&. Returns reference to self\&. 
.SS "\fBSbVec2f\fP & SbVec2f::operator/= (floatd)\fC [inline]\fP"
Divides components of vector with value \fId\fP\&. Returns reference to self\&. 
.SS "\fBSbVec2f\fP & SbVec2f::operator+= (const \fBSbVec2f\fP &v)\fC [inline]\fP"
Adds this vector and vector \fIu\fP\&. Returns reference to self\&. 
.SS "\fBSbVec2f\fP & SbVec2f::operator-= (const \fBSbVec2f\fP &v)\fC [inline]\fP"
Subtracts vector \fIu\fP from this vector\&. Returns reference to self\&. 
.SS "\fBSbVec2f\fP SbVec2f::operator- (void) const\fC [inline]\fP"
Non-destructive negation operator\&. Returns a new \fBSbVec2f\fP instance which points in the opposite direction of this vector\&.
.PP
\fBSee also:\fP
.RS 4
\fBnegate()\fP\&. 
.RE
.PP

.SS "\fBSbString\fP SbVec2f::toString () const"
Return a string representation of this object 
.SS "SbBool SbVec2f::fromString (const \fBSbString\fP &str)"
Convert from a string representation, return wether this is a valid conversion 
.SS "void SbVec2f::print (FILE *fp) const"
Dump the state of this object to the \fIfile\fP stream\&. Only works in debug version of library, method does nothing in an optimized compile\&. 
.SH "Friends And Related Function Documentation"
.PP 
.SS "\fBSbVec2f\fP operator* (const \fBSbVec2f\fP &v, floatd)\fC [related]\fP"
Returns an \fBSbVec2f\fP instance which is the components of vector \fIv\fP multiplied with \fId\fP\&. 
.SS "\fBSbVec2f\fP operator* (floatd, const \fBSbVec2f\fP &v)\fC [related]\fP"
Returns an \fBSbVec2f\fP instance which is the components of vector \fIv\fP multiplied with \fId\fP\&. 
.SS "\fBSbVec2f\fP operator/ (const \fBSbVec2f\fP &v, floatd)\fC [related]\fP"
Returns an \fBSbVec2f\fP instance which is the components of vector \fIv\fP divided on the scalar factor \fId\fP\&. 
.SS "\fBSbVec2f\fP operator+ (const \fBSbVec2f\fP &v1, const \fBSbVec2f\fP &v2)\fC [related]\fP"
Returns an \fBSbVec2f\fP instance which is the sum of vectors \fIv1\fP and \fIv2\fP\&. 
.SS "\fBSbVec2f\fP operator- (const \fBSbVec2f\fP &v1, const \fBSbVec2f\fP &v2)\fC [related]\fP"
Returns an \fBSbVec2f\fP instance which is vector \fIv2\fP subtracted from vector \fIv1\fP\&. 
.SS "int operator== (const \fBSbVec2f\fP &v1, const \fBSbVec2f\fP &v2)\fC [related]\fP"
Returns \fI1\fP if \fIv1\fP and \fIv2\fP are equal, \fI0\fP otherwise\&.
.PP
\fBSee also:\fP
.RS 4
\fBequals()\fP\&. 
.RE
.PP

.SS "int operator!= (const \fBSbVec2f\fP &v1, const \fBSbVec2f\fP &v2)\fC [related]\fP"
Returns \fI1\fP if \fIv1\fP and \fIv2\fP are not equal, \fI0\fP if they are equal\&.
.PP
\fBSee also:\fP
.RS 4
\fBequals()\fP\&. 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.