SoBlinker(3IV)

NAME
     SoBlinker (SoBlinker) - animated cycling switch node

INHERITS FROM
     SoBase > SoFieldContainer > SoNode > SoGroup > SoSwitch > SoBlinker

SYNOPSIS
     #include <Inventor_c/nodes/SoBlinker.h>

          Fields from class SoBlinker:

     SoSFFloat           speed
     SoSFBool            on

          Fields from class SoSwitch:

     SoSFInt32           whichChild

          Functions from class SoBlinker:

     SoBlinker *         SoBlinkerCreate()
     SoType              SoBlinkerGetClassTypeId()

          Functions from class SoGroup:

     void                SoBlinkerAddChild(SoBlinker *this, SoNode *child)
     void                SoBlinkerInsertChild(SoBlinker *this, SoNode *child,
                              int newChildIndex)
     SoNode *            SoBlinkerGetChild(const SoBlinker *this, int index)
     int                 SoBlinkerFindChild(const SoBlinker *this, const
                              SoNode *child)
     int                 SoBlinkerGetNumChildren(const SoBlinker *this)
     void                SoBlinkerRemoveChild(SoBlinker *this, int index)
     void                SoBlinkerRemoveChildNode(SoBlinker *this, SoNode
                              *child)
     void                SoBlinkerRemoveAllChildren(SoBlinker *this)
     void                SoBlinkerReplaceChild(SoBlinker *this, int index,
                              SoNode *newChild)
     void                SoBlinkerReplaceChildNode(SoBlinker *this, SoNode
                              *oldChild, SoNode *newChild)

          Functions from class SoNode:

     void                SoBlinkerSetOverride(SoBlinker *this, SbBool state)
     SbBool              SoBlinkerIsOverride(const SoBlinker *this)
     SoNode *            SoBlinkerCopy(const SoBlinker *this, SbBool
                              copyConnections = FALSE)
     SbBool              SoBlinkerAffectsState(const SoBlinker *this)
     SoNode *            SoBlinkerGetByName(const char *name)
     int                 SoBlinkerGetByNameList(const char *name, SoNodeList
                              *list)
          Functions from class SoFieldContainer:

     void                SoBlinkerSetToDflts(SoBlinker *this)
     SbBool              SoBlinkerHasDfltVals(const SoBlinker *this)
     SbBool              SoBlinkerFldsAreEq(const SoBlinker *this, const
                              SoFieldContainer *fc)
     void                SoBlinkerCopyFieldVals(SoBlinker *this, const
                              SoFieldContainer *fc, SbBool copyConnections =
                              FALSE)
     SbBool              SoBlinkerSet(SoBlinker *this, const char
                              *fieldDataString)
     void                SoBlinkerGet(SoBlinker *this, SbString
                              *fieldDataString)
     int                 SoBlinkerGetFields(const SoBlinker *this, SoFieldList
                              *resultList)
     SoField *           SoBlinkerGetField(const SoBlinker *this, const char
                              *fieldName)
     SbBool              SoBlinkerGetFieldName(const SoBlinker *this, const
                              SoField *field, SbName *fieldName)
     SbBool              SoBlinkerIsNotifyEnabled(const SoBlinker *this)
     SbBool              SoBlinkerEnableNotify(SoBlinker *this, SbBool flag)

          Functions from class SoBase:

     void                SoBlinkerRef(SoBlinker *this)
     void                SoBlinkerUnref(const SoBlinker *this)
     void                SoBlinkerUnrefNoDelete(const SoBlinker *this)
     void                SoBlinkerTouch(SoBlinker *this)
     SoType              SoBlinkerGetTypeId(const SoBlinker *this)
     SbBool              SoBlinkerIsOfType(const SoBlinker *this, SoType type)
     void                SoBlinkerSetName(SoBlinker *this, const char *name)
     SbName              SoBlinkerGetName(const SoBlinker *this)


DESCRIPTION
     The SoBlinker class is derived from SoSwitch, so it selects one of its
     children to traverse. Using engines connected to the realTime global
     field, the whichChild field is animated over time. If the node has only
     one child, whichChild toggles between SO_SWITCH_NONE and 0, causing the
     child to be switched on and off repeatedly. If the node has more than one
     child, they are cycled through continuously.

FIELDS
     SoSFFloat           speed
          Defines the speed of the blinker, in cycles per second.

     SoSFBool            on
          Allows applications to enable or disable the blinking easily.

FUNCTIONS
     SoBlinker *         SoBlinkerCreate()
          Creates a blinker node with default settings.

     SoType              SoBlinkerGetClassTypeId()
          Returns type identifier for this class.


ACTION BEHAVIOR
     SoGLRenderAction, SoCallbackAction, SoGetBoundingBoxAction,
     SoGetMatrixAction, SoHandleEventAction, SoRayPickAction, SoSearchAction
          Same as for SoSwitch.


FILE FORMAT/DEFAULTS
     Blinker {
          whichChild  -1
          speed       1
          on          TRUE
     }