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

Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions

SoSpotLight Class Reference

The SoSpotLight class is a node type for light sources with a cone shaped lightvolume.Spotlights are light sources with a position and a direction. They can be thought of as a pointlight with a lampshade. More...

#include <Inventor/nodes/SoSpotLight.h>

Inheritance diagram for SoSpotLight:
SoLight SoNode SoFieldContainer SoBase SoSpotLightManip

List of all members.

Public Member Functions

 SoSpotLight (void)
virtual void GLRender (SoGLRenderAction *action)

Static Public Member Functions

static void initClass (void)

Public Attributes

SoSFVec3f location
SoSFVec3f direction
SoSFFloat dropOffRate
SoSFFloat cutOffAngle

Protected Member Functions

virtual ~SoSpotLight ()

Detailed Description

The SoSpotLight class is a node type for light sources with a cone shaped lightvolume.

Spotlights are light sources with a position and a direction. They can be thought of as a pointlight with a lampshade.

See also documentation of parent class for important information regarding light sources in general.

FILE FORMAT/DEFAULTS:

    SpotLight {
        on TRUE
        intensity 1
        color 1 1 1
        location 0 0 1
        direction 0 0 -1
        dropOffRate 0
        cutOffAngle 0.78539819
    }
See also:
SoSpotLight

Constructor & Destructor Documentation

SoSpotLight::SoSpotLight ( void  )

Constructor.

References cutOffAngle, direction, dropOffRate, and location.

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

Destructor.


Member Function Documentation

void SoSpotLight::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 SoLight.

Reimplemented in SoSpotLightManip.

References SoNode::VRML1.

void SoSpotLight::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 SoSpotLightManip.

References SoLight::color, cutOffAngle, direction, dropOffRate, SoAction::getState(), SbVec3f::getValue(), SbVec4f::getValue(), SbColor4f::getValue(), SoLight::intensity, location, SoLight::on, SoDebugError::post(), and SbColor4f::setRGB().


Member Data Documentation

3D position of light source. Default position is <0, 0, 1>.

Referenced by SoSpotLightManip::fieldSensorCB(), GLRender(), SoSpotLight(), SoSpotLightManip::transferFieldValues(), and SoSpotLightManip::valueChangedCB().

Direction vector, where the light is pointing. Default is to point along the negative z-axis.

Referenced by SoSpotLightManip::fieldSensorCB(), GLRender(), SoSpotLight(), SoSpotLightManip::transferFieldValues(), and SoSpotLightManip::valueChangedCB().

The rate of intensity drop-off from the ray along the direction vector. Value must be between 0.0 (equal intensity for the whole cone of light), to 1.0 (a narrow intensity ray).

Default value is 0.0.

Referenced by GLRender(), and SoSpotLight().

The angle in radians from the direction vector where there will be no light outside (i.e. the angle of the "lampshade"). Default value is PI/4.0 (i.e. 45°).

Referenced by SoSpotLightManip::fieldSensorCB(), GLRender(), SoSpotLight(), SoSpotLightManip::transferFieldValues(), and SoSpotLightManip::valueChangedCB().


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 28 2011 10:12:21 for Coin by Doxygen. 1.7.3