NAME

       SoTextureUnit -

       The SoTextureUnit class is a node for setting the active texture unit.

       When an SoTextureUnit node is inserted into the scene graph, all subsequent texture nodes
       (SoTexture2, SoTextureCoordinate2, SoTextureCoordinate3, SoTexture2Transform,
       SoTexture3Transform, SoTextureCoordinateEnvironment, SoTextureCoordinatePlane and
       SoComplexity) will affect the texture unit set in the unit field.

SYNOPSIS

       #include <Inventor/nodes/SoTextureUnit.h>

       Inherits SoNode.

   Public Types
       enum MappingMethod { BUMP_MAPPING, IMAGE_MAPPING }

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

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

   Public Attributes
       SoSFInt32 unit
       SoSFEnum mappingMethod

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

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

   Additional Inherited Members

Detailed Description

       The SoTextureUnit class is a node for setting the active texture unit.

       When an SoTextureUnit node is inserted into the scene graph, all subsequent texture nodes
       (SoTexture2, SoTextureCoordinate2, SoTextureCoordinate3, SoTexture2Transform,
       SoTexture3Transform, SoTextureCoordinateEnvironment, SoTextureCoordinatePlane and
       SoComplexity) will affect the texture unit set in the unit field.

       See the SoGuiExample module for an usage example for this node.

       FILE FORMAT/DEFAULTS:

       TextureUnit {
           unit 0
           mappingMethod IMAGE_MAPPING
       }

       Since:
           Coin 2.2

Member Enumeration Documentation

   enum SoTextureUnit::MappingMethod
       Enumerator

       BUMP_MAPPING
              Bump mapping is used.

       IMAGE_MAPPING
              Normal image mapping is used.

Constructor & Destructor Documentation

   SoTextureUnit::SoTextureUnit (void)
       Constructor.

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

Member Function Documentation

   SoType SoTextureUnit::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 * SoTextureUnit::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 SoTextureUnit::doAction (SoAction *action) [virtual]
       This function performs the typical operation of a node for any action.

       Reimplemented from SoNode.

   void SoTextureUnit::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 SoTextureUnit::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 SoTextureUnit::pick (SoPickAction *action) [virtual]
       Action method for SoPickAction.

       Does common processing for SoPickAction action instances.

       Reimplemented from SoNode.

   void SoTextureUnit::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 SoNode.

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

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

       Reimplemented from SoNode.

   uint32_t SoTextureUnit::getMaxTextureUnit (void) [static]
       Returns the maximum number of texture units for the current GL context. Do not call this
       method if you don't have a current active GL context. You should also know that your
       OpenGL driver supports multi-texturing.

       This function is provided only to be compatible with TGS Inventor. It's better to use
       cc_glglue_max_texture_units() if you're using Coin (declared in Inventor/C/glue/gl.h).

Member Data Documentation

   SoSFInt32 SoTextureUnit::unit
       The texture unit which will be used for texture nodes following this node in the
       traversal. Default value of the field is 0.

   SoSFEnum SoTextureUnit::mappingMethod
       The mapping method for this unit. Default is IMAGE_MAPPING.

       This field is not currently supported in Coin. It's included to support TGS' API. We might
       support the field in the future.

Author

       Generated automatically by Doxygen for Coin from the source code.