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

SoShadowStyle Class Reference
[Nodes]

The SoShadowStyle class is a node for setting the shadow style on nodes. More...

#include <Inventor/annex/FXViz/nodes/SoShadowStyle.h>

Inheritance diagram for SoShadowStyle:

SoNode SoFieldContainer SoBase

List of all members.

Public Types

enum  Style { NO_SHADOWING = SoShadowStyleElement::NO_SHADOWING, CASTS_SHADOW = SoShadowStyleElement::CASTS_SHADOW, SHADOWED = SoShadowStyleElement::SHADOWED, CASTS_SHADOW_AND_SHADOWED = SoShadowStyleElement::CASTS_SHADOW_AND_SHADOWED }

Public Member Functions

virtual SoType getTypeId (void) const
 SoShadowStyle (void)
virtual void GLRender (SoGLRenderAction *action)

Static Public Member Functions

static SoType getClassTypeId (void)
static void initClass (void)

Public Attributes

SoSFEnum style

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
virtual ~SoShadowStyle ()

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)


Detailed Description

The SoShadowStyle class is a node for setting the shadow style on nodes.

FILE FORMAT/DEFAULTS:

    ShadowStyle {
        style CASTS_SHADOW_AND_SHADOWED
    }

Since:
Coin 2.5

Member Enumeration Documentation

Enumerates the available style settings.

Enumerator:
NO_SHADOWING  Neither casts or recieves shadows.
CASTS_SHADOW  Casts shadow, but will no recieve any shadows.
SHADOWED  Receives shadows, but will not cast any shadow.


Constructor & Destructor Documentation

SoShadowStyle::SoShadowStyle ( void   ) 

Constructor.

References CASTS_SHADOW, NO_SHADOWING, SHADOWED, and style.

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

Destructor.


Member Function Documentation

SoType SoShadowStyle::getClassTypeId ( void   )  [static]

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

Reimplemented from SoNode.

SoType SoShadowStyle::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 ** SoShadowStyle::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 * SoShadowStyle::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 SoShadowStyle::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 SoShadowStyle::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 SoFieldContainer::get(), SoAction::getState(), SoSFEnum::getValue(), SoFieldContainer::set(), SHADOWED, and style.


Member Data Documentation

Set the current shadow style. Default value is CAST_SHADOW_AND_SHADOWED.

Referenced by GLRender(), and SoShadowStyle().


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:00 2009 for Coin by Doxygen. 1.5.8