#include <Inventor/engines/SoEngine.h>
Public Member Functions | |
SoEngineOutput (void) | |
virtual | ~SoEngineOutput () |
SoType | getConnectionType (void) const |
int | getForwardConnections (SoFieldList &fl) const |
void | enable (const SbBool flag) |
SbBool | isEnabled (void) const |
class SoEngine * | getContainer (void) const |
void | setContainer (SoEngine *engine) |
void | addConnection (SoField *f) |
void | removeConnection (SoField *f) |
int | getNumConnections (void) const |
SoField * | operator[] (int i) const |
void | prepareToWrite (void) const |
void | doneWriting (void) const |
void | touchSlaves (SoNotList *nl, SbBool donotify) |
SoEngineOutput has methods for convenient handling of the connections made from SoEngine objects to SoField objects.
SoEngineOutput::SoEngineOutput | ( | void | ) |
Constructor. The SoEngineOutput will initially not be contained within an SoEngine nor will it have any slave fields attached.
SoEngineOutput::~SoEngineOutput | ( | ) | [virtual] |
Destructor.
SoType SoEngineOutput::getConnectionType | ( | void | ) | const |
Returns the type of the engine output.
int SoEngineOutput::getForwardConnections | ( | SoFieldList & | fl | ) | const |
Adds all slave fields connected to this output to fl. Returns the number of slaves.
void SoEngineOutput::enable | ( | const SbBool | flag | ) |
Sets the enabled flag. If output is disabled, the fields connected to this output will not be changed when the engine is evaluated.
SbBool SoEngineOutput::isEnabled | ( | void | ) | const |
SoEngine * SoEngineOutput::getContainer | ( | void | ) | const |
void SoEngineOutput::setContainer | ( | SoEngine * | engine | ) |
void SoEngineOutput::addConnection | ( | SoField * | f | ) |
Adds f to the list of connections from this output.
Adds 1 to the reference count of the container engine.
void SoEngineOutput::removeConnection | ( | SoField * | f | ) |
Removes f from the list of connections from this output.
Subtracts 1 from the reference count of the container engine. If the reference count reaches zero (which will happen if this was the last connection and the application programmer did not explicitly ref the engine), the container engine will be deallocated.
int SoEngineOutput::getNumConnections | ( | void | ) | const |
SoField * SoEngineOutput::operator[] | ( | int | i | ) | const |
void SoEngineOutput::prepareToWrite | ( | void | ) | const |
Disables notifications on fields connected to this output. This is done before the engine is evaulated, since the fields we are going to write into have already been notified.
void SoEngineOutput::doneWriting | ( | void | ) | const |
Restores the notification flags on fields connected to this output after evaluating.
void SoEngineOutput::touchSlaves | ( | SoNotList * | nl, | |
SbBool | donotify | |||
) |
Notify the fields attached to this engine output that the output value has changed.
If donotify is TRUE
, propagate the notification to the fields. Otherwise just mark the fields "dirty" for re-evalution.
Note that this method is not part of the original Open Inventor API.