SoVRMLLight(3)

NAME
SoVRMLLight - The SoVRMLLight class is a superclass for VRML light nodes.

SYNOPSIS

#include <Inventor/VRMLnodes/SoVRMLLight.h>

Inherits SoNode.

Inherited by SoVRMLDirectionalLight, SoVRMLPointLight, and SoVRMLSpotLight.

  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 SoFieldData * getFieldData (void) const
SoVRMLLight (void)
virtual ~SoVRMLLight ()

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

  Additional Inherited Members

Detailed Description

The SoVRMLLight class is a superclass for VRML light nodes.

Constructor & Destructor Documentation

  SoVRMLLight::SoVRMLLight (void) [protected]
Constructor.

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

Member Function Documentation

  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
  }
}

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 SoVRMLPointLight, SoVRMLSpotLight, and SoVRMLDirectionalLight.

  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 SoVRMLPointLight, SoVRMLSpotLight, and SoVRMLDirectionalLight.

  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 SoVRMLSpotLight, SoVRMLPointLight, and SoVRMLDirectionalLight.

Member Data Documentation

  SoSFBool SoVRMLLight::on
Enable/disable light. Default value is TRUE.

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

  SoSFColor SoVRMLLight::color
The light color. Default value is (1, 1, 1).

  SoSFFloat SoVRMLLight::ambientIntensity
The light ambient intensity. A value from 0 to 1. Default value is 0.

Author

Generated automatically by Doxygen for Coin from the source code.