SoSpotLightDragger(3IV)NAMESoSpotLightDragger (SoSpotLtDrag) - spotlight shaped dragger that allows
you to change position, direction, and width of the beam
INHERITS FROM
SoBase > SoFieldContainer > SoNode > SoBaseKit > SoInteractionKit >
SoDragger > SoSpotLightDraggerSYNOPSIS
#include <Inventor_c/draggers/SoSpotLightDragger.h>
typedef SoSpotLightDragger SoSpotLtDrag
Fields from class SoSpotLightDragger:
SoSFRotation rotation
SoSFVec3f translation
SoSFFloat angle
Fields from class SoDragger:
SoSFBool isActive
Fields from class SoInteractionKit:
SoSFEnum renderCaching
SoSFEnum boundingBoxCaching
SoSFEnum renderCulling
SoSFEnum pickCulling
Parts from class SoBaseKit:
(SoNodeKitListPart) callbackList
Functions from class SoSpotLightDragger:
SoSpotLightDragger * SoSpotLtDragCreate()
const SoNodekitCatalog * SoSpotLtDragGetClassNkitCat()
SoType SoSpotLtDragGetClassTypeId()
Functions from class SoDragger:
void SoSpotLtDragAddStartCB(SoSpotLtDrag *this,
SoDraggerCB *f, void *userData = NULL)
void SoSpotLtDragRemoveStartCB(SoSpotLtDrag *this,
SoDraggerCB *f, void *userData = NULL)
void SoSpotLtDragAddMotionCB(SoSpotLtDrag *this,
SoDraggerCB *f, void *userData = NULL)
void SoSpotLtDragRemoveMotionCB(SoSpotLtDrag *this,
SoDraggerCB *f, void *userData = NULL)
void SoSpotLtDragAddFinishCB(SoSpotLtDrag *this,
SoDraggerCB *f, void *userData = NULL)
Page 1SoSpotLightDragger(3IV)
void SoSpotLtDragRemoveFinishCB(SoSpotLtDrag *this,
SoDraggerCB *f, void *userData = NULL)
void SoSpotLtDragAddValueChangedCB(SoSpotLtDrag *this,
SoDraggerCB *f, void *userData = NULL)
void SoSpotLtDragRemoveValueChangedCB(SoSpotLtDrag *this,
SoDraggerCB *f, void *userData = NULL)
SbBool SoSpotLtDragEnableValueChangedCBs(SoSpotLtDrag *this)
void SoSpotLtDragSetMinGesture(SoSpotLtDrag *this, int
pixels)
int SoSpotLtDragGetMinGesture(const SoSpotLtDrag *this)
void SoSpotLtDragSetMinScale(float newMinScale)
float SoSpotLtDragGetMinScale()
Functions from class SoInteractionKit:
SbBool SoSpotLtDragSetPartAsPath(SoSpotLtDrag *this, const
char *partName, SoPath *surrogatePath )
Functions from class SoBaseKit:
const SoNodekitCatalog * SoSpotLtDragGetCat(const SoSpotLtDrag *this)
SoNode * SoSpotLtDragGetPart(SoSpotLtDrag *this, const
char *partName, SbBool makeIfNeeded)
SbString SoSpotLtDragGetPartString(SoSpotLtDrag *this,
const SoBase *part)
SoNodeKitPath * SoSpotLtDragCreatePathToPart(SoSpotLtDrag
*this, const char *partName, SbBool
makeIfNeeded, const SoPath *pathToExtend =
NULL)
SbBool SoSpotLtDragSetPart(SoSpotLtDrag *this, const
char *partName, SoNode *newPart)
SbBool SoSpotLtDragSet(SoSpotLtDrag *this, char
*partName, char *parameters)
SbBool SoSpotLtDragSet2(SoSpotLtDrag *this, char
*nameValuePairs)
SbBool SoSpotLtDragIsSearchingChildren()
void SoSpotLtDragSetSearchingChildren(SbBool newVal)
Functions from class SoNode:
void SoSpotLtDragSetOverride(SoSpotLtDrag *this, SbBool
state)
SbBool SoSpotLtDragIsOverride(const SoSpotLtDrag *this)
SoNode * SoSpotLtDragCopy(const SoSpotLtDrag *this, SbBool
copyConnections = FALSE)
SbBool SoSpotLtDragAffectsState(const SoSpotLtDrag *this)
SoNode * SoSpotLtDragGetByName(const char *name)
int SoSpotLtDragGetByNameList(const char *name,
SoNodeList *list)
Functions from class SoFieldContainer:
Page 2SoSpotLightDragger(3IV)
void SoSpotLtDragSetToDflts(SoSpotLtDrag *this)
SbBool SoSpotLtDragHasDfltVals(const SoSpotLtDrag *this)
SbBool SoSpotLtDragFldsAreEq(const SoSpotLtDrag *this, const
SoFieldContainer *fc)
void SoSpotLtDragCopyFieldVals(SoSpotLtDrag *this, const
SoFieldContainer *fc, SbBool copyConnections =
FALSE)
void SoSpotLtDragGet(SoSpotLtDrag *this, SbString
*fieldDataString)
int SoSpotLtDragGetFields(const SoSpotLtDrag *this,
SoFieldList *resultList)
SoField * SoSpotLtDragGetField(const SoSpotLtDrag *this, const
char *fieldName)
SbBool SoSpotLtDragGetFieldName(const SoSpotLtDrag *this,
const SoField *field, SbName *fieldName)
SbBool SoSpotLtDragIsNotifyEnabled(const SoSpotLtDrag *this)
SbBool SoSpotLtDragEnableNotify(SoSpotLtDrag *this, SbBool
flag)
Functions from class SoBase:
void SoSpotLtDragRef(SoSpotLtDrag *this)
void SoSpotLtDragUnref(const SoSpotLtDrag *this)
void SoSpotLtDragUnrefNoDelete(const SoSpotLtDrag *this)
void SoSpotLtDragTouch(SoSpotLtDrag *this)
SoType SoSpotLtDragGetTypeId(const SoSpotLtDrag *this)
SbBool SoSpotLtDragIsOfType(const SoSpotLtDrag *this, SoType
type)
void SoSpotLtDragSetName(SoSpotLtDrag *this, const char
*name)
SbName SoSpotLtDragGetName(const SoSpotLtDrag *this)
DESCRIPTIONSoSpotLightDragger is a composite dragger. It is shaped like a beam of
light emanating from a sun-like ball. An arrow runs along the axis of the
beam and extends past the end of the beam.
When you click and drag the beam, it opens and closes with an umbrella-
like motion. The angle between the center and edge of the beam is stored
in the angle field of this dragger; setting the angle field causes the
beam to widen or narrow in response. The spotlight dragger does not use
a standard dragger class to execute this motion. More details are given
later in this section.
Dragging the arrow rotates it arount the sun, and the beam moves with it.
The arrow is an SoRotateSphericalDragger that controls the rotation
field. See the reference page for SoDirectionalLightDragger, which works
the same way, for details.
The sun-shape can be dragged to translate all three pieces together
through 3-space. Its movement controls the translation field and works
Page 3SoSpotLightDragger(3IV)
exactly as described in the reference pages for SoDirectionalLightDragger
and SoPointLightDragger (which goes into more detail).
Remember: This is not a light source! It just looks like one. If you want
to move a light with this dragger, you can do the following:
[a] Use an SoSpotLightManip, which is subclassed from SoLight. It creates
an SoSpotLightDragger and uses it as the interface to change the
location, direction, and cutOffAngle of its light source (see the
SoSpotLightManip man page). The manip also edits the material part of
this dragger to match the color of light the manip is producing.
[b] Connect the angle field of this dragger to the cutOffAngle field of
an SoSpotLight with a field-to-field connection.
See the SoPointLightDragger and SoDirectionalLightDragger man pages for
other ways to control light parameters with the rotation and translation
fields.
This class creates its own projector and handles mouse events to do it's
own dragging of the beam angle. When the mouse picks a point on the beam,
that point is dragged in a circle just like in an SoRotateDiscDragger,
but the plane of the disc is re-defined every time a drag is initiated.
Imagine placing the metal tip of a compass at the apex of the cone and
the pencil tip at the picked point. If you swing an arc through the
central axis of the cone, you will be drawing the arc used to drag the
beam open and closed.
The beam is opened and closed not by rotating, but by scaling. The
dragger scales the beam-cone so that the height and radius change to move
the picked point along the circle. Then the angle field is calculated
from the height and radius.
You can change the geometry of parts in any instance of this dragger
using SoDraggerSetPart(). The default part geometries are defined as
resources for this SoSpotLightDragger class. They are detailed below in
the DRAGGER RESOURCE section. You can make your program use different
default resources for the parts by copying the file
/usr/share/data/draggerDefaults/spotLightDragger.iv into your own
directory, editing the file, and then setting the environment variable
SO_DRAGGER_DIR to be a path to that directory.
FIELDS
SoSFRotation rotation
Orientation of the rotating part (an arrow by default).
SoSFVec3f translation
Position of the dragger.
SoSFFloat angle
Angle between center and edge of beam.
Page 4SoSpotLightDragger(3IV)FUNCTIONSSoSpotLightDragger * SoSpotLtDragCreate()
Constructor.
const SoNodekitCatalog * SoSpotLtDragGetClassNkitCat()
Returns an SoNodekitCatalog for this class
SoType SoSpotLtDragGetClassTypeId()
Returns type identifier for this class.
CATALOG PARTS
_________________________________________________________________
All parts
NULL by
Part Name Part Type Default Type Default
callbackList NodeKitListPart -- yes
material Material -- yes
translator DragPointDragger -- yes
rotator RotateSphericalDragger -- yes
beamPlacement Translation -- yes
beamScale Scale -- yes
beam Separator -- yes
beamActive Separator -- yes
_________________________________________________________________
|
|
________________________________________________________________
Extra information for list parts from above table
Part Name Container Type Permissible Types
Callback, EventCallback
callbackList Separator
________________________________________________________________
|
|
DRAGGER RESOURCES
Resource: spotLightBeam
Part: beam
Appearance: wire-frame cone with no SoMaterial node
Description: picking this initiates dragging of the beam angle. The
beam inherits colors from the material part, just
like the stationary version of the sun shape.
Resource: spotLightBeamActive
Part: beamActive
Appearance: yellow wire-frame cone
Description: displayed during dragging of the beam angle.
Resource: spotLightBeamPlacement
Part: beamPlacement
Appearance: translation of (0,0,-1)
Description: This translation node moves the beam parts relative to
the rest of the dragger. In this case, moving by
Page 5SoSpotLightDragger(3IV)
(0,0,-1) slides the cone outward along rotator part
toward its arrow-head. The distance chosen places the
apex of the cone on the surface of the sun shape.
Resource: spotLightRotatorRotator
Part: rotator.rotator
Appearance: white arrow that goes through the sun
Description: picking this begins rotation of the arrow about the
sun-shape
Resource: spotLightRotatorRotatorActive
Part: rotator.rotatorActive
Appearance: yellow arrow that goes through the sun
Description: displayed while the arrow is being rotated
Resource: spotLightRotatorFeedback
Part: rotator.feedback
Appearance: empty Separator
Description: this disables display of the axes that a
rotateSpherical dragger uses by default
Resource: spotLightRotatorFeedbackActive
Part: rotator.feedbackActive
Appearance: empty Separator
Description: this disables display of the axes that a
rotateSpherical dragger uses by default
Resource: spotLightOverallMaterial
Part: material
Appearance: white. half strength emissive, half strength diffuse
Description: sets material for the sun shape when stationary.
Resource for the moving sun,
spotLightTranslatorPlaneTranslatorActive, contains a
yellow material for highlighting.
Resource: spotLightTranslatorPlaneTranslator
Parts: translator.yzTranslator.translator
translator.xzTranslator.translator
translator.xyTranslator.translator
Appearance: sun shape with no material
Description: picking these parts initiates dragging by the yz, xz,
and xy planar draggers respectively.
Resource: spotLightTranslatorPlaneTranslatorActive
Parts: translator.yzTranslator.translatorActive
translator.xzTranslator.translatorActive
translator.xyTranslator.translatorActive
Appearance: yellow sun shape
Description: shown during planar dragging in the yz, xz, and xy
planes respectively.
Resource: spotLightTranslatorLineTranslator
Page 6SoSpotLightDragger(3IV)
Parts: translator.xTranslator.translator
translator.yTranslator.translator
translator.zTranslator.translator
Appearance: white cylinder
Description: picking these parts initiates dragging in the x, y, and
z linear draggers respectively.
Resource: spotLightTranslatorLineTranslatorActive
Parts: translator.xTranslator.translatorActive
translator.yTranslator.translatorActive
translator.zTranslator.translatorActive
Appearance: yellow cylinder
Description: shown during linear dragging in the x, y, and z
directions respectively.
FILE FORMAT/DEFAULTS
SpotLightDragger {
renderCaching AUTO
boundingBoxCaching AUTO
renderCulling AUTO
pickCulling AUTO
isActive FALSE
rotation 0 0 1 0
translation 0 0 0
angle 1
callbackList NULL
material <spotLightOverallMaterial resource>
translator DragPointDragger {
}
rotator RotateSphericalDragger {
}
beamPlacement <spotLightBeamPlacement resource>
beamScale Scale {
scaleFactor 0.841471 0.841471 0.540302 }
beam <spotLightBeam resource>
beamActive <spotLightBeamActive resource>
rotator.rotator <spotLightRotatorRotator resource>
rotator.rotatorActive <spotLightRotatorRotatorActive resource>
rotator.feedback <spotLightRotatorFeedback resource>
rotator.feedbackActive <spotLightRotatorFeedbackActive resource>
translator.yzTranslator.translator <spotLightTranslatorPlaneTranslator resource>
translator.xzTranslator.translator <spotLightTranslatorPlaneTranslator resource>
translator.xyTranslator.translator <spotLightTranslatorPlaneTranslator resource>
translator.yzTranslator.translatorActive <spotLightTranslatorPlaneTranslatorActive resource>
translator.xzTranslator.translatorActive <spotLightTranslatorPlaneTranslatorActive resource>
translator.xyTranslator.translatorActive <spotLightTranslatorPlaneTranslatorActive resource>
translator.xTranslator.translator <spotLightTranslatorLineTranslator resource>
translator.yTranslator.translator <spotLightTranslatorLineTranslator resource>
Page 7SoSpotLightDragger(3IV)
translator.zTranslator.translator <spotLightTranslatorLineTranslator resource>
translator.xTranslator.translatorActive <spotLightTranslatorLineTranslatorActive resource>
translator.yTranslator.translatorActive <spotLightTranslatorLineTranslatorActive resource>
translator.zTranslator.translatorActive <spotLightTranslatorLineTranslatorActive resource>
}
SEE ALSO
SoInteractionKit, SoDragger, SoCenterballDragger,
SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger,
SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger,
SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger,
SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger,
SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger,
SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger,
SoTranslate2Dragger
Page 8
