SoEngineOutput Class Reference

Class for all engine outputs. More...

#include <Inventor/engines/SoEngine.h>

Public Member Functions
SoType	getConnectionType () const
	Returns the type of field this output can connect to.
int	getForwardConnections (SoFieldList &list) const
	Returns the number of fields this output is writing to, and adds pointers to those fields to the given list.
void	enable (bool flag)
	Enables or disables all connections from this ouptut.
bool	isEnabled () const
	Returns TRUE if this output is currently enabled.
SoEngine *	getContainer () const
	Returns containing engine.
	SoEngineOutput ()
virtual	~SoEngineOutput ()
void	setContainer (SoEngine *eng)
void	addConnection (SoField *)
	Adds/removes connection to field.
void	removeConnection (SoField *)
int	getNumConnections () const
	Number of connections this output currently has.
SoField *	operator[] (int i) const
	Returns the fields this output is writing into.
void	prepareToWrite () const
	Before evaluating (which is done with the regular field API), we must disable notification on all the fields we're about to write into.
void	doneWriting () const

Detailed Description

SoEngineOuput is the class for all engine output fields. There is no public constructor routine for this class.
Only the engine classes create instances of SoEngineOutput

Each engine creates one or more engine outputs. The type of the output is documented in the engine reference pages. There is also an SoEngineOutput method for querying the connection type.

The application can at any time enable or disable the engine outputs. By default the engine outputs are enabled.

See Also

SoEngine

Definition at line 228 of file SoEngine.h.

Constructor & Destructor Documentation

SoEngineOutput()

SoEngineOutput::SoEngineOutput

(

)

~SoEngineOutput()

virtual SoEngineOutput::~SoEngineOutput ( )

virtual

Member Function Documentation

addConnection()

void SoEngineOutput::addConnection

(

SoField *

)

doneWriting()

void SoEngineOutput::doneWriting

(

)

const

enable()

void SoEngineOutput::enable

(

bool

flag

)

If the connections are disabled, values will not be output along them.
By default, outputs are enabled.

getConnectionType()

SoType SoEngineOutput::getConnectionType

(

)

const

getContainer()

SoEngine * SoEngineOutput::getContainer ( ) const

inline

Definition at line 247 of file SoEngine.h.

getForwardConnections()

int SoEngineOutput::getForwardConnections

(

SoFieldList &

list

)

const

getNumConnections()

int SoEngineOutput::getNumConnections ( ) const

inline

Definition at line 261 of file SoEngine.h.

isEnabled()

bool SoEngineOutput::isEnabled ( ) const

inline

Definition at line 244 of file SoEngine.h.

operator[]()

SoField * SoEngineOutput::operator[] ( int  i ) const

inline

Definition at line 265 of file SoEngine.h.

References SoField::get().

prepareToWrite()

void SoEngineOutput::prepareToWrite

(

)

const

After evaluating, the bits are restored:

removeConnection()

void SoEngineOutput::removeConnection

(

SoField *

)

setContainer()

void SoEngineOutput::setContainer ( SoEngine *  eng )

inline

Definition at line 254 of file SoEngine.h.

---

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

• C:/jh/mevislab/4.0.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/engines/SoEngine.h