sogate(3)
NAME
SoGate
SYNOPSIS
#include <Inventor/engines/SoGate.h> Inherits SoEngine.
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 - Public Member Functions
- virtual SoType getTypeId (void) const
virtual const SoFieldData * getFieldData (void) const virtual const SoEngineOutputData * getOutputData (void) const SoGate (SoType type) - Static Public Member Functions
- static SoType getClassTypeId (void)
static void * createInstance (void)
static void initClass (void) - Public Attributes
- SoSFBool enable
SoSFTrigger trigger
SoMField * input
SoEngineOutput * output - Protected Member Functions
- virtual void inputChanged (SoField *which)
- Static Protected Member Functions
- static const SoFieldData ** getInputDataPtr (void) static const SoEngineOutputData ** getOutputDataPtr (void)
- Friends
- class dummy
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 getTypeId(), and SoGate().
Member Function Documentation
- SoType SoGate::getClassTypeId (void) [static]
- This static method returns the SoType object associated with objects of this class.
- Reimplemented from SoEngine.
- SoType SoGate::getTypeId (void) const [virtual]
- Returns the type identification of an object derived from a class
inheriting SoBase. This is used for run-time type checking and 'downward' casting. - Usage example:
void foo(SoNode * node)
{if (node->getTypeId() == SoFile::getClassTypeId()) {SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type}
else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {SoGroup * group = (SoGroup *)node; // safe downward cast, knows the type}} - For application programmers wanting to extend the library with new
nodes, engines, nodekits, draggers or others: this method needs to be
overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually
accomplished by using the pre-defined macros available through for
instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and
SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. - For more information on writing Coin extensions, see the class
documentation of the toplevel superclasses for the various class
groups. - Implements SoBase.
- References SoGate().
- const SoFieldData ** SoGate::getInputDataPtr (void) [static, protected]
- Returns the SoFieldData class which holds information about inputs in this engine.
- Reimplemented from SoEngine.
- const SoEngineOutputData ** SoGate::getOutputDataPtr (void) [static,
- protected]
Returns the SoEngineOutputData class which holds information about the outputs in this engine. - Reimplemented from SoEngine.
- const SoFieldData * SoGate::getFieldData (void) const [virtual]
- Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.
- Reimplemented from SoFieldContainer.
- const SoEngineOutputData * SoGate::getOutputData (void) const [virtual]
- This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
- Implements SoEngine.
- 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.
- Referenced by SoEngine::initClasses().
- 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, SoSFBool::getValue(),
SoEngineOutput::isEnabled(), output, and trigger.
Member Data Documentation
- SoSFBool SoGate::enable
- Set whether or not to forward from input to output field.
- Referenced by inputChanged().
- SoSFTrigger SoGate::trigger
- Copy the current values of the input field once to the output field.
- Referenced by inputChanged().
- SoMField * SoGate::input
- The 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.