trusty (3) SoFieldConverter.3.gz

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
           Returns the type identification of an object derived from a class inheriting SoBase. This is used for
           run-time type checking and 'downward' casting.
       virtual const SoFieldData * getFieldData (void) const
       virtual const SoEngineOutputData * getOutputData (void) const
       virtual SoField * getInput (SoType type)=0
       virtual SoEngineOutput * getOutput (SoType type)=0
       virtual SoField * getConnectedInput (void)
       int getForwardConnections (SoFieldList &l) const

   Static Public Member Functions
       static SoType getClassTypeId (void)
       static void initClass (void)
       static void initClasses (void)

   Protected Member Functions
       SoFieldConverter (void)
       virtual ~SoFieldConverter (void)

   Static Protected Member Functions
       static const SoFieldData ** getInputDataPtr (void)
       static const SoEngineOutputData ** getOutputDataPtr (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.

       If a value type conversion is possible (like between an SoSFFloat field and an SoSFInt32 field, for
       instance, where we could do a simple typecast for converting the value of one to the other), an
       SoFieldConverter derived object is inserted.

       This class is the abstract base superclass which all such field converters needs to inherit.

       Coin comes with one built-in field converter class which takes care of all possible field-to-field
       conversions we know about. This means applications programmers should seldom need to care about this
       class, it will probably only be useful if you expand the Coin library with your own field type classes.
       (Doing so is considered advanced use of the library.)

       See Also:
           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::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.

   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.