Coin Logo http://www.sim.no
http://www.coin3d.org

SoTransparencyType Class Reference
[Nodes]

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. More...

#include <Inventor/nodes/SoTransparencyType.h>

Inheritance diagram for SoTransparencyType:

SoNode SoFieldContainer SoBase

List of all members.

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
 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 SoFieldDatagetFieldData (void) const
virtual ~SoTransparencyType ()

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)


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.

transparencytype.png

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

Enumeration of available transparency types. See documentation in SoGLRenderAction for a description of the different types.


Constructor & Destructor Documentation

SoTransparencyType::SoTransparencyType ( void   ) 

Constructor.

References value.

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

Destructor.


Member Function Documentation

SoType SoTransparencyType::getClassTypeId ( void   )  [static]

This static method returns the SoType object associated with objects of this class.

Reimplemented from SoNode.

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
    }
    else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
      SoGroup * group = (SoGroup *)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::getFieldDataPtr ( void   )  [static, protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Reimplemented from SoNode.

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::initClass ( void   )  [static]

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Reimplemented from SoNode.

void SoTransparencyType::doAction ( SoAction action  )  [virtual]

This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

References SoAction::getState(), SoOverrideElement::getTransparencyTypeOverride(), SoSFEnum::getValue(), SoField::isIgnored(), SoNode::isOverride(), SoOverrideElement::setTransparencyTypeOverride(), and value.

Referenced by callback(), and GLRender().

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.

References doAction().

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.

References doAction().


Member Data Documentation

The transparency type to use for subsequent shape nodes in the scene graph.

Referenced by doAction(), and SoTransparencyType().


The documentation for this class was generated from the following files:

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 23 16:34:05 2009 for Coin by Doxygen. 1.5.8