SoSFEngine Class Reference
[Fields]

Field containing an engine instance. More...

#include <Inventor/fields/SoSFEngine.h>

Inheritance diagram for SoSFEngine:
SoSField SoField SoTypedObject

List of all members.

Public Member Functions

virtual SoType getTypeId () const
const SoSFEngineoperator= (const SoSFEngine &f)
 SoSFEngine ()
virtual ~SoSFEngine ()
SoEnginegetValue () const
void setValue (SoEngine *newValue)
SoEngineoperator= (SoEngine *newValue)
int operator== (const SoSFEngine &f) const
int operator!= (const SoSFEngine &f) const
virtual size_t getValueSize () const

Static Public Member Functions

static SoType getClassTypeId ()

Detailed Description

Field containing an engine instance.

This field maintains an SoEngine instance , correctly maintaining its reference count.

SoSFEngines are written to file as the engine they are maintaining. For example:

     mySoSFEngineField ElapsedTime
    

is an SoSFEngine field named 'mySoSFEngineField', containing an SoElapsedTime engine. If the engine is used elsewhere, the regular DEF/USE instancing mechanism applies:

     anotherSoSFEngineField USE calculator
    

is an SoSFEngine field that refers to a engine named 'calculator' that was DEF'ed earlier in the scene.

SEE ALSO

SoField, SoSField, SoMFEngine, SoEngine


Constructor & Destructor Documentation

SoSFEngine::SoSFEngine (  ) 

Default constructor.

virtual SoSFEngine::~SoSFEngine (  )  [virtual]

Destructor.


Member Function Documentation

static SoType SoSFEngine::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoSField.

virtual SoType SoSFEngine::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Implements SoTypedObject.

SoEngine* SoSFEngine::getValue (  )  const [inline]

Returns this field's value.

virtual size_t SoSFEngine::getValueSize (  )  const [inline, virtual]

Get size of the value.

Reimplemented from SoField.

int SoSFEngine::operator!= ( const SoSFEngine f  )  const [inline]

Returns FALSE if otherField is of the same type and has the same value as this field.

Reimplemented from SoField.

SoEngine* SoSFEngine::operator= ( SoEngine newValue  )  [inline]

Sets this field to newValue.

const SoSFEngine& SoSFEngine::operator= ( const SoSFEngine f  ) 

Copy from another field of same type.

int SoSFEngine::operator== ( const SoSFEngine f  )  const

Returns TRUE if otherField is of the same type and has the same value as this field.

Reimplemented from SoField.

void SoSFEngine::setValue ( SoEngine newValue  ) 

Sets this field to newValue.


The documentation for this class was generated from the following file:

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/