Open Inventor Reference
SoEngineOutputData Class Reference

The SoEngineOutputData class holds data about engine outputs: the number of outputs the engine has, the names of the outputs. More...

#include <Inventor/engines/SoOutputData.h>

Public Member Functions

 SoEngineOutputData ()
 Default constructor.
 
 SoEngineOutputData (const SoEngineOutputData *)
 
 SoEngineOutputData (int numOutputs)
 Constructor that takes number of fields as a hint.
 
 ~SoEngineOutputData ()
 Destructor.
 
void addOutput (const SoEngine *defEngine, const char *outputName, const SoEngineOutput *output, SoType type)
 Adds an output to current data, given name of output, a pointer to field within the engine, and the type of output.
 
int getNumOutputs () const
 Returns number of outputs.
 
const SbName & getOutputName (int index) const
 Returns name of output with given index.
 
SoEngineOutput * getOutput (const SoEngine *engine, int index) const
 Returns pointer to output with given index within given object instance.
 
int getIndex (const SoEngine *engine, const SoEngineOutput *output) const
 Returns index of output, given the output and the engine it is in.
 
const SoType & getType (int index) const
 Returns type of output with given index.
 
bool readDescriptions (SoInput *in, SoEngine *engine) const
 Methods to read and write the output descriptions.
 
void writeDescriptions (SoOutput *out, SoEngine *engine) const
 

Detailed Description

All engines of a given class share the same output data. Therefore, to get information about a particular output in a particular engine instance, it is necessary to pass that instance to the appropriate method.

Definition at line 86 of file SoOutputData.h.

Constructor & Destructor Documentation

◆ SoEngineOutputData() [1/3]

SoEngineOutputData::SoEngineOutputData ( )
inline

Definition at line 89 of file SoOutputData.h.

◆ SoEngineOutputData() [2/3]

SoEngineOutputData::SoEngineOutputData ( const SoEngineOutputData *  )

◆ SoEngineOutputData() [3/3]

SoEngineOutputData::SoEngineOutputData ( int  numOutputs)
inline

Definition at line 94 of file SoOutputData.h.

◆ ~SoEngineOutputData()

SoEngineOutputData::~SoEngineOutputData ( )

Member Function Documentation

◆ addOutput()

void SoEngineOutputData::addOutput ( const SoEngine *  defEngine,
const char *  outputName,
const SoEngineOutput *  output,
SoType  type 
)

◆ getIndex()

int SoEngineOutputData::getIndex ( const SoEngine *  engine,
const SoEngineOutput *  output 
) const

◆ getNumOutputs()

int SoEngineOutputData::getNumOutputs ( ) const
inline

Definition at line 108 of file SoOutputData.h.

◆ getOutput()

SoEngineOutput * SoEngineOutputData::getOutput ( const SoEngine *  engine,
int  index 
) const

◆ getOutputName()

const SbName & SoEngineOutputData::getOutputName ( int  index) const

◆ getType()

const SoType & SoEngineOutputData::getType ( int  index) const

◆ readDescriptions()

bool SoEngineOutputData::readDescriptions ( SoInput *  in,
SoEngine *  engine 
) const

◆ writeDescriptions()

void SoEngineOutputData::writeDescriptions ( SoOutput *  out,
SoEngine *  engine 
) const

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