other versions
- wheezy-backports 3.1.4~abc9f50-3~bpo70+1
- jessie 3.1.4~abc9f50-7
SoGate(3) | Coin | SoGate(3) |
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¶
virtual SoType getTypeId (void) const
Static Public Member Functions¶
static SoType getClassTypeId (void)
Public Attributes¶
SoSFBool enable
Protected Member Functions¶
virtual void inputChanged (SoField *which)
Static Protected Member Functions¶
static const SoFieldData ** getInputDataPtr (void)
Additional Inherited Members¶
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.Gate { type <multivaluefieldtype> [...fields...] }
Constructor & Destructor Documentation¶
SoGate::SoGate (SoTypetype)¶
Constructor. The type of the input/output is specified in type.Member Function Documentation¶
virtual 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 } }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.
static const SoFieldData** SoGate::getInputDataPtr (void) [static], [protected]¶
Returns the SoFieldData class which holds information about inputs in this engine. Reimplemented from SoEngine.static const SoEngineOutputData** SoGate::getOutputDataPtr (void) [static], [protected]¶
Returns the SoEngineOutputData class which holds information about the outputs in this engine. Reimplemented from SoEngine.virtual 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.virtual 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::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 Right Thing when a specific field is changed. Reimplemented from SoEngine.Member Data Documentation¶
SoSFBool SoGate::enable¶
Set whether or not to forward from input to output field.SoSFTrigger SoGate::trigger¶
Copy the current values of the input field once to the output field.SoMField * SoGate::input¶
The 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. The type of the field will of course match the type of the input field.Author¶
Generated automatically by Doxygen for Coin from the source code.Sat Oct 12 2013 | Version 4.0.0a |