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

SoVRMLLight Class Reference

The SoVRMLLight class is a superclass for VRML light nodes. More...

#include <Inventor/VRMLnodes/SoVRMLLight.h>

Inheritance diagram for SoVRMLLight:

SoNode SoFieldContainer SoBase SoVRMLDirectionalLight SoVRMLPointLight SoVRMLSpotLight

List of all members.

Public Member Functions

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

Static Public Member Functions

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

Public Attributes

SoSFBool on
SoSFFloat intensity
SoSFColor color
SoSFFloat ambientIntensity

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
 SoVRMLLight (void)
virtual ~SoVRMLLight ()

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)


Detailed Description

The SoVRMLLight class is a superclass for VRML light nodes.

Constructor & Destructor Documentation

SoVRMLLight::SoVRMLLight ( void   )  [protected]

Constructor.

References ambientIntensity, color, intensity, and on.

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

Destructor.


Member Function Documentation

SoType SoVRMLLight::getClassTypeId ( void   )  [static]

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

Reimplemented from SoNode.

Reimplemented in SoVRMLDirectionalLight, SoVRMLPointLight, and SoVRMLSpotLight.

SoType SoVRMLLight::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.

Reimplemented in SoVRMLDirectionalLight, SoVRMLPointLight, and SoVRMLSpotLight.

const SoFieldData ** SoVRMLLight::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.

Reimplemented in SoVRMLDirectionalLight, SoVRMLPointLight, and SoVRMLSpotLight.

const SoFieldData * SoVRMLLight::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.

Reimplemented in SoVRMLDirectionalLight, SoVRMLPointLight, and SoVRMLSpotLight.

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

Reimplemented in SoVRMLDirectionalLight, SoVRMLPointLight, and SoVRMLSpotLight.

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

Reimplemented in SoVRMLDirectionalLight, SoVRMLPointLight, and SoVRMLSpotLight.


Member Data Documentation

Enable/disable light. Default value is TRUE.

Referenced by SoVRMLSpotLight::GLRender(), SoVRMLPointLight::GLRender(), SoVRMLDirectionalLight::GLRender(), and SoVRMLLight().

The light intensity. A value from 0 to 1. Default value is 1.

Referenced by SoVRMLSpotLight::GLRender(), SoVRMLPointLight::GLRender(), SoVRMLDirectionalLight::GLRender(), and SoVRMLLight().

The light color. Default value is (1, 1, 1).

Referenced by SoVRMLSpotLight::GLRender(), SoVRMLPointLight::GLRender(), SoVRMLDirectionalLight::GLRender(), and SoVRMLLight().

The light ambient intensity. A value from 0 to 1. Default value is 0.

Referenced by SoVRMLSpotLight::GLRender(), SoVRMLPointLight::GLRender(), SoVRMLDirectionalLight::GLRender(), and SoVRMLLight().


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