Rechercher une page de manuel
SoGate.3coin2
Langue: en
Version: 379733 (fedora - 01/12/10)
Section: 3 (Bibliothèques de fonctions)
Sommaire
- NAME
- SYNOPSIS
- Detailed Description
- Constructor & Destructor Documentation
- Member Function Documentation
- void SoGate::initClass (void) [static]Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
- void SoGate::inputChanged (SoField * which) [protected, virtual]Called when an input is changed. The default method does nothing, but subclasses may override this method to do the The Right Thing when a specific field is changed.
- Member Data Documentation
- SoSFBool SoGate::enableSet whether or not to forward from input to output field.
- SoSFTrigger SoGate::triggerCopy the current values of the input field once to the output field.
- SoMField * SoGate::inputThe multivalue input field which we will forward to the output when SoGate::enable is TRUE.
- SoEngineOutput * SoGate::output(SoMField) This is the field output containing the values of SoGate::input.
- Author
NAME
SoGate -The SoGate class is used to selectively copy values from input to output.
This engine will forward values from the SoGate::input field to the SoGate::output field when the SoGate::enable field is TRUE.
SYNOPSIS
#include <Inventor/engines/SoGate.h>
Inherits SoEngine.
Public Member Functions
SoGate (SoType type)
Static Public Member Functions
static void initClass (void)
Public Attributes
SoSFBool enable
SoSFTrigger trigger
SoMField * input
SoEngineOutput * output
Protected Member Functions
virtual void inputChanged (SoField *which)
Friends
class dummy
Detailed Description
The SoGate class is used to selectively copy values from input to output.
This engine will forward values from the SoGate::input field to the SoGate::output field when the SoGate::enable field is TRUE.
Note that this engine's output field deviates a little from the 'standard' output mechanism of the majority of engine classes: the SoGate::output is not a permanent SoEngineOutput instance, but a pointer to a SoEngineOutput instance. The reason for this is that it is necessary to allocate the output field dynamically to make it match what the SoGate::input is connected to since the type of the SoGate::output always should be the same as the type of the SoGate::input.
The file format for this field is a bit special. Note the leading type specification, which is not necessary for most other field types:
Gate { type <multivaluefieldtype> [...fields...] } .fi
Constructor & Destructor Documentation
SoGate::SoGate (SoType type)Constructor. The type of the input/output is specified in type.
References SoType::badType(), SoType::getName(), SbName::getString(), input, output, SoDebugError::post(), and SoGate().
Referenced by SoGate().
Member Function Documentation
void SoGate::initClass (void) [static]Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
Reimplemented from SoEngine.
void SoGate::inputChanged (SoField * which) [protected, virtual]Called when an input is changed. The default method does nothing, but subclasses may override this method to do the The Right Thing when a specific field is changed.
Reimplemented from SoEngine.
References SoEngineOutput::enable(), enable, SoEngineOutput::isEnabled(), output, and trigger.
Member Data Documentation
SoSFBool SoGate::enableSet whether or not to forward from input to output field.
Referenced by inputChanged().
SoSFTrigger SoGate::triggerCopy the current values of the input field once to the output field.
Referenced by inputChanged().
SoMField * SoGate::inputThe multivalue input field which we will forward to the output when SoGate::enable is TRUE.
Referenced by SoGate().
SoEngineOutput * SoGate::output(SoMField) This is the field output containing the values of SoGate::input.
The type of the field will of course match the type of the input field.
Referenced by inputChanged(), and SoGate().
Author
Generated automatically by Doxygen for Coin from the source code.
Contenus ©2006-2024 Benjamin Poulain
Design ©2006-2024 Maxime Vantorre