Man Linux: Main Page and Category List

NAME

       SoMultiTextureEnabledElement -

       The SoMultiTextureEnabledElement class is an element which stores
       whether texturing is enabled or not.

       Be aware that this class is an extension for Coin, and it is not
       available in the original SGI Open Inventor v2.1 API.

SYNOPSIS

       #include <Inventor/elements/SoMultiTextureEnabledElement.h>

       Inherits SoElement.

       Inherited by SoGLMultiTextureEnabledElement.

   Public Types
       enum Mode { DISABLED, TEXTURE2D, RECTANGLE, CUBEMAP, TEXTURE3D }

   Public Member Functions
       virtual void init (SoState *state)
       virtual void setElt (const int unit, const int mode)
       virtual void push (SoState *state)
       virtual SbBool matches (const SoElement *elem) const
       SoElement * copyMatchInfo (void) const

   Static Public Member Functions
       static void initClass (void)
       static void set (SoState *state, SoNode *node, const int unit, const
           SbBool enabled)
       static SbBool get (SoState *state, const int unit)
       static const SbBool * getEnabledUnits (SoState *state, int
           &lastenabled)
       static const Mode * getActiveUnits (SoState *state, int &lastenabled)
       static void enableRectangle (SoState *state, SoNode *node, const int
           unit)
       static void enableCubeMap (SoState *state, SoNode *node, const int
           unit)
       static Mode getMode (SoState *state, const int unit)
       static void disableAll (SoState *state)

   Protected Member Functions
       virtual ~SoMultiTextureEnabledElement ()
       SbBool isEnabled (const int unit) const
       Mode getMode (const int unit) const

Detailed Description

       The SoMultiTextureEnabledElement class is an element which stores
       whether texturing is enabled or not.

       Be aware that this class is an extension for Coin, and it is not
       available in the original SGI Open Inventor v2.1 API.

       Since:
           Coin 2.2

Constructor & Destructor Documentation

   SoMultiTextureEnabledElement::~SoMultiTextureEnabledElement (void)
       [protected, virtual] The destructor.

Member Function Documentation

   void SoMultiTextureEnabledElement::initClass (void) [static] Initialize
       relevant common data for all instances, like the type system.
       Reimplemented from SoElement.

   SbBool SoMultiTextureEnabledElement::get (SoState * state, const int unit)
       [static] Return current state of this element for unit.
   void SoMultiTextureEnabledElement::setElt (const int unit, const int
       enabled) [virtual] virtual element set function.
   SoElement * SoMultiTextureEnabledElement::copyMatchInfo (void) const
       [virtual] This function creates a copy of the element that contains
       enough information to enable the matches() function to work.
       Used to help with scenegraph traversal caching operations.

       Implements SoElement.

   const SbBool * SoMultiTextureEnabledElement::getEnabledUnits (SoState *
       state, int & lastenabled) [static] Returns a pointer to a boolean
       array. TRUE means unit is enabled and that texture coordinates must be
       sent to the unit. lastenabled is set to the last enabled unit.
   const SoMultiTextureEnabledElement::Mode *
       SoMultiTextureEnabledElement::getActiveUnits (SoState * state, int &
       lastenabled) [static] Returns the mode of all units. Also returns the
       last enabled unit in lastenabled.
       Since:
           Coin 2.5

   SoMultiTextureEnabledElement::Mode SoMultiTextureEnabledElement::getMode
       (SoState * state, const int unit) [static] Returns the mode for a
       texture unit.
       Since:
           Coin 2.5

   void SoMultiTextureEnabledElement::disableAll (SoState * state) [static]
       Disable all active texture units. Convenient when all textures needs to
       be disabled before rendering.
       Since:
           Coin 2.5

   SbBool SoMultiTextureEnabledElement::isEnabled (const int unit) const
       [protected] Returns TRUE if unit is enabled (Mode == DISABLED).

Author

       Generated automatically by Doxygen for Coin from the source code.