debian man page for sosfengine

SoSFEngine(3)							       Coin							     SoSFEngine(3)

NAME
       SoSFEngine -

       The SoSFEngine class is a container for a single engine.

       This field container stores a pointer to a Coin engine. It takes care of the necessary functionality for handling copy, import and export
       operations.

SYNOPSIS
       #include <Inventor/fields/SoSFEngine.h>

       Inherits SoSField.

   Public Member Functions
       virtual SoType getTypeId (void) const
       virtual void copyFrom (const SoField &field)
       const SoSFEngine & operator= (const SoSFEngine &field)
       virtual SbBool isSame (const SoField &field) const
       SoEngine * getValue (void) const
       void setValue (SoEngine *newvalue)
       SoEngine * operator= (SoEngine *newvalue)
       int operator== (const SoSFEngine &field) const
       int operator!= (const SoSFEngine &field) const
       virtual void fixCopy (SbBool copyconnections)
       virtual SbBool referencesCopy (void) const

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

   Protected Attributes
       SoEngine * value

   Additional Inherited Members
Detailed Description
       The SoSFEngine class is a container for a single engine.

       This field container stores a pointer to a Coin engine. It takes care of the necessary functionality for handling copy, import and export
       operations.

       Note that the engine pointer stored in a field instance of this type may be a NULL pointer.

       See also:
	   SoEngine, SoMFEngine

Member Function Documentation
   SoType SoSFEngine::getClassTypeId (void) [static]
       Returns a unique type identifier for this field class.

       See also:
	   getTypeId(), SoType

       Reimplemented from SoSField.

   SoType SoSFEngine::getTypeId (void) const [virtual]
       Returns the type identification instance which uniquely identifies the Coin field class the object belongs to.

       See also:
	   getClassTypeId(), SoType

       Implements SoField.

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

       Implements SoField.

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

       Reimplemented from SoSField.

   void SoSFEngine::fixCopy (SbBoolcopyconnections) [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 SoSFEngine::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 aswell.

       Reimplemented from SoField.

Author
       Generated automatically by Doxygen for Coin from the source code.

Version 3.1.3							  Wed May 23 2012						     SoSFEngine(3)