trusty (3) SoBlinker.3.gz

NAME

       SoBlinker -

       The SoBlinker class is a cycling switch node.

       This switch node cycles its children SoBlinker::speed number of times per second. If the node has only
       one child, it will be cycled on and off. Cycling can be turned off using the SoBlinker::on field, and the
       node then behaves like a normal SoSwitch node.

SYNOPSIS

       #include <Inventor/nodes/SoBlinker.h>

       Inherits SoSwitch.

   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.
       SoBlinker (void)
       virtual void getBoundingBox (SoGetBoundingBoxAction *action)
       virtual void write (SoWriteAction *action)

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

   Public Attributes
       SoSFFloat speed
       SoSFBool on

   Protected Member Functions
       virtual const SoFieldData * getFieldData (void) const
       virtual ~SoBlinker ()
       virtual void notify (SoNotList *nl)

   Static Protected Member Functions
       static const SoFieldData ** getFieldDataPtr (void)

   Additional Inherited Members

Detailed Description

       The SoBlinker class is a cycling switch node.

       This switch node cycles its children SoBlinker::speed number of times per second. If the node has only
       one child, it will be cycled on and off. Cycling can be turned off using the SoBlinker::on field, and the
       node then behaves like a normal SoSwitch node.

       FILE FORMAT/DEFAULTS:

       Blinker {
           whichChild -1
           speed 1
           on TRUE
       }

Constructor & Destructor Documentation

   SoBlinker::SoBlinker (void)
       Constructor.

   SoBlinker::~SoBlinker () [protected],  [virtual]
       Destructor.

Member Function Documentation

   SoType SoBlinker::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.

       Reimplemented from SoSwitch.

   const SoFieldData * SoBlinker::getFieldData (void) const [protected],  [virtual]
       Returns a pointer to the class-wide field data storage object for this instance. If no fields are
       present, returns NULL.

       Reimplemented from SoSwitch.

   void SoBlinker::getBoundingBox (SoGetBoundingBoxAction *action) [virtual]
       Action method for the SoGetBoundingBoxAction.

       Calculates bounding box and center coordinates for node and modifies the values of the action to
       encompass the bounding box for this node and to shift the center point for the scene more towards the one
       for this node.

       Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change
       the relevant state variables.

       Reimplemented from SoSwitch.

   void SoBlinker::write (SoWriteAction *action) [virtual]
       Action method for SoWriteAction.

       Writes out a node object, and any connected nodes, engines etc, if necessary.

       Reimplemented from SoSwitch.

   void SoBlinker::notify (SoNotList *l) [protected],  [virtual]
       Notifies all auditors for this instance when changes are made.

       Reimplemented from SoSwitch.

Member Data Documentation

   SoSFFloat SoBlinker::speed
       Number of cycles per second.

   SoSFBool SoBlinker::on
       Controls whether cycling is on or off.

Author

       Generated automatically by Doxygen for Coin from the source code.