other versions
- wheezy-backports 3.1.4~abc9f50-3~bpo70+1
- jessie 3.1.4~abc9f50-7
SoFieldConverter(3) | Coin | SoFieldConverter(3) |
NAME¶
SoFieldConverter - The SoFieldConverter class is the abstract base class for field converters. When fields of different types are attempted connected, the Coin library tries to find a field converter class which can be inserted between them, acting as a filter converting values from the master field to values matching the type of the slave field.SYNOPSIS¶
#include <Inventor/engines/SoFieldConverter.h> Inherits SoEngine.Public Member Functions¶
virtual SoType getTypeId (void) const
Static Public Member Functions¶
static SoType getClassTypeId (void)
Protected Member Functions¶
SoFieldConverter (void)
Static Protected Member Functions¶
static const SoFieldData ** getInputDataPtr (void)
Additional Inherited Members¶
Detailed Description¶
The SoFieldConverter class is the abstract base class for field converters. When fields of different types are attempted connected, the Coin library tries to find a field converter class which can be inserted between them, acting as a filter converting values from the master field to values matching the type of the slave field.SoDB::addConverter()
Constructor & Destructor Documentation¶
SoFieldConverter::SoFieldConverter (void) [protected]¶
Default constructor.SoFieldConverter::~SoFieldConverter (void) [protected], [virtual]¶
Default destructor.Member Function Documentation¶
SoType SoFieldConverter::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.
const SoFieldData ** SoFieldConverter::getInputDataPtr (void) [static], [protected]¶
Returns the SoFieldData class which holds information about inputs in this engine. Reimplemented from SoEngine.const SoEngineOutputData ** SoFieldConverter::getOutputDataPtr (void) [static], [protected]¶
Returns the SoEngineOutputData class which holds information about the outputs in this engine. Reimplemented from SoEngine.const SoFieldData * SoFieldConverter::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 * SoFieldConverter::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 SoFieldConverter::initClasses (void) [static]¶
Initializes all engines. Automatically called from SoEngine::initClass() upon initialization of Coin. Reimplemented from SoEngine.SoField * SoFieldConverter::getInput (SoTypetype) [pure virtual]¶
Returns input field for the converter engine. Must be overridden in non-abstract converter engine classes.SoEngineOutput * SoFieldConverter::getOutput (SoTypetype) [pure virtual]¶
Returns output for the converter engine. Must be overridden in non-abstract converter engine classes.SoField * SoFieldConverter::getConnectedInput (void) [virtual]¶
This method is obsoleted in Coin. It should probably have been private in OIV.int SoFieldConverter::getForwardConnections (SoFieldList &l) const¶
Returns fields which are connected as slaves of the engine output.Author¶
Generated automatically by Doxygen for Coin from the source code.Sat Oct 12 2013 | Version 4.0.0a |