SbVec2s(3IV)

NAME
     SbVec2s (SbV2s) - 2D vector class

INHERITS FROM
     SbVec2s

SYNOPSIS
     #include <Inventor_c/SbLinear.h>

     typedef SbVec2s     SbV2s

          Functions from class SbVec2s:

     int                 SbV2sIsEq(SbV2s *this, const SbVec2s *v1, const
                              SbVec2s *v2)
     int                 SbV2sIsNEq(SbV2s *this, const SbVec2s *v1, const
                              SbVec2s *v2)

          Macros from class SbVec2s:

     SbV2sDot(vec0 , vec1)
     SbV2sGetXY(short array[2], SbVec2s vec)
     SbV2sGetX_Y(short x, short y, SbVec2s vec)
     SbV2sNegate(SbVec2s vec)
     SbV2sSetXY(SbVec2s vec, short array[2])
     SbV2sSetX_Y(SbVec2s vec, short x, short y)
     SbV2sMultBy(SbVec2s vec, short scalar)
     SbV2sDivBy(SbVec2s vec, short scalar)
     SbV2sAdd(SbVec2s dest, SbVec2s src1, SbVec2s src2)
     SbV2sSub(SbVec2s dest, SbVec2s src1, SbVec2s src2)


DESCRIPTION
     2D vector class used to store 2D integer vectors and points. This class
     is used throughout Inventor for arguments and return values.  This object
     does not have Create or Delete functions because it is considered a
     simple datatype; instances of this class may be declared directly as
     local or global variables in C. C programmers can access the components
     of the vector as though it were a simple structure or use the access and
     operation functions described in this reference page:

          struct SbVec2s { short vec[2]; };

          SbVec2s   v1, v2;

          /* The next two lines produce equivalent vectors. */
          v1.vec[0] = 1; v1.vec[1] = 1;
          SbV2sSetX_Y( v2, 1, 1 );
FUNCTIONS
     int                 SbV2sIsEq(SbV2s *this, const SbVec2s *v1, const
                              SbVec2s *v2)
     int                 SbV2sIsNEq(SbV2s *this, const SbVec2s *v1, const
                              SbVec2s *v2)
          Equality comparison operators.


MACROS
     SbV2sDot(vec0 , vec1)
          Returns dot (inner) product of two vectors.

     SbV2sGetXY(short array[2], SbVec2s vec)
     SbV2sGetX_Y(short x, short y, SbVec2s vec)
          Returns vector components.

     SbV2sNegate(SbVec2s vec)
          Negates each component of vector in place.

     SbV2sSetXY(SbVec2s vec, short array[2])
     SbV2sSetX_Y(SbVec2s vec, short x, short y)
          Sets vector components.

     SbV2sMultBy(SbVec2s vec, short scalar)
     SbV2sDivBy(SbVec2s vec, short scalar)
          Component-wise scalar multiplication and division operators.

     SbV2sAdd(SbVec2s dest, SbVec2s src1, SbVec2s src2)
     SbV2sSub(SbVec2s dest, SbVec2s src1, SbVec2s src2)
          Component-wise binary vector addition and subtraction operators.


FILE FORMAT/DEFAULTS
     Vec2s {
     }

SEE ALSO
     SbVec3f, SbVec4f, SbVec2f