trusty (3) SoTransparencyType.3.gz

NAME

       SoTransparencyType -

       The SoTransparencyType class is a node for setting the transparency type for shapes.

       In earlier versions of Coin/Open Inventor it was only possible to set the transparency mode globally for
       an entire scene graph, which could be inconvenient if different transparency types was wanted for
       different shapes.

SYNOPSIS

       #include <Inventor/nodes/SoTransparencyType.h>

       Inherits SoNode.

   Public Types
       enum Type { SCREEN_DOOR = SoGLRenderAction::SCREEN_DOOR, ADD = SoGLRenderAction::ADD, DELAYED_ADD =
           SoGLRenderAction::DELAYED_ADD, SORTED_OBJECT_ADD = SoGLRenderAction::SORTED_OBJECT_ADD, BLEND =
           SoGLRenderAction::BLEND, DELAYED_BLEND = SoGLRenderAction::DELAYED_BLEND, SORTED_OBJECT_BLEND =
           SoGLRenderAction::SORTED_OBJECT_BLEND, SORTED_OBJECT_SORTED_TRIANGLE_ADD,
           SORTED_OBJECT_SORTED_TRIANGLE_BLEND, NONE = SoGLRenderAction::NONE }

   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.
       SoTransparencyType (void)
       virtual void doAction (SoAction *action)
       virtual void GLRender (SoGLRenderAction *action)
       virtual void callback (SoCallbackAction *action)

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

   Public Attributes
       SoSFEnum value

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

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

   Additional Inherited Members

Detailed Description

       The SoTransparencyType class is a node for setting the transparency type for shapes.

       In earlier versions of Coin/Open Inventor it was only possible to set the transparency mode globally for
       an entire scene graph, which could be inconvenient if different transparency types was wanted for
       different shapes.

       Here is a screenshot of the different transparency modes used in a single scene.

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

       FILE FORMAT/DEFAULTS:

       TransparencyType {
           value SCREEN_DOOR
       }

       See Also:
           SoGLRenderAction::TransparencyType

       Since:
           Coin 2.0

Member Enumeration Documentation

   enum SoTransparencyType::Type
       Enumeration of available transparency types. See documentation in SoGLRenderAction for a description of
       the different types.

Constructor & Destructor Documentation

   SoTransparencyType::SoTransparencyType (void)
       Constructor.

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

Member Function Documentation

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

       Reimplemented from SoNode.

   void SoTransparencyType::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 SoTransparencyType::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.

Member Data Documentation

   SoSFEnum SoTransparencyType::value
       The transparency type to use for subsequent shape nodes in the scene graph.

Author

       Generated automatically by Doxygen for Coin from the source code.