.TH "SbVec2i32" 3 "Thu May 29 2014" "Version 4.0.0a" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SbVec2i32 \- .PP The \fBSbVec2i32\fP class is a 2 dimensional vector with short integer coordinates\&. .PP This vector class is used by many other classes in Coin\&. It provides storage for a vector in 2 dimensions as well as simple integer arithmetic operations\&. .SH SYNOPSIS .br .PP .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBSbVec2i32\fP (void)" .br .ti -1c .RI "\fBSbVec2i32\fP (const int32_t v[2])" .br .ti -1c .RI "\fBSbVec2i32\fP (int32_t x, int32_t y)" .br .ti -1c .RI "\fBSbVec2i32\fP (const \fBSbVec2ui32\fP &v)" .br .ti -1c .RI "\fBSbVec2i32\fP (const \fBSbVec2b\fP &v)" .br .ti -1c .RI "\fBSbVec2i32\fP (const \fBSbVec2s\fP &v)" .br .ti -1c .RI "\fBSbVec2i32\fP (const \fBSbVec2f\fP &v)" .br .ti -1c .RI "\fBSbVec2i32\fP (const \fBSbVec2d\fP &v)" .br .ti -1c .RI "\fBSbVec2i32\fP & \fBsetValue\fP (const int32_t v[2])" .br .ti -1c .RI "\fBSbVec2i32\fP & \fBsetValue\fP (int32_t x, int32_t y)" .br .ti -1c .RI "\fBSbVec2i32\fP & \fBsetValue\fP (const \fBSbVec2ui32\fP &v)" .br .ti -1c .RI "\fBSbVec2i32\fP & \fBsetValue\fP (const \fBSbVec2b\fP &v)" .br .ti -1c .RI "\fBSbVec2i32\fP & \fBsetValue\fP (const \fBSbVec2s\fP &v)" .br .ti -1c .RI "\fBSbVec2i32\fP & \fBsetValue\fP (const \fBSbVec2f\fP &v)" .br .ti -1c .RI "\fBSbVec2i32\fP & \fBsetValue\fP (const \fBSbVec2d\fP &v)" .br .ti -1c .RI "const int32_t * \fBgetValue\fP (void) const " .br .ti -1c .RI "void \fBgetValue\fP (int32_t &x, int32_t &y) const " .br .ti -1c .RI "int32_t & \fBoperator[]\fP (const int i)" .br .ti -1c .RI "const int32_t & \fBoperator[]\fP (const int i) const " .br .ti -1c .RI "int32_t \fBdot\fP (const \fBSbVec2i32\fP &v) const " .br .ti -1c .RI "void \fBnegate\fP (void)" .br .ti -1c .RI "\fBSbVec2i32\fP & \fBoperator*=\fP (int d)" .br .ti -1c .RI "\fBSbVec2i32\fP & \fBoperator*=\fP (double d)" .br .ti -1c .RI "\fBSbVec2i32\fP & \fBoperator/=\fP (int d)" .br .ti -1c .RI "\fBSbVec2i32\fP & \fBoperator/=\fP (double d)" .br .ti -1c .RI "\fBSbVec2i32\fP & \fBoperator+=\fP (const \fBSbVec2i32\fP &v)" .br .ti -1c .RI "\fBSbVec2i32\fP & \fBoperator-=\fP (const \fBSbVec2i32\fP &v)" .br .ti -1c .RI "\fBSbVec2i32\fP \fBoperator-\fP (void) const " .br .ti -1c .RI "void \fBprint\fP (FILE *fp) const " .br .in -1c .SS "Protected Attributes" .in +1c .ti -1c .RI "int32_t \fBvec\fP [2]" .br .in -1c .SS "Related Functions" (Note that these are not member functions\&.) .in +1c .ti -1c .RI "\fBSbVec2i32\fP \fBoperator*\fP (const \fBSbVec2i32\fP &v, int d)" .br .ti -1c .RI "\fBSbVec2i32\fP \fBoperator*\fP (const \fBSbVec2i32\fP &v, double d)" .br .ti -1c .RI "\fBSbVec2i32\fP \fBoperator*\fP (int d, const \fBSbVec2i32\fP &v)" .br .ti -1c .RI "\fBSbVec2i32\fP \fBoperator*\fP (double d, const \fBSbVec2i32\fP &v)" .br .ti -1c .RI "\fBSbVec2i32\fP \fBoperator/\fP (const \fBSbVec2i32\fP &v, int d)" .br .ti -1c .RI "\fBSbVec2i32\fP \fBoperator/\fP (const \fBSbVec2i32\fP &v, double d)" .br .ti -1c .RI "\fBSbVec2i32\fP \fBoperator+\fP (const \fBSbVec2i32\fP &v1, const \fBSbVec2i32\fP &v2)" .br .ti -1c .RI "\fBSbVec2i32\fP \fBoperator-\fP (const \fBSbVec2i32\fP &v1, const \fBSbVec2i32\fP &v2)" .br .ti -1c .RI "int \fBoperator==\fP (const \fBSbVec2i32\fP &v1, const \fBSbVec2i32\fP &v2)" .br .ti -1c .RI "int \fBoperator!=\fP (const \fBSbVec2i32\fP &v1, const \fBSbVec2i32\fP &v2)" .br .in -1c .SH "Detailed Description" .PP The \fBSbVec2i32\fP class is a 2 dimensional vector with short integer coordinates\&. .PP This vector class is used by many other classes in Coin\&. It provides storage for a vector in 2 dimensions as well as simple integer arithmetic operations\&. .PP \fBSee also:\fP .RS 4 \fBSbVec2f\fP, \fBSbVec2d\fP, \fBSbVec3s\fP, \fBSbVec3f\fP, \fBSbVec3d\fP, \fBSbVec4f\fP, \fBSbVec4d\fP\&. .RE .PP .SH "Constructor & Destructor Documentation" .PP .SS "SbVec2i32::SbVec2i32 (void)\fC [inline]\fP" The default constructor does nothing\&. The vector coordinates will be uninitialized until you do a \fBsetValue()\fP\&. .SS "SbVec2i32::SbVec2i32 (const int32_tv[2])\fC [inline]\fP" Constructs an \fBSbVec2i32\fP instance with initial values from \fIv\fP\&. .SS "SbVec2i32::SbVec2i32 (int32_tx, int32_ty)\fC [inline]\fP" Constructs an \fBSbVec2i32\fP instance with the initial vector endpoints from \fIx\fP and \fIy\fP\&. .SS "SbVec2i32::SbVec2i32 (const \fBSbVec2ui32\fP &v)\fC [inline]\fP, \fC [explicit]\fP" .PP \fBSince:\fP .RS 4 Coin 2\&.5 .RE .PP .SS "SbVec2i32::SbVec2i32 (const \fBSbVec2b\fP &v)\fC [inline]\fP, \fC [explicit]\fP" .PP \fBSince:\fP .RS 4 Coin 2\&.5 .RE .PP .SS "SbVec2i32::SbVec2i32 (const \fBSbVec2s\fP &v)\fC [inline]\fP, \fC [explicit]\fP" .PP \fBSince:\fP .RS 4 Coin 2\&.5 .RE .PP .SS "SbVec2i32::SbVec2i32 (const \fBSbVec2f\fP &v)\fC [inline]\fP, \fC [explicit]\fP" .PP \fBSince:\fP .RS 4 Coin 2\&.5 .RE .PP .SS "SbVec2i32::SbVec2i32 (const \fBSbVec2d\fP &v)\fC [inline]\fP, \fC [explicit]\fP" .PP \fBSince:\fP .RS 4 Coin 2\&.5 .RE .PP .SH "Member Function Documentation" .PP .SS "\fBSbVec2i32\fP & SbVec2i32::setValue (const int32_tv[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 "\fBSbVec2i32\fP & SbVec2i32::setValue (int32_tx, int32_ty)\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 "\fBSbVec2i32\fP & SbVec2i32::setValue (const \fBSbVec2ui32\fP &v)" .PP \fBSince:\fP .RS 4 Coin 2\&.5 .RE .PP .SS "\fBSbVec2i32\fP & SbVec2i32::setValue (const \fBSbVec2b\fP &v)" .PP \fBSince:\fP .RS 4 Coin 2\&.5 .RE .PP .SS "\fBSbVec2i32\fP & SbVec2i32::setValue (const \fBSbVec2s\fP &v)" .PP \fBSince:\fP .RS 4 Coin 2\&.5 .RE .PP .SS "\fBSbVec2i32\fP & SbVec2i32::setValue (const \fBSbVec2f\fP &v)" .PP \fBSince:\fP .RS 4 Coin 2\&.5 .RE .PP .SS "\fBSbVec2i32\fP & SbVec2i32::setValue (const \fBSbVec2d\fP &v)" .PP \fBSince:\fP .RS 4 Coin 2\&.5 .RE .PP .SS "const int32_t * SbVec2i32::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 SbVec2i32::getValue (int32_t &x, int32_t &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 "int32_t & SbVec2i32::operator[] (const 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 int32_t & SbVec2i32::operator[] (const inti) const\fC [inline]\fP" Index operator\&. Returns x or y coordinate\&. .PP \fBSee also:\fP .RS 4 \fBgetValue()\fP\&. .RE .PP .SS "int32_t SbVec2i32::dot (const \fBSbVec2i32\fP &v) const\fC [inline]\fP" Calculates and returns the result of taking the dot product of this vector and \fIv\fP\&. .SS "void SbVec2i32::negate (void)\fC [inline]\fP" Negate the vector (i\&.e\&. point it in the opposite direction)\&. .SS "\fBSbVec2i32\fP & SbVec2i32::operator*= (intd)\fC [inline]\fP" Multiply components of vector with value \fId\fP\&. Returns reference to self\&. .SS "\fBSbVec2i32\fP & SbVec2i32::operator*= (doubled)" Multiply components of vector with value \fId\fP\&. Returns reference to self\&. .SS "\fBSbVec2i32\fP & SbVec2i32::operator/= (intd)\fC [inline]\fP" Divides components of vector with value \fId\fP\&. Returns reference to self\&. .SS "\fBSbVec2i32\fP & SbVec2i32::operator/= (doubled)\fC [inline]\fP" Divides components of vector with value \fId\fP\&. Returns reference to self\&. .SS "\fBSbVec2i32\fP & SbVec2i32::operator+= (const \fBSbVec2i32\fP &v)\fC [inline]\fP" Adds this vector and vector \fIv\fP\&. Returns reference to self\&. .SS "\fBSbVec2i32\fP & SbVec2i32::operator-= (const \fBSbVec2i32\fP &v)\fC [inline]\fP" Subtracts vector \fIu\fP from this vector\&. Returns reference to self\&. .SS "\fBSbVec2i32\fP SbVec2i32::operator- (void) const\fC [inline]\fP" Non-destructive negation operator\&. Returns a new \fBSbVec2i32\fP instance which points in the opposite direction of this vector\&. .PP \fBSee also:\fP .RS 4 \fBnegate()\fP\&. .RE .PP .SS "void SbVec2i32::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 "\fBSbVec2i32\fP operator* (const \fBSbVec2i32\fP &v, intd)\fC [related]\fP" Returns an \fBSbVec2i32\fP instance which is the components of vector \fIv\fP multiplied with \fId\fP\&. .SS "\fBSbVec2i32\fP operator* (const \fBSbVec2i32\fP &v, doubled)\fC [related]\fP" Returns an \fBSbVec2i32\fP instance which is the components of vector \fIv\fP multiplied with \fId\fP\&. .SS "\fBSbVec2i32\fP operator* (intd, const \fBSbVec2i32\fP &v)\fC [related]\fP" Returns an \fBSbVec2i32\fP instance which is the components of vector \fIv\fP multiplied with \fId\fP\&. .SS "\fBSbVec2i32\fP operator* (doubled, const \fBSbVec2i32\fP &v)\fC [related]\fP" Returns an \fBSbVec2i32\fP instance which is the components of vector \fIv\fP multiplied with \fId\fP\&. .SS "\fBSbVec2i32\fP operator/ (const \fBSbVec2i32\fP &v, intd)\fC [related]\fP" Returns an \fBSbVec2i32\fP instance which is the components of vector \fIv\fP divided on \fId\fP\&. .SS "\fBSbVec2i32\fP operator/ (const \fBSbVec2i32\fP &v, doubled)\fC [related]\fP" Returns an \fBSbVec2i32\fP instance which is the components of vector \fIv\fP divided on \fId\fP\&. .SS "\fBSbVec2i32\fP operator+ (const \fBSbVec2i32\fP &v1, const \fBSbVec2i32\fP &v2)\fC [related]\fP" Returns an \fBSbVec2i32\fP instance which is the sum of vectors \fIv1\fP and \fIv2\fP\&. .SS "\fBSbVec2i32\fP operator- (const \fBSbVec2i32\fP &v1, const \fBSbVec2i32\fP &v2)\fC [related]\fP" Returns an \fBSbVec2i32\fP instance which is vector \fIv2\fP subtracted from vector \fIv1\fP\&. .SS "int operator== (const \fBSbVec2i32\fP &v1, const \fBSbVec2i32\fP &v2)\fC [related]\fP" Returns \fI1\fP if \fIv1\fP and \fIv2\fP are equal, \fI0\fP otherwise\&. .SS "int operator!= (const \fBSbVec2i32\fP &v1, const \fBSbVec2i32\fP &v2)\fC [related]\fP" Returns \fI1\fP if \fIv1\fP and \fIv2\fP are not equal, \fI0\fP if they are equal\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.