.TH "SbVec3s" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SbVec3s \- The \fBSbVec3s\fP class is a 3 dimensional vector with short integer coordinates\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/SbVec3s\&.h>\fP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSbVec3s\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBSbVec3s\fP (\fBconst\fP short v[3])"
.br
.ti -1c
.RI "\fBSbVec3s\fP (short x, short y, short z)"
.br
.ti -1c
.RI "\fBSbVec3s\fP (\fBconst\fP \fBSbVec3us\fP &v)"
.br
.ti -1c
.RI "\fBSbVec3s\fP (\fBconst\fP \fBSbVec3b\fP &v)"
.br
.ti -1c
.RI "\fBSbVec3s\fP (\fBconst\fP \fBSbVec3i32\fP &v)"
.br
.ti -1c
.RI "\fBSbVec3s\fP (\fBconst\fP \fBSbVec3f\fP &v)"
.br
.ti -1c
.RI "\fBSbVec3s\fP (\fBconst\fP \fBSbVec3d\fP &v)"
.br
.ti -1c
.RI "\fBSbVec3s\fP & \fBsetValue\fP (\fBconst\fP short v[3])"
.br
.ti -1c
.RI "\fBSbVec3s\fP & \fBsetValue\fP (short x, short y, short z)"
.br
.ti -1c
.RI "\fBSbVec3s\fP & \fBsetValue\fP (\fBconst\fP \fBSbVec3us\fP &v)"
.br
.ti -1c
.RI "\fBSbVec3s\fP & \fBsetValue\fP (\fBconst\fP \fBSbVec3b\fP &v)"
.br
.ti -1c
.RI "\fBSbVec3s\fP & \fBsetValue\fP (\fBconst\fP \fBSbVec3i32\fP &v)"
.br
.ti -1c
.RI "\fBSbVec3s\fP & \fBsetValue\fP (\fBconst\fP \fBSbVec3f\fP &v)"
.br
.ti -1c
.RI "\fBSbVec3s\fP & \fBsetValue\fP (\fBconst\fP \fBSbVec3d\fP &v)"
.br
.ti -1c
.RI "\fBconst\fP short * \fBgetValue\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBgetValue\fP (short &x, short &y, short &z) \fBconst\fP"
.br
.ti -1c
.RI "short & \fBoperator[]\fP (int \fBi\fP)"
.br
.ti -1c
.RI "\fBconst\fP short & \fBoperator[]\fP (int \fBi\fP) \fBconst\fP"
.br
.ti -1c
.RI "int32_t \fBdot\fP (\fBconst\fP \fBSbVec3s\fP &v) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBnegate\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBSbVec3s\fP & \fBoperator*=\fP (int d)"
.br
.ti -1c
.RI "\fBSbVec3s\fP & \fBoperator*=\fP (double d)"
.br
.ti -1c
.RI "\fBSbVec3s\fP & \fBoperator/=\fP (int d)"
.br
.ti -1c
.RI "\fBSbVec3s\fP & \fBoperator/=\fP (double d)"
.br
.ti -1c
.RI "\fBSbVec3s\fP & \fBoperator+=\fP (\fBconst\fP \fBSbVec3s\fP &v)"
.br
.ti -1c
.RI "\fBSbVec3s\fP & \fBoperator\-=\fP (\fBconst\fP \fBSbVec3s\fP &v)"
.br
.ti -1c
.RI "\fBSbVec3s\fP \fBoperator\-\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSbString\fP \fBtoString\fP () \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBfromString\fP (\fBconst\fP \fBSbString\fP &str)"
.br
.ti -1c
.RI "\fBvoid\fP \fBprint\fP (\fBFILE\fP *fp) \fBconst\fP"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "short \fBvec\fP [3]"
.br
.in -1c
.SS "Related Symbols"
(Note that these are not member symbols\&.) 
.in +1c
.ti -1c
.RI "\fBSbVec3s\fP \fBoperator*\fP (\fBconst\fP \fBSbVec3s\fP &v, int d)"
.br
.ti -1c
.RI "\fBSbVec3s\fP \fBoperator*\fP (\fBconst\fP \fBSbVec3s\fP &v, double d)"
.br
.ti -1c
.RI "\fBSbVec3s\fP \fBoperator*\fP (int d, \fBconst\fP \fBSbVec3s\fP &v)"
.br
.ti -1c
.RI "\fBSbVec3s\fP \fBoperator*\fP (double d, \fBconst\fP \fBSbVec3s\fP &v)"
.br
.ti -1c
.RI "\fBSbVec3s\fP \fBoperator/\fP (\fBconst\fP \fBSbVec3s\fP &v, int d)"
.br
.ti -1c
.RI "\fBSbVec3s\fP \fBoperator/\fP (\fBconst\fP \fBSbVec3s\fP &v, double d)"
.br
.ti -1c
.RI "\fBSbVec3s\fP \fBoperator+\fP (\fBconst\fP \fBSbVec3s\fP &\fBv1\fP, \fBconst\fP \fBSbVec3s\fP &\fBv2\fP)"
.br
.ti -1c
.RI "\fBSbVec3s\fP \fBoperator\-\fP (\fBconst\fP \fBSbVec3s\fP &\fBv1\fP, \fBconst\fP \fBSbVec3s\fP &\fBv2\fP)"
.br
.ti -1c
.RI "int \fBoperator==\fP (\fBconst\fP \fBSbVec3s\fP &\fBv1\fP, \fBconst\fP \fBSbVec3s\fP &\fBv2\fP)"
.br
.ti -1c
.RI "int \fBoperator!=\fP (\fBconst\fP \fBSbVec3s\fP &\fBv1\fP, \fBconst\fP \fBSbVec3s\fP &\fBv2\fP)"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSbVec3s\fP class is a 3 dimensional vector with short integer coordinates\&. 

This vector class provides storage for a 3 dimensional vector as well as simple integer arithmetic operations\&.
.PP
Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor \fBv2\&.1\fP API\&.
.br
 
.PP
\fBSee also\fP
.RS 4
\fBSbVec2s\fP, \fBSbVec2f\fP, \fBSbVec2d\fP, \fBSbVec3f\fP, \fBSbVec3d\fP, \fBSbVec4f\fP, \fBSbVec4d\fP\&. 
.RE
.PP
\fBSince\fP
.RS 4
Coin \fB2\&.0\fP 
.PP
TGS Inventor ?\&.? 
.RE
.PP

.SH "Constructor & Destructor Documentation"
.PP 
.SS "SbVec3s::SbVec3s (\fBvoid\fP)\fC [inline]\fP"
The default constructor does nothing\&. The vector coordinates will be uninitialized until you do a \fBsetValue()\fP call\&. 
.SS "SbVec3s::SbVec3s (\fBconst\fP short v[3])\fC [inline]\fP"
Constructs an \fBSbVec3s\fP instance with initial values from \fIv\fP\&. 
.SS "SbVec3s::SbVec3s (short x, short y, short z)\fC [inline]\fP"
Constructs an \fBSbVec3s\fP instance with the initial vector endpoint set to \fI<x\fP,y,z>\&. 
.SS "SbVec3s::SbVec3s (\fBconst\fP \fBSbVec3us\fP & v)\fC [inline]\fP, \fC [explicit]\fP"

.PP
\fBSince\fP
.RS 4
Coin \fB2\&.5\fP 
.RE
.PP

.SS "SbVec3s::SbVec3s (\fBconst\fP \fBSbVec3b\fP & v)\fC [inline]\fP, \fC [explicit]\fP"

.PP
\fBSince\fP
.RS 4
Coin \fB2\&.5\fP 
.RE
.PP

.SS "SbVec3s::SbVec3s (\fBconst\fP \fBSbVec3i32\fP & v)\fC [inline]\fP, \fC [explicit]\fP"

.PP
\fBSince\fP
.RS 4
Coin \fB2\&.5\fP 
.RE
.PP

.SS "SbVec3s::SbVec3s (\fBconst\fP \fBSbVec3f\fP & v)\fC [inline]\fP, \fC [explicit]\fP"

.PP
\fBSince\fP
.RS 4
Coin \fB2\&.5\fP 
.RE
.PP

.SS "SbVec3s::SbVec3s (\fBconst\fP \fBSbVec3d\fP & v)\fC [inline]\fP, \fC [explicit]\fP"

.PP
\fBSince\fP
.RS 4
Coin \fB2\&.5\fP 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "\fBSbVec3s\fP & SbVec3s::setValue (\fBconst\fP short v[3])\fC [inline]\fP"
Set new coordinates for the vector from \fIv\fP\&. Returns reference to self\&.
.PP
\fBSee also\fP
.RS 4
\fBgetValue()\fP\&. 
.RE
.PP

.SS "\fBSbVec3s\fP & SbVec3s::setValue (short x, short y, short z)\fC [inline]\fP"
Set new coordinates for the vector\&. Returns reference to self\&.
.PP
\fBSee also\fP
.RS 4
\fBgetValue()\fP\&. 
.RE
.PP

.SS "\fBSbVec3s\fP & SbVec3s::setValue (\fBconst\fP \fBSbVec3us\fP & v)"
Sets the value from an \fBSbVec3us\fP instance\&.
.PP
\fBSince\fP
.RS 4
Coin \fB2\&.5\fP 
.RE
.PP

.SS "\fBSbVec3s\fP & SbVec3s::setValue (\fBconst\fP \fBSbVec3b\fP & v)"
Sets the value from an \fBSbVec3b\fP instance\&.
.PP
\fBSince\fP
.RS 4
Coin \fB2\&.5\fP 
.RE
.PP

.SS "\fBSbVec3s\fP & SbVec3s::setValue (\fBconst\fP \fBSbVec3i32\fP & v)"
Sets the value from an \fBSbVec3i32\fP instance\&.
.PP
\fBSince\fP
.RS 4
Coin \fB2\&.5\fP 
.RE
.PP

.SS "\fBSbVec3s\fP & SbVec3s::setValue (\fBconst\fP \fBSbVec3f\fP & v)"
Sets the value from an \fBSbVec3f\fP instance\&.
.PP
\fBSince\fP
.RS 4
Coin \fB2\&.5\fP 
.RE
.PP

.SS "\fBSbVec3s\fP & SbVec3s::setValue (\fBconst\fP \fBSbVec3d\fP & v)"
Sets the value from an \fBSbVec3d\fP instance\&.
.PP
\fBSince\fP
.RS 4
Coin \fB2\&.5\fP 
.RE
.PP

.SS "\fBconst\fP short * SbVec3s::getValue (\fBvoid\fP) const\fC [inline]\fP"
Returns a pointer to an array of three shorts containing the x, y and z coordinates of the vector\&.
.PP
\fBSee also\fP
.RS 4
\fBsetValue()\fP\&. 
.RE
.PP

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

.SS "short & SbVec3s::operator[] (int i)\fC [inline]\fP"
Index operator\&. Returns modifiable x, y or z coordinate of vector\&.
.PP
\fBSee also\fP
.RS 4
\fBgetValue()\fP and \fBsetValue()\fP\&. 
.RE
.PP

.SS "short SbVec3s::operator[] (int i) const\fC [inline]\fP"
Index operator\&. Returns x, y or z coordinate of vector\&.
.PP
\fBSee also\fP
.RS 4
\fBgetValue()\fP and \fBsetValue()\fP\&. 
.RE
.PP

.SS "int32_t SbVec3s::dot (\fBconst\fP \fBSbVec3s\fP & v) const\fC [inline]\fP"
Calculates and returns the result of taking the dot product of this vector and \fIv\fP\&. 
.SS "\fBvoid\fP SbVec3s::negate (\fBvoid\fP)\fC [inline]\fP"
Negate the vector (i\&.e\&. point it in the opposite direction)\&. 
.SS "\fBSbVec3s\fP & SbVec3s::operator*= (int d)\fC [inline]\fP"
Multiply components of vector with value \fId\fP\&. Returns reference to self\&. 
.SS "\fBSbVec3s\fP & SbVec3s::operator*= (double d)"
Multiply components of vector with value \fId\fP\&. Returns reference to self\&. 
.SS "\fBSbVec3s\fP & SbVec3s::operator/= (int d)\fC [inline]\fP"
Divides components of vector with value \fId\fP\&. Returns reference to self\&. 
.SS "\fBSbVec3s\fP & SbVec3s::operator/= (double d)\fC [inline]\fP"
Divides components of vector with value \fId\fP\&. Returns reference to self\&. 
.SS "\fBSbVec3s\fP & SbVec3s::operator+= (\fBconst\fP \fBSbVec3s\fP & v)\fC [inline]\fP"
Adds this vector and vector \fIv\fP\&. Returns reference to self\&. 
.SS "\fBSbVec3s\fP & SbVec3s::operator\-= (\fBconst\fP \fBSbVec3s\fP & v)\fC [inline]\fP"
Subtracts vector \fIv\fP from this vector\&. Returns reference to self\&. 
.SS "\fBSbVec3s\fP SbVec3s::operator\- (\fBvoid\fP) const\fC [inline]\fP"
Non-destructive negation operator\&. Returns a new \fBSbVec3s\fP instance which points in the opposite direction of this vector\&.
.PP
\fBSee also\fP
.RS 4
\fBnegate()\fP\&. 
.RE
.PP

.SS "\fBSbString\fP SbVec3s::toString () const"
Return a string representation of this object 
.SS "SbBool SbVec3s::fromString (\fBconst\fP \fBSbString\fP & str)"
Convert from a string representation, return whether this is a valid conversion 
.SS "\fBvoid\fP SbVec3s::print (\fBFILE\fP * fp) const"
Dump the state of this object to the \fIfp\fP file stream\&. Only works in debug version of library, method does nothing in an optimized build\&. 
.SH "Friends And Related Symbol Documentation"
.PP 
.SS "\fBSbVec3s\fP \fBoperator\fP* (\fBconst\fP \fBSbVec3s\fP & v, int d)\fC [related]\fP"
Returns an \fBSbVec3s\fP instance which is the components of vector \fIv\fP multiplied with \fId\fP\&. 
.SS "\fBSbVec3s\fP \fBoperator\fP* (\fBconst\fP \fBSbVec3s\fP & v, double d)\fC [related]\fP"
Returns an \fBSbVec3s\fP instance which is the components of vector \fIv\fP multiplied with \fId\fP\&. 
.SS "\fBSbVec3s\fP \fBoperator\fP* (int d, \fBconst\fP \fBSbVec3s\fP & v)\fC [related]\fP"
Returns an \fBSbVec3s\fP instance which is the components of vector \fIv\fP multiplied with \fId\fP\&. 
.SS "\fBSbVec3s\fP \fBoperator\fP* (double d, \fBconst\fP \fBSbVec3s\fP & v)\fC [related]\fP"
Returns an \fBSbVec3s\fP instance which is the components of vector \fIv\fP multiplied with \fId\fP\&. 
.SS "\fBSbVec3s\fP \fBoperator\fP/ (\fBconst\fP \fBSbVec3s\fP & v, int d)\fC [related]\fP"
Returns an \fBSbVec3s\fP instance which is the components of vector \fIv\fP divided on the scalar factor \fId\fP\&. 
.SS "\fBSbVec3s\fP \fBoperator\fP/ (\fBconst\fP \fBSbVec3s\fP & v, double d)\fC [related]\fP"
Returns an \fBSbVec3s\fP instance which is the components of vector \fIv\fP divided on \fId\fP\&. 
.SS "\fBSbVec3s\fP \fBoperator\fP+ (\fBconst\fP \fBSbVec3s\fP & v1, \fBconst\fP \fBSbVec3s\fP & v2)\fC [related]\fP"
Returns an \fBSbVec3s\fP instance which is the sum of vectors \fIv1\fP and \fIv2\fP\&. 
.SS "\fBSbVec3s\fP \fBoperator\fP\- (\fBconst\fP \fBSbVec3s\fP & v1, \fBconst\fP \fBSbVec3s\fP & v2)\fC [related]\fP"
Returns an \fBSbVec3s\fP instance which is vector \fIv2\fP subtracted from vector \fIv1\fP\&. 
.SS "int \fBoperator\fP== (\fBconst\fP \fBSbVec3s\fP & v1, \fBconst\fP \fBSbVec3s\fP & v2)\fC [related]\fP"
Returns \fI1\fP if \fIv1\fP and \fIv2\fP are \fIexactly\fP equal, \fI0\fP otherwise\&. 
.SS "int operator!= (\fBconst\fP \fBSbVec3s\fP & v1, \fBconst\fP \fBSbVec3s\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\&.