Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
SoEngineOutput Class Reference

Class for all engine outputs. More...

#include <Inventor/engines/SoEngine.h>

+ Inheritance diagram for SoEngineOutput:

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 references to those fields to the given list.
 
void enable (SbBool flag)
 Enables or disables all connections from this output.
 
SbBool isEnabled () const
 Returns TRUE if this output is currently enabled.
 
SoEnginegetContainer () const
 Returns containing engine.
 
int getNumConnections () const
 Number of connections this output currently has.
 

Detailed Description

Class for all engine outputs.

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 282 of file SoEngine.h.

Member Function Documentation

◆ enable()

void SoEngineOutput::enable ( SbBool  flag)

Enables or disables all connections from this output.

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

◆ getConnectionType()

SoType SoEngineOutput::getConnectionType ( ) const

Returns the type of field this output can connect to.

◆ getContainer()

SoEngine * SoEngineOutput::getContainer ( ) const
inline

Returns containing engine.

Definition at line 309 of file SoEngine.h.

◆ getForwardConnections()

int SoEngineOutput::getForwardConnections ( SoFieldList list) const

Returns the number of fields this output is writing to, and adds references to those fields to the given list.

◆ getNumConnections()

int SoEngineOutput::getNumConnections ( ) const
inline

Number of connections this output currently has.

Definition at line 312 of file SoEngine.h.

◆ isEnabled()

SbBool SoEngineOutput::isEnabled ( ) const
inline

Returns TRUE if this output is currently enabled.

Definition at line 304 of file SoEngine.h.


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