---

SoSpotLightDragger Class Reference

The SoSpotLightDragger class provides interactive geometry for manipulating a spotlight. More...

#include <Inventor/draggers/SoSpotLightDragger.h>

Inheritance diagram for SoSpotLightDragger::

List of all members.

Public Methods
	SoSpotLightDragger (void)
Static Public Methods
void	initClass (void)
Public Attributes
SoSFRotation	rotation
SoSFVec3f	translation
SoSFFloat	angle
Protected Methods
	~SoSpotLightDragger ()
virtual SbBool	setUpConnections (SbBool onoff, SbBool doitalways=FALSE)
virtual void	setDefaultOnNonWritingFields (void)
void	dragStart (void)
void	drag (void)
void	dragFinish (void)
void	setBeamScaleFromAngle (float beamangle)
Static Protected Methods
void	startCB (void *f, SoDragger *d)
void	motionCB (void *f, SoDragger *d)
void	doneCB (void *f, SoDragger *d)
void	fieldSensorCB (void *f, SoSensor *s)
void	valueChangedCB (void *f, SoDragger *d)
Protected Attributes
SoFieldSensor *	rotFieldSensor
SoFieldSensor *	translFieldSensor
SoFieldSensor *	angleFieldSensor
SbPlaneProjector *	planeProj

---

Detailed Description

The SoSpotLightDragger class provides interactive geometry for manipulating a spotlight.

This dragger is well suited for setting up the fields of a SoSpotLight node, as it provides geometry for the end-user to interact with a directional vector for the spotlight, to set up it's position and to control the cut-off angle for the "lampshade" around the lightsource.

Note that there is one aspect of SoSpotLight nodes that can not be controlled with this dragger: the SoSpotLight::dropOffRate field.

The Coin library includes a manipulator class, SoSpotLightManip, which wraps the functionality provided by this class inside the necessary mechanisms for connecting it to SoSpotLight node instances in a scenegraph.

See also:

SoSpotLightManip, SoSpotLight , SoDirectionalLightDragger, SoPointLightDragger

---

Constructor & Destructor Documentation

SoSpotLightDragger::SoSpotLightDragger (  void )

Default constructor, sets up the dragger nodekit catalog with the interaction and feedback geometry.

SoSpotLightDragger::~SoSpotLightDragger (  )  [protected]

Protected destructor. (Dragger classes are derived from SoBase, so they are reference counted and automatically destroyed when their reference count goes to 0.)

---

Member Function Documentation

void SoSpotLightDragger::initClass (  void )  [static]

Initializes type system for this dragger class. Application programmers should usually not have to invoke this method, see documentation of SoInteraction::initClass(). Reimplemented from SoDragger.

SbBool SoSpotLightDragger::setUpConnections (  SbBool onoff, SbBool doitalways = FALSE )  [protected, virtual]

Sets up all internal connections for instances of this class. (This method will usually not be of interest to the application programmer, unless you want to extend the library with new custom nodekits or dragger classes. If so, see the SoBaseKit class documentation.) Reimplemented from SoInteractionKit.

void SoSpotLightDragger::setDefaultOnNonWritingFields (  void )  [protected, virtual]

(Be aware that this method is unlikely to be of interest to the application programmer who does not want to extend the library with new custom nodekits or draggers. If you indeed are writing extensions, see the information in the SoBaseKit class documentation.) A virtual method that should call SoField::setDefault() with argument TRUE on part fields that should not be written upon scenegraph export operations. This is typically done when: field value is NULL and part is NULL by default it is a leaf SoGroup or SoSeparator node with no children it is a leaf listpart with no children and a SoGroup or SoSeparator container it is a non-leaf part and it's of SoGroup type and all fields are at their default values Subclasses should usually override this to do additional settings for new member fields. From the subclass, do remember to call "upwards" to your superclass' setDefaultOnNonWritingFields() method. Reimplemented from SoDragger.

void SoSpotLightDragger::startCB (  void * f, SoDragger * d )  [static, protected]

For internal use only.

void SoSpotLightDragger::motionCB (  void * f, SoDragger * d )  [static, protected]

For internal use only.

void SoSpotLightDragger::doneCB (  void * f, SoDragger * d )  [static, protected]

For internal use only.

void SoSpotLightDragger::fieldSensorCB (  void * d, SoSensor * s )  [static, protected]

For internal use only. Reimplemented from SoInteractionKit.

void SoSpotLightDragger::valueChangedCB (  void * f, SoDragger * d )  [static, protected]

For internal use only.

void SoSpotLightDragger::dragStart (  void )  [protected]

For internal use only.

void SoSpotLightDragger::drag (  void )  [protected]

For internal use only.

void SoSpotLightDragger::dragFinish (  void )  [protected]

For internal use only.

void SoSpotLightDragger::setBeamScaleFromAngle (  float beamangle )  [protected]

Scales the geometry representing the "lampshade" around the lightsource to represent the given beamangle.

---

Member Data Documentation

SoSFRotation SoSpotLightDragger::rotation

This field is continuously updated to contain the rotation of the current direction vector. The application programmer will typically connect this to the rotation field of a SoSpotLight node (unless using the SoSpotLightManip class, where this is taken care of automatically). It may also of course be connected to any other rotation field controlling the direction of scenegraph geometry, it does not have to part of a SoSpotLight node specifically.

SoSFVec3f SoSpotLightDragger::translation

Continuously updated to contain the current translation from the dragger's local origo position.

SoSFFloat SoSpotLightDragger::angle

The cut-off angle for the "lampshade" around the lightsource. Typically connected to a SoSpotLight::cutOffAngle field.

SoFieldSensor * SoSpotLightDragger::rotFieldSensor [protected]

For internal use only.

SoFieldSensor * SoSpotLightDragger::translFieldSensor [protected]

For internal use only.

SoFieldSensor * SoSpotLightDragger::angleFieldSensor [protected]

For internal use only.

SbPlaneProjector * SoSpotLightDragger::planeProj [protected]

For internal use only.

---

The documentation for this class was generated from the following files:

• SoSpotLightDragger.cpp
• SoSpotLightDragger.h

---