SoMFEngine(3)

NAME
SoMFEngine - The SoMFEngine class is a container for engines.

SYNOPSIS

#include <Inventor/fields/SoMFEngine.h>

Inherits SoMField.

  Public Member Functions
virtual SoType getTypeId (void) const
virtual void copyFrom (const SoField &field)
const SoMFEngine & operator= (const SoMFEngine &field)
virtual SbBool isSame (const SoField &field) const
SoEngine * operator[] (const int idx) const
const SoEngine ** getValues (const int start) const
int find (SoEngine *value, SbBool addifnotfound=FALSE)
void setValues (const int start, const int num, const SoEngine **newvals)
void set1Value (const int idx, SoEngine *value)
void setValue (SoEngine *value)
SoEngine * operator= (SoEngine *val)
SbBool operator== (const SoMFEngine &field) const
SbBool operator!= (const SoMFEngine &field) const
SoEngine ** startEditing (void)
void finishEditing (void)
virtual void fixCopy (SbBool copyconnections)
virtual SbBool referencesCopy (void) const
virtual void deleteValues (int start, int num=-1)
virtual void insertSpace (int start, int num)

  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
SoEngine ** values

  Additional Inherited Members

Detailed Description

The SoMFEngine class is a container for engines. This field container stores an array of pointers to engines. It takes care of the necessary functionality for handling copy, import and export operations.

Note that engine pointers stored in field instances of this type may be NULL pointers.

See also
    SoEngine, SoSFEngine

Member Function Documentation

  void * SoMFEngine::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 SoMFEngine::getClassTypeId (void) [static]
This static method returns the SoType object associated with objects of this class.

  SoType SoMFEngine::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 SoMFEngine::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 SoMFEngine::isSame (const SoField & f) const [virtual]
Check for equal type and value(s).

Implements SoField.

  virtual void SoMFEngine::deleteAllValues (void) [protected], [virtual]

Implements SoMField.

  virtual void SoMFEngine::copyValue (int to, int from) [protected], [virtual]

Implements SoMField.

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

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

  void SoMFEngine::fixCopy (SbBool copyconnections) [virtual]
This method is internally called after SoField::copyFrom() during scene graph copies, and should do the operations necessary for fixing up the field instance after it has gotten a new value.

The default method in the SoField superclass does nothing.

The application programmer should normally not need to consider this method, unless he constructs a complex field type which contains new references to container instances (i.e. nodes or engines). Overriding this method is then necessary to update the reference pointers, as they could have been duplicated during the copy operation.

Reimplemented from SoField.

  SbBool SoMFEngine::referencesCopy (void) const [virtual]
Returns TRUE if this field has references to any containers in the scene graph which are also duplicated during the copy operation.

Note that this method only is valid to call during copy operations.

See also the note about the relevance of the fixCopy() method for application programmers, as it is applicable on this method as well.

Reimplemented from SoField.

  virtual void SoMFEngine::deleteValues (int start, int numarg = -1) [virtual]
Remove value elements from index start up to and including index start + num - 1.

Elements with indices larger than the last deleted element will be moved downwards in the value array.

If num equals -1, delete from index start and to the end of the array.

Reimplemented from SoMField.

  virtual void SoMFEngine::insertSpace (int start, int numarg) [virtual]
Insert num 'slots' for new value elements from start. The elements already present from start will be moved 'upward' in the extended array.

Reimplemented from SoMField.

Author

Generated automatically by Doxygen for Coin from the source code.