SoMFVec3s(3)

NAME
SoMFVec3s - The SoMFVec3s class is a container for SbVec3s vectors.

SYNOPSIS

#include <Inventor/fields/SoMFVec3s.h>

Inherits SoMField.

  Public Member Functions
virtual SoType getTypeId (void) const
virtual void copyFrom (const SoField &field)
const SoMFVec3s & operator= (const SoMFVec3s &field)
virtual SbBool isSame (const SoField &field) const
const SbVec3s & operator[] (const int idx) const
const SbVec3s * getValues (const int start) const
int find (const SbVec3s &value, SbBool addifnotfound=FALSE)
void setValues (const int start, const int num, const SbVec3s *newvals)
void set1Value (const int idx, const SbVec3s &value)
void setValue (const SbVec3s &value)
const SbVec3s & operator= (const SbVec3s &val)
SbBool operator== (const SoMFVec3s &field) const
SbBool operator!= (const SoMFVec3s &field) const
SbVec3s * startEditing (void)
void finishEditing (void)
void setValuesPointer (const int num, const SbVec3s *userdata)
void setValuesPointer (const int num, SbVec3s *userdata)
void setValuesPointer (const int num, const short *userdata)
void setValuesPointer (const int num, short *userdata)
void setValues (int start, int num, const short xyz[][3])
void set1Value (int idx, short x, short y, short z)
void set1Value (int idx, const short xyz[3])
void setValue (short x, short y, short z)
void setValue (const short xyz[3])

  Static Public Member Functions
static void * createInstance (void)
static SoType getClassTypeId (void)
static void initClass (void)

  Protected Member Functions
virtual void deleteAllValues (void)
virtual void copyValue (int to, int from)
virtual int fieldSizeof (void) const
virtual void * valuesPtr (void)
virtual void setValuesPtr (void *ptr)
virtual void allocValues (int num)

  Protected Attributes
SbVec3s * values

  Additional Inherited Members

Detailed Description

The SoMFVec3s class is a container for SbVec3s vectors. This field is used where nodes, engines or other field containers need to store an array of vectors with three elements.

This field supports application data sharing through a setValuesPointer() method. See SoMField documentation for information on how to use this function.

See also
    SbVec3s, SoSFVec3s Be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since
    Coin 2.5

Member Function Documentation

  void * SoMFVec3s::createInstance (void) [static]
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
 Creates a new instance of the class type corresponding to the SoType object.

  SoType SoMFVec3s::getClassTypeId (void) [static]
This static method returns the SoType object associated with objects of this class.

  SoType SoMFVec3s::getTypeId (void) const [virtual]
Returns the type identification of an object derived from a class inheriting SoField. This is used for runtime type checking and 'downward' casting.

Implements SoField.

  void SoMFVec3s::copyFrom (const SoField & f) [virtual]
Copy value(s) from f into this field. f must be of the same type as this field.

Implements SoField.

  SbBool SoMFVec3s::isSame (const SoField & f) const [virtual]
Check for equal type and value(s).

Implements SoField.

  void SoMFVec3s::deleteAllValues (void) [protected], [virtual]
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Implements SoMField.

  void SoMFVec3s::copyValue (int to, int from) [protected], [virtual]
This method is used for moving values around internally within a multivalue field. It needs to be overridden in each field so it automatically takes care of running copy contructors where necessary.

Implements SoMField.

  const SbVec3s* SoMFVec3s::getValues (const int start) const [inline]
Returns a pointer to the values array.

  void SoMFVec3s::initClass (void) [static]
Internal method called upon initialization of the library (from SoDB::init()) to set up the type system.

  void SoMFVec3s::setValues (int start, int numarg, const short xyz[][3])
Set num vector array elements from the xyz array, reading from index 0 in the given float-triplet vector array and storing values from index start in this SoMFVec3f's array.

If start + num is larger than the current number of elements in the SoMFVec3f field, this method will automatically expand the field to accommodate all given float-vector element values.

  void SoMFVec3s::set1Value (int idx, short x, short y, short z)
Set the vector at idx.

  void SoMFVec3s::set1Value (int idx, const short xyz[3])
Set the vector at idx.

  void SoMFVec3s::setValue (short x, short y, short z)
Set this field to contain a single vector with the given element values.

  void SoMFVec3s::setValue (const short xyz[3])
Set this field to contain a single vector with the given element values.

Author

Generated automatically by Doxygen for Coin from the source code.