man SoPointLightDragger () - sun-shaped icon you can translate in 3D by dragging with the mouse

NAME

SoPointLightDragger - sun-shaped icon you can translate in 3D by dragging with the mouse

INHERITS FROM

SoBase > SoFieldContainer > SoNode > SoBaseKit > SoInteractionKit > SoDragger > SoPointLightDragger

SYNOPSIS

#include <Inventor/draggers/SoPointLightDragger.h> Fields from class SoPointLightDragger: c } c } translation Fields from class SoDragger: c } c } isActive Fields from class SoInteractionKit: c } c } renderCaching

c } c } boundingBoxCaching

c } c } renderCulling

c } c } pickCulling Parts from class SoBaseKit: c } c } callbackList Methods from class SoPointLightDragger: c } c } SoPointLightDragger()

c } c } getClassNodekitCatalog() const

c } c } getClassTypeId() Methods from class SoDragger: c } c } addStartCallback(SoDraggerCB *f, void *userData = NULL)

c } c } removeStartCallback(SoDraggerCB *f, void *userData = NULL)

c } c } addMotionCallback(SoDraggerCB *f, void *userData = NULL)

c } c } removeMotionCallback(SoDraggerCB *f, void *userData = NULL)

c } c } addFinishCallback(SoDraggerCB *f, void *userData = NULL)

c } c } removeFinishCallback(SoDraggerCB *f, void *userData = NULL)

c } c } addValueChangedCallback(SoDraggerCB *f, void *userData = NULL)

c } c } removeValueChangedCallback(SoDraggerCB *f, void *userData = NULL)

c } c } enableValueChangedCallbacks()

c } c } setMinGesture(int pixels)

c } c } getMinGesture() const

c } c } setMinScale(float newMinScale)

c } c } getMinScale() Methods from class SoInteractionKit: c } c } setPartAsPath(const SbName &partName, SoPath *surrogatePath ) Methods from class SoBaseKit: c } c } getNodekitCatalog() const

c } c } getPart(const SbName &partName, SbBool makeIfNeeded)

c } c } getPartString(const SoBase *part)

c } c } createPathToPart(const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend = NULL)

c } c } setPart(const SbName &partName, SoNode *newPart)

c } c } set(char *partName, char *parameters)

c } c } set(char *nameValuePairs)

c } c } isSearchingChildren()

c } c } setSearchingChildren(SbBool newVal) Methods from class SoNode: c } c } setOverride(SbBool state)

c } c } isOverride() const

c } c } copy(SbBool copyConnections = FALSE) const

c } c } affectsState() const

c } c } getByName(const SbName &name)

c } c } getByName(const SbName &name, SoNodeList &list) Methods from class SoFieldContainer: c } c } setToDefaults()

c } c } hasDefaultValues() const

c } c } fieldsAreEqual(const SoFieldContainer *fc) const

c } c } copyFieldValues(const SoFieldContainer *fc, SbBool copyConnections = FALSE)

c } c } get(SbString &fieldDataString)

c } c } getFields(SoFieldList &resultList) const

c } c } getField(const SbName &fieldName) const

c } c } getFieldName(const SoField *field, SbName &fieldName) const

c } c } isNotifyEnabled() const

c } c } enableNotify(SbBool flag) Methods from class SoBase: c } c } ref()

c } c } unref() const

c } c } unrefNoDelete() const

c } c } touch()

c } c } getTypeId() const

c } c } isOfType(SoType type) const

c } c } setName(const SbName &name)

c } c } getName() const Macros from class SoBaseKit: SO_GET_PART(kit, partName, partClass)

SO_CHECK_PART(kit, partName, partClass)

DESCRIPTION

SoPointLightDragger is a dragger that looks like a point light source, can be translated in three directions, and has a translation field that always reflects its position in local space. The point light dragger also has a special material part which can be used to make it take on the color of a light source. Remember: This is not a light source! It just looks like one. If you want to move a light with this dragger, you can either: [a] Use an SoPointLightManip, which is subclassed from SoLight. It creates one of these draggers and uses it as the interface to change the location of its light source (see the SoPointLightManip reference page). The manipulator also edits the material part of this dragger to match the color of light the manipulator is producing. [b] Use a field-to-field connection to connect the location of a light source from this dragger's translation field. This dragger contains an SoDragPointDragger, which you drag through 3-space using an integrated set of linear and planar draggers. (For detailed information on how to use SoDragPointDragger, see its reference page.) The point light dragger sets the planar translation parts of this dragPoint dragger with a new default that looks like a shining sun emanating rays of light (okay, so use your imagination). By changing the material part you can change the color of the sun shape, because the default part contains no SoMaterial nodes. This fact enables the SoPointLightManip (not the dragger, the manipulator) to color its dragger to match the color of the light it is emanating. Recall that a point light manip is derived from SoLight and creates a point light dragger to provide an interface and geometrical presence on screen. The manipulator also has a color field; when the light color changes, it changes the material part of its dragger so that they match. You can change the parts in any instance of this dragger using setPart(). The default part geometries are defined as resources for this SoPointLightDragger class. They are detailed in the Dragger Resources section of the online reference page for this class. You can make your program use different default resources for the parts by copying the file /usr/share/data/draggerDefaults/pointLightDragger.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

c } c } translation

Position of the dragger.

METHODS

c } c } SoPointLightDragger()

Constructor. c } c } getClassNodekitCatalog() const

Returns an SoNodekitCatalog for this class c } c } getClassTypeId()

Returns type identifier for this class.

CATALOG PARTS

box, tab(!); cb s s s lb lb lb lb lb lb lb lb l l l c. All parts !!!NULL by Part Name!Part Type!Default Type!Default

callbackList!NodeKitListPart!--!yes material!Material!--!yes translator!DragPointDragger!--!yes

box, tab(!); cb s s lb lb lbw(3) l l l. Extra information for list parts from above table Part Name!Container Type!Permissible Types

callbackList!Separator!T{ Callback, EventCallback T}

DRAGGER RESOURCES

.in 0n+.5i Resource: pointLightOverallMaterial

.in 0n+.5i Part: material

Appearance: white. half strength emissive, half strength diffuse

Description: sets material for the sun shape when stationary. Resource for the moving sun, pointLightTranslatorPlaneTranslatorActive, contains a yellow material for highlighting. .in 0n+.5i Resource: pointLightTranslatorPlaneTranslator

.in 0n+.5i 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. .in 0n+.5i Resource: pointLightTranslatorPlaneTranslatorActive

.in 0n+.5i 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. .in 0n+.5i Resource: pointLightTranslatorLineTranslator

.in 0n+.5i 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. .in 0n+.5i Resource: pointLightTranslatorLineTranslatorActive

.in 0n+.5i 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

PointLightDragger {
renderCaching	AUTO
boundingBoxCaching	AUTO
renderCulling	AUTO
pickCulling	AUTO
isActive	FALSE
translation	0 0 0
callbackList	NULL
material	<pointLightOverallMaterial resource>
translator	DragPointDragger {
}

translator.yzTranslator.translator <pointLightTranslatorPlaneTranslator resource> translator.xzTranslator.translator <pointLightTranslatorPlaneTranslator resource> translator.xyTranslator.translator <pointLightTranslatorPlaneTranslator resource> translator.yzTranslator.translatorActive <pointLightTranslatorPlaneTranslatorActive resource> translator.xzTranslator.translatorActive <pointLightTranslatorPlaneTranslatorActive resource> translator.xyTranslator.translatorActive <pointLightTranslatorPlaneTranslatorActive resource> translator.xTranslator.translator <pointLightTranslatorLineTranslator resource> translator.yTranslator.translator <pointLightTranslatorLineTranslator resource> translator.zTranslator.translator <pointLightTranslatorLineTranslator resource> translator.xTranslator.translatorActive <pointLightTranslatorLineTranslatorActive resource> translator.yTranslator.translatorActive <pointLightTranslatorLineTranslatorActive resource> translator.zTranslator.translatorActive <pointLightTranslatorLineTranslatorActive resource> }

SEE ALSO

SoInteractionKit, SoDragger, SoCenterballDragger, SoDirectionalLightDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, SoTranslate2Dragger