GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SOSPOTLIGHT (3)

NAME

SoSpotLight — node representing a spotlight source

CONTENTS

Inherits From
Synopsis
Description
Fields
Methods
Action Behavior
File Format/defaults
See Also

INHERITS FROM

SoBase > SoFieldContainer > SoNode > SoLight > SoSpotLight

SYNOPSIS

#include <Inventor/nodes/SoSpotLight.h>

Fields from class SoSpotLight:

    SoSFVec3f    
                    
SoSFVec3f            location    
SoSFVec3f    
                    
SoSFVec3f            direction    
SoSFFloat    
                    
SoSFFloat            dropOffRate    
SoSFFloat    
                    
SoSFFloat            cutOffAngle

Fields from class SoLight:

    SoSFBool    
                    
SoSFBool             on    
SoSFFloat    
                    
SoSFFloat            intensity    
SoSFColor    
                    
SoSFColor            color

Methods from class SoSpotLight:

       
                    
                     SoSpotLight()    
static SoType    
                    
static SoType        getClassTypeId()

Methods from class SoNode:

    void    
                    
void                 setOverride(SbBool state)    
SbBool    
                    
SbBool               isOverride() const    
SoNode *    
                    
SoNode *             copy(SbBool copyConnections = FALSE) const    
virtual SbBool    
                    
virtual SbBool       affectsState() const    
static SoNode *    
                    
static SoNode *      getByName(const SbName &name)    
static int    
                    
static int           getByName(const SbName &name, SoNodeList &list)

Methods from class SoFieldContainer:

    void    
                    
void                 setToDefaults()    
SbBool    
                    
SbBool               hasDefaultValues() const    
SbBool    
                    
SbBool               fieldsAreEqual(const SoFieldContainer *fc) const    
void    
                    
void                 copyFieldValues(const SoFieldContainer *fc, SbBool copyConnections = FALSE)    
SbBool    
                    
SbBool               set(const char *fieldDataString)    
void    
                    
void                 get(SbString &fieldDataString)    
virtual int    
                    
virtual int          getFields(SoFieldList &resultList) const    
virtual SoField *    
                    
virtual SoField *    getField(const SbName &fieldName) const    
SbBool    
                    
SbBool               getFieldName(const SoField *field, SbName &fieldName) const    
SbBool    
                    
SbBool               isNotifyEnabled() const    
SbBool    
                    
SbBool               enableNotify(SbBool flag)

Methods from class SoBase:

    void    
                    
void                 ref()    
void    
                    
void                 unref() const    
void    
                    
void                 unrefNoDelete() const    
void    
                    
void                 touch()    
virtual SoType    
                    
virtual SoType       getTypeId() const    
SbBool    
                    
SbBool               isOfType(SoType type) const    
virtual void    
                    
virtual void         setName(const SbName &name)    
virtual SbName    
                    
virtual SbName       getName() const

DESCRIPTION

This node defines a spotlight style light source. A spotlight is placed at a fixed location in 3-space and illuminates in a cone along a particular direction. The intensity of the illumination drops off exponentially as a ray of light diverges from this direction toward the edges of the cone. The rate of drop-off and the angle of the cone are controlled by the dropOffRate and cutOffAngle fields.

FIELDS

    SoSFVec3f    
                    
SoSFVec3f            location
Location of the source.

    SoSFVec3f    
                    
SoSFVec3f            direction
Principal direction of illumination (center axis of cone).

    SoSFFloat    
                    
SoSFFloat            dropOffRate
Rate of intensity drop-off per change in angle from primary direction: 0 = constant intensity, 1 = very sharp drop-off

    SoSFFloat    
                    
SoSFFloat            cutOffAngle
Angle (in radians) outside of which intensity is zero, measured from the center axis of the cone to an edge.

METHODS

       
                    
                     SoSpotLight()
Creates a spotlight source node with default settings.

    static SoType    
                    
static SoType        getClassTypeId()
Returns type identifier for this class.

ACTION BEHAVIOR

SoGLRenderAction
Activates this light (if so specified) during traversal. All shape nodes that come after this light in the scene graph are illuminated by this light. The light’s location is affected by the current transformation.

FILE FORMAT/DEFAULTS

SpotLight {



on           TRUE
intensity    1
color        1 1 1
location     0 0 1
direction    0 0 -1
dropOffRate  0
cutOffAngle  0.785398


}

SEE ALSO

SoDirectionalLight, SoPointLight

Search for    or go to Top of page |  Section 3 |  Main Index


SOSPOTLIGHT(3IV) (-->)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.