trusty (3) SoBumpMapTransform.3.gz

NAME

       SoBumpMapTransform -

       The SoBumpMapTransform class is used to define 2D bump map transformations.

       Bump maps applied to shapes in the scene can be transformed by 'prefixing' in the state with instances of
       this node type. Translations, rotations and scaling in 2D can all be done.

SYNOPSIS

       #include <Inventor/nodes/SoBumpMapTransform.h>

       Inherits SoNode.

   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.
       SoBumpMapTransform (void)
       virtual void doAction (SoAction *action)
       virtual void callback (SoCallbackAction *action)
       virtual void GLRender (SoGLRenderAction *action)
       virtual void getMatrix (SoGetMatrixAction *action)
       virtual void pick (SoPickAction *action)

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

   Public Attributes
       SoSFVec2f translation
       SoSFFloat rotation
       SoSFVec2f scaleFactor
       SoSFVec2f center

   Protected Member Functions
       virtual const SoFieldData * getFieldData (void) const
       virtual ~SoBumpMapTransform ()

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

   Additional Inherited Members

Detailed Description

       The SoBumpMapTransform class is used to define 2D bump map transformations.

       Bump maps applied to shapes in the scene can be transformed by 'prefixing' in the state with instances of
       this node type. Translations, rotations and scaling in 2D can all be done.

       The default settings of this node's fields equals a 'null transform', ie no transformation.

       FILE FORMAT/DEFAULTS:

       BumpMapTransform {
           translation 0 0
           rotation 0
           scaleFactor 1 1
           center 0 0
       }

       Since:
           Coin 2.2

Constructor & Destructor Documentation

   SoBumpMapTransform::SoBumpMapTransform (void)
       Constructor.

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

Member Function Documentation

   SoType SoBumpMapTransform::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 * SoBumpMapTransform::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 SoFieldContainer.

   void SoBumpMapTransform::doAction (SoAction *action) [virtual]
       This function performs the typical operation of a node for any action.

       Reimplemented from SoNode.

   void SoBumpMapTransform::callback (SoCallbackAction *action) [virtual]
       Action method for SoCallbackAction.

       Simply updates the state according to how the node behaves for the render action, so the application
       programmer can use the SoCallbackAction for extracting information about the scene graph.

       Reimplemented from SoNode.

   void SoBumpMapTransform::GLRender (SoGLRenderAction *action) [virtual]
       Action method for the SoGLRenderAction.

       This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants
       to throw geometry primitives at OpenGL overrides this method.

       Reimplemented from SoNode.

   void SoBumpMapTransform::getMatrix (SoGetMatrixAction *action) [virtual]
       Action method for SoGetMatrixAction.

       Updates action by accumulating with the transformation matrix of this node (if any).

       Reimplemented from SoNode.

   void SoBumpMapTransform::pick (SoPickAction *action) [virtual]
       Action method for SoPickAction.

       Does common processing for SoPickAction action instances.

       Reimplemented from SoNode.

Member Data Documentation

   SoSFVec2f SoBumpMapTransform::translation
       Texture coordinate translation. Default value is [0, 0].

   SoSFFloat SoBumpMapTransform::rotation
       Texture coordinate rotation (around z-axis, s is x-axis and t is y-axis). Defaults to an identity
       rotation (ie zero rotation).

   SoSFVec2f SoBumpMapTransform::scaleFactor
       Texture coordinate scale factors. Default value is [1, 1].

   SoSFVec2f SoBumpMapTransform::center
       Center for scale and rotation. Default value is [0, 0].

Author

       Generated automatically by Doxygen for Coin from the source code.