NAME
SbVec3s -
The SbVec3s 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.
SYNOPSIS
#include <Inventor/SbLinear.h>
Public Member Functions
SbVec3s (void)
SbVec3s (const short v[3])
SbVec3s (short x, short y, short z)
SbVec3s (const SbVec3us &v)
SbVec3s (const SbVec3b &v)
SbVec3s (const SbVec3i32 &v)
SbVec3s (const SbVec3f &v)
SbVec3s (const SbVec3d &v)
SbVec3s & setValue (const short v[3])
SbVec3s & setValue (short x, short y, short z)
SbVec3s & setValue (const SbVec3us &v)
SbVec3s & setValue (const SbVec3b &v)
SbVec3s & setValue (const SbVec3i32 &v)
SbVec3s & setValue (const SbVec3f &v)
SbVec3s & setValue (const SbVec3d &v)
const short * getValue (void) const
void getValue (short &x, short &y, short &z) const
short & operator[] (int i)
const short & operator[] (int i) const
int32_t dot (const SbVec3s &v) const
void negate (void)
SbVec3s & operator*= (int d)
SbVec3s & operator*= (double d)
SbVec3s & operator/= (int d)
SbVec3s & operator/= (double d)
SbVec3s & operator+= (const SbVec3s &v)
SbVec3s & operator-= (const SbVec3s &v)
SbVec3s operator- (void) const
void print (FILE *fp) const
Protected Attributes
short vec [3]
Related Functions
(Note that these are not member functions.)
SbVec3s operator* (const SbVec3s &v, int d)
SbVec3s operator* (const SbVec3s &v, double d)
SbVec3s operator* (int d, const SbVec3s &v)
SbVec3s operator* (double d, const SbVec3s &v)
SbVec3s operator/ (const SbVec3s &v, int d)
SbVec3s operator/ (const SbVec3s &v, double d)
SbVec3s operator+ (const SbVec3s &v1, const SbVec3s &v2)
SbVec3s operator- (const SbVec3s &v1, const SbVec3s &v2)
int operator== (const SbVec3s &v1, const SbVec3s &v2)
int operator!= (const SbVec3s &v1, const SbVec3s &v2)
Detailed Description
The SbVec3s 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.
Be aware that this class is an extension for Coin, and it is not
available in the original SGI Open Inventor v2.1 API.
See also:
SbVec2s, SbVec2f, SbVec2d, SbVec3f, SbVec3d, SbVec4f, SbVec4d.
Since:
Coin 2.0
TGS Inventor ?.?
Constructor & Destructor Documentation
SbVec3s::SbVec3s (void) [inline] The default constructor does nothing. The
vector coordinates will be uninitialized until you do a setValue()
call.
SbVec3s::SbVec3s (const short v[3]) [inline] Constructs an SbVec3s instance
with initial values from v.
SbVec3s::SbVec3s (short x, short y, short z) [inline] Constructs an SbVec3s
instance with the initial vector endpoint set to <x,y,z>.
SbVec3s::SbVec3s (const SbVec3us & v) [inline, explicit] Since:
Coin 2.5
SbVec3s::SbVec3s (const SbVec3b & v) [inline, explicit] Since:
Coin 2.5
SbVec3s::SbVec3s (const SbVec3i32 & v) [inline, explicit] Since:
Coin 2.5
SbVec3s::SbVec3s (const SbVec3f & v) [inline, explicit] Since:
Coin 2.5
SbVec3s::SbVec3s (const SbVec3d & v) [inline, explicit] Since:
Coin 2.5
Member Function Documentation
SbVec3s & SbVec3s::setValue (const short v[3]) [inline] Set new coordinates
for the vector from v. Returns reference to self.
See also:
getValue().
SbVec3s & SbVec3s::setValue (const SbVec3us & v) SbVec3s &
SbVec3s::setValue(short x, short y, short z)
Set new coordinates for the vector. Returns reference to self.
See also:
getValue().
Sets the value from an SbVec3us instance.
Since:
Coin 2.5
SbVec3s & SbVec3s::setValue (const SbVec3b & v) Sets the value from an
SbVec3b instance.
Since:
Coin 2.5
SbVec3s & SbVec3s::setValue (const SbVec3i32 & v) Sets the value from an
SbVec3i32 instance.
Since:
Coin 2.5
SbVec3s & SbVec3s::setValue (const SbVec3f & v) Sets the value from an
SbVec3f instance.
Since:
Coin 2.5
SbVec3s & SbVec3s::setValue (const SbVec3d & v) Sets the value from an
SbVec3d instance.
Since:
Coin 2.5
const short * SbVec3s::getValue (void) const [inline] Returns a pointer to
an array of three shorts containing the x, y and z coordinates of the
vector.
See also:
setValue().
void SbVec3s::getValue (short & x, short & y, short & z) const [inline]
Returns the x, y and z coordinates of the vector.
See also:
setValue().
short & SbVec3s::operator[] (int i) [inline] Index operator. Returns
modifiable x, y or z coordinate of vector.
See also:
getValue() and setValue().
short SbVec3s::operator[] (int i) const [inline] Index operator. Returns x,
y or z coordinate of vector.
See also:
getValue() and setValue().
int32_t SbVec3s::dot (const SbVec3s & v) const [inline] Calculates and
returns the result of taking the dot product of this vector and v.
void SbVec3s::negate (void) [inline] Negate the vector (i.e. point it in
the opposite direction).
SbVec3s & SbVec3s::operator*= (int d) [inline] Multiply components of
vector with value d. Returns reference to self.
SbVec3s & SbVec3s::operator*= (double d) Multiply components of vector with
value d. Returns reference to self.
SbVec3s & SbVec3s::operator/= (int d) [inline] Divides components of vector
with value d. Returns reference to self.
SbVec3s & SbVec3s::operator/= (double d) [inline] Divides components of
vector with value d. Returns reference to self.
SbVec3s & SbVec3s::operator+= (const SbVec3s & v) [inline] Adds this vector
and vector v. Returns reference to self.
SbVec3s & SbVec3s::operator-= (const SbVec3s & v) [inline] Subtracts vector
v from this vector. Returns reference to self.
SbVec3s SbVec3s::operator- (void) const [inline] Non-destructive negation
operator. Returns a new SbVec3s instance which points in the opposite
direction of this vector.
See also:
negate().
void SbVec3s::print (FILE * fp) const Dump the state of this object to the
file stream. Only works in debug version of library, method does
nothing in an optimized compile.
Friends And Related Function Documentation
SbVec3s operator* (const SbVec3s & v, int d) [related] Returns an SbVec3s
instance which is the components of vector v multiplied with d.
SbVec3s operator* (const SbVec3s & v, double d) [related] Returns an
SbVec3s instance which is the components of vector v multiplied with d.
SbVec3s operator* (int d, const SbVec3s & v) [related] Returns an SbVec3s
instance which is the components of vector v multiplied with d.
SbVec3s operator* (double d, const SbVec3s & v) [related] Returns an
SbVec3s instance which is the components of vector v multiplied with d.
SbVec3s operator/ (const SbVec3s & v, int d) [related] Returns an SbVec3s
instance which is the components of vector v divided on the scalar
factor d.
SbVec3s operator/ (const SbVec3s & v, double d) [related] Returns an
SbVec3s instance which is the components of vector v divided on d.
SbVec3s operator+ (const SbVec3s & v1, const SbVec3s & v2) [related]
Returns an SbVec3s instance which is the sum of vectors v1 and v2.
SbVec3s operator- (const SbVec3s & v1, const SbVec3s & v2) [related]
Returns an SbVec3s instance which is vector v2 subtracted from vector
v1.
int operator== (const SbVec3s & v1, const SbVec3s & v2) [related] Returns 1
if v1 and v2 are exactly equal, 0 otherwise.
int operator!= (const SbVec3s & v1, const SbVec3s & v2) [related] Returns 1
if v1 and v2 are not equal, 0 if they are equal.
Author
Generated automatically by Doxygen for Coin from the source code.