SOPOINTLIGHTDRAGGER(3iv)

💖 SoPointLightDragger — it's giving dragger (3IV) 💖

okay bestie so this is the manual page for SoPointLightDragger(3IV), and no cap it's a whole vibe. sit down, grab a strawberry, let's get into it 🍓✨

---

✨ NAME ✨

SoPointLightDragger — a sun-shaped icon you can translate in 3D by dragging with the mouse ☀️🖱️

---

🦋 INHERITS FROM 🦋

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

yes she has a whole family tree and every single one of them ate 💅

---

🌸 SYNOPSIS 🌸

#include <Inventor/draggers/SoPointLightDragger.h>

   Fields from class SoPointLightDragger:

SoSFVec3f           translation

   Fields from class SoDragger:

SoSFBool            isActive

   Fields from class SoInteractionKit:

SoSFEnum            renderCaching
SoSFEnum            boundingBoxCaching
SoSFEnum            renderCulling
SoSFEnum            pickCulling

   Parts from class SoBaseKit:

(SoNodeKitListPart)  callbackList

   Methods from class SoPointLightDragger:

                      SoPointLightDragger()
static const SoNodekitCatalog *
                      getClassNodekitCatalog() const
static SoType       getClassTypeId()

   Methods from class SoDragger:

void                addStartCallback(SoDraggerCB *f, void *userData =
                         NULL)
void                removeStartCallback(SoDraggerCB *f, void *userData =
                         NULL)
void                addMotionCallback(SoDraggerCB *f, void *userData =
                         NULL)
void                removeMotionCallback(SoDraggerCB *f, void *userData =
                         NULL)
void                addFinishCallback(SoDraggerCB *f, void *userData =
                         NULL)
void                removeFinishCallback(SoDraggerCB *f, void *userData =
                         NULL)
void                addValueChangedCallback(SoDraggerCB *f, void *userData
                         = NULL)
void                removeValueChangedCallback(SoDraggerCB *f, void
                         *userData = NULL)
SbBool              enableValueChangedCallbacks()
void                setMinGesture(int pixels)
int                 getMinGesture() const
static void         setMinScale(float newMinScale)
static float        getMinScale()

   Methods from class SoInteractionKit:

virtual SbBool      setPartAsPath(const SbName &partName, SoPath
                         *surrogatePath )

   Methods from class SoBaseKit:

virtual const SoNodekitCatalog *
                         getNodekitCatalog() const
virtual SoNode *         getPart(const SbName &partName, SbBool
                              makeIfNeeded)
SbString                 getPartString(const SoBase *part)
virtual SoNodeKitPath *  createPathToPart(const SbName &partName, SbBool
                              makeIfNeeded, const SoPath *pathToExtend =
                              NULL)
virtual SbBool           setPart(const SbName &partName, SoNode *newPart)
SbBool                   set(char *partName, char *parameters)
SbBool                   set(char *nameValuePairs)
static SbBool            isSearchingChildren()
static void              setSearchingChildren(SbBool newVal)

   Methods from class SoNode:

void                setOverride(SbBool state)
SbBool              isOverride() const
SoNode *            copy(SbBool copyConnections = FALSE) const
virtual SbBool      affectsState() const
static SoNode *     getByName(const SbName &name)
static int          getByName(const SbName &name, SoNodeList &list)

   Methods from class SoFieldContainer:

void                setToDefaults()
SbBool              hasDefaultValues() const
SbBool              fieldsAreEqual(const SoFieldContainer *fc) const
void                copyFieldValues(const SoFieldContainer *fc, SbBool
                         copyConnections = FALSE)
void                get(SbString &fieldDataString)
virtual int         getFields(SoFieldList &resultList) const
virtual SoField *   getField(const SbName &fieldName) const
SbBool              getFieldName(const SoField *field, SbName &fieldName)
                         const
SbBool              isNotifyEnabled() const
SbBool              enableNotify(SbBool flag)

   Methods from class SoBase:

void                ref()
void                unref() const
void                unrefNoDelete() const
void                touch()
virtual SoType      getTypeId() const
SbBool              isOfType(SoType type) const
virtual void        setName(const SbName &name)
virtual SbName      getName() const

   Macros from class SoBaseKit:

SO_GET_PART(kit, partName, partClass)
SO_CHECK_PART(kit, partName, partClass)

like look at all those methods, she's thriving 😭💜

---

☀️ DESCRIPTION ☀️

so 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. periodt. 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 🎨

bestie listen. This is not a light source! It just looks like one. do not be fooled by the fit, okay, it's cosplay 🙈

if you actually want to move a light with this dragger, you've got two options:

1. 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 ✨
2. 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 info on how to use SoDragPointDragger, see its reference page, iykyk 📖) 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 — don't mix them up bestie, they're different girls 💅) 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 🎀

• SoSFVec3f translation — Position of the dragger. that's it, that's the whole field, she's simple and she's iconic 👑

---

💅 METHODS 💅

• SoPointLightDragger() — Constructor. the birth of a legend 😌
• static const SoNodekitCatalog * getClassNodekitCatalog() const — Returns an SoNodekitCatalog for this class.
• static SoType getClassTypeId() — Returns type identifier for this class.

---

👑 CATALOG PARTS 👑

all parts, all of them, no skips 🌈

• Part Name: callbackList — Part Type: NodeKitListPart — Default Type: -- — NULL by Default: yes
• Part Name: material — Part Type: Material — Default Type: -- — NULL by Default: yes
• Part Name: translator — Part Type: DragPointDragger — Default Type: -- — NULL by Default: yes

extra information for list parts from above table 🦋

• Part Name: callbackList — Container Type: Separator — Permissible Types: Callback, EventCallback

---

okay so that's part 1 and there's more coming so don't go anywhere bestie 🥺💖

🫶 DRAGGER RESOURCES 🫶

okay bestie, this is the resource lineup for the SoPointLightDragger — the parts that make the sun shape and the drag handles do their thing. no cap, here's every single one, no skipping. 💖

Resource: pointLightOverallMaterial

• Part: material
• Appearance: white. half strength emissive, half strength diffuse
• Description: sets material for the sun shape when stationary. the resource for the moving sun, pointLightTranslatorPlaneTranslatorActive, contains a yellow material for highlighting. ✨

Resource: pointLightTranslatorPlaneTranslator

• 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: pointLightTranslatorPlaneTranslatorActive

• 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: pointLightTranslatorLineTranslator

• 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: pointLightTranslatorLineTranslatorActive

• 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 🌈

this is the default config, literally the blueprint. copy it exact, bestie, because every field matters. 👑

       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 🌸

go check these out too, bestie — the whole dragger fam: 🫶

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

---

okay that's the whole page, bestie. source/version is SoPointLightDragger(3IV) and the date field in the footer is just empty (()), no cap. periodt. 💅✨