SoSpotLight(3IV)

NAME
     SoSpotLight (SoSpotLt) - node representing a spotlight source

INHERITS FROM
     SoBase > SoFieldContainer > SoNode > SoLight > SoSpotLight

SYNOPSIS
     #include <Inventor_c/nodes/SoSpotLight.h>

     typedef SoSpotLight  SoSpotLt

          Fields from class SoSpotLight:

     SoSFVec3f           location
     SoSFVec3f           direction
     SoSFFloat           dropOffRate
     SoSFFloat           cutOffAngle

          Fields from class SoLight:

     SoSFBool            on
     SoSFFloat           intensity
     SoSFColor           color

          Functions from class SoSpotLight:

     SoSpotLight *       SoSpotLtCreate()
     SoType              SoSpotLtGetClassTypeId()

          Functions from class SoNode:

     void                SoSpotLtSetOverride(SoSpotLt *this, SbBool state)
     SbBool              SoSpotLtIsOverride(const SoSpotLt *this)
     SoNode *            SoSpotLtCopy(const SoSpotLt *this, SbBool
                              copyConnections = FALSE)
     SbBool              SoSpotLtAffectsState(const SoSpotLt *this)
     SoNode *            SoSpotLtGetByName(const char *name)
     int                 SoSpotLtGetByNameList(const char *name, SoNodeList
                              *list)

          Functions from class SoFieldContainer:

     void                SoSpotLtSetToDflts(SoSpotLt *this)
     SbBool              SoSpotLtHasDfltVals(const SoSpotLt *this)
     SbBool              SoSpotLtFldsAreEq(const SoSpotLt *this, const
                              SoFieldContainer *fc)
     void                SoSpotLtCopyFieldVals(SoSpotLt *this, const
                              SoFieldContainer *fc, SbBool copyConnections =
                              FALSE)
     SbBool              SoSpotLtSet(SoSpotLt *this, const char
                              *fieldDataString)
     void                SoSpotLtGet(SoSpotLt *this, SbString
                              *fieldDataString)
     int                 SoSpotLtGetFields(const SoSpotLt *this, SoFieldList
                              *resultList)
     SoField *           SoSpotLtGetField(const SoSpotLt *this, const char
                              *fieldName)
     SbBool              SoSpotLtGetFieldName(const SoSpotLt *this, const
                              SoField *field, SbName *fieldName)
     SbBool              SoSpotLtIsNotifyEnabled(const SoSpotLt *this)
     SbBool              SoSpotLtEnableNotify(SoSpotLt *this, SbBool flag)

          Functions from class SoBase:

     void                SoSpotLtRef(SoSpotLt *this)
     void                SoSpotLtUnref(const SoSpotLt *this)
     void                SoSpotLtUnrefNoDelete(const SoSpotLt *this)
     void                SoSpotLtTouch(SoSpotLt *this)
     SoType              SoSpotLtGetTypeId(const SoSpotLt *this)
     SbBool              SoSpotLtIsOfType(const SoSpotLt *this, SoType type)
     void                SoSpotLtSetName(SoSpotLt *this, const char *name)
     SbName              SoSpotLtGetName(const SoSpotLt *this)


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           location
          Location of the source.

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

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

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


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

     SoType              SoSpotLtGetClassTypeId()
          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