SoSpotLight(3iv)

1SoSpotLight(3IV)()                                          SoSpotLight(3IV)()
2
3
4

NAME

6       SoSpotLight — node representing a spotlight source
7

INHERITS FROM

9       SoBase > SoFieldContainer > SoNode > SoLight > SoSpotLight
10

SYNOPSIS

12       #include <Inventor/nodes/SoSpotLight.h>
13
14          Fields from class SoSpotLight:
15
16     SoSFVec3f           location
17     SoSFVec3f           direction
18     SoSFFloat           dropOffRate
19     SoSFFloat           cutOffAngle
20
21          Fields from class SoLight:
22
23     SoSFBool            on
24     SoSFFloat           intensity
25     SoSFColor           color
26
27          Methods from class SoSpotLight:
28
29                         SoSpotLight()
30     static SoType       getClassTypeId()
31
32          Methods from class SoNode:
33
34     void                setOverride(SbBool state)
35     SbBool              isOverride() const
36     SoNode *            copy(SbBool copyConnections = FALSE) const
37     virtual SbBool      affectsState() const
38     static SoNode *     getByName(const SbName &name)
39     static int          getByName(const SbName &name, SoNodeList &list)
40
41          Methods from class SoFieldContainer:
42
43     void                setToDefaults()
44     SbBool              hasDefaultValues() const
45     SbBool              fieldsAreEqual(const SoFieldContainer *fc) const
46     void                copyFieldValues(const  SoFieldContainer  *fc,  SbBool
47                              copyConnections = FALSE)
48     SbBool              set(const char *fieldDataString)
49     void                get(SbString &fieldDataString)
50     virtual int         getFields(SoFieldList &resultList) const
51     virtual SoField *   getField(const SbName &fieldName) const
52     SbBool              getFieldName(const SoField *field, SbName &fieldName)
53                              const
54     SbBool              isNotifyEnabled() const
55     SbBool              enableNotify(SbBool flag)
56
57          Methods from class SoBase:
58
59     void                ref()
60     void                unref() const
61     void                unrefNoDelete() const
62     void                touch()
63     virtual SoType      getTypeId() const
64     SbBool              isOfType(SoType type) const
65     virtual void        setName(const SbName &name)
66     virtual SbName      getName() const
67
68

DESCRIPTION

70       This node defines a spotlight style light source. A spotlight is placed
71       at a fixed location in 3-space and illuminates in a cone along  a  par‐
72       ticular direction. The intensity of the illumination drops off exponen‐
73       tially as a ray of light diverges from this direction toward the  edges
74       of  the  cone.  The rate of drop-off and the angle of the cone are con‐
75       trolled by the dropOffRate and cutOffAngle fields.
76

FIELDS

78     SoSFVec3f           location
79          Location of the source.
80
81     SoSFVec3f           direction
82          Principal direction of illumination (center axis of cone).
83
84     SoSFFloat           dropOffRate
85          Rate of intensity drop-off per change in angle from  primary  direc‐
86          tion: 0 = constant intensity, 1 = very sharp drop-off
87
88     SoSFFloat           cutOffAngle
89          Angle (in radians) outside of which intensity is zero, measured from
90          the center axis of the cone to an edge.
91
92

METHODS

94                         SoSpotLight()
95          Creates a spotlight source node with default settings.
96
97     static SoType       getClassTypeId()
98          Returns type identifier for this class.
99
100

ACTION BEHAVIOR

102       SoGLRenderAction
103          Activates this light (if so specified) during traversal.  All  shape
104          nodes  that come after this light in the scene graph are illuminated
105          by this light. The light's  location  is  affected  by  the  current
106          transformation.
107
108

FILE FORMAT/DEFAULTS

110       SpotLight {
111          on           TRUE
112          intensity    1
113          color        1 1 1
114          location     0 0 1
115          direction    0 0 -1
116          dropOffRate  0
117          cutOffAngle  0.785398
118     }
119