SoSpotLightManip(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoSpotLightManip 💖

okay bestie, welcome to the Library Functions Manual page for SoSpotLightManip — yes, that's the (3) situation, that's the section, we love her 🎀

✨ NAME ✨

SoSpotLightManip — the class that exists to manipulate spot light nodes. that's it, that's the job, and she's iconic for it 💅

✨ SYNOPSIS ✨

first things first, the include, do not forget the include bestie:

#include <Inventor/manips/SoSpotLightManip.h>

She inherits from SoSpotLight. the way that she is literally a spot light but with ✨extra✨

🫶 Public Member Functions

virtual SoType getTypeId (void) const
SoSpotLightManip (void)
SoDragger * getDragger (void)
SbBool replaceNode (SoPath *p)
SbBool replaceManip (SoPath *p, SoSpotLight *newone) const
virtual void doAction (SoAction *action)
virtual void callback (SoCallbackAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void pick (SoPickAction *action)
virtual void search (SoSearchAction *action)
virtual SoChildList * getChildren (void) const

🫶 Public Member Functions inherited from `SoSpotLight`

SoSpotLight (void)

🫶 Public Member Functions inherited from `SoNode`

look at this list, she's giving legacy, she's giving range:

void setOverride (const SbBool state)
SbBool isOverride (void) const
void setNodeType (const NodeType type)
NodeType getNodeType (void) const
virtual SoNode * copy (SbBool copyconnections=0) const
virtual SbBool affectsState (void) const
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void write (SoWriteAction *action)
virtual void audioRender (SoAudioRenderAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
virtual void startNotify (void)
virtual void notify (SoNotList *l)
uint32_t getNodeId (void) const
virtual void writeInstance (SoOutput *out)
virtual SoNode * addToCopyDict (void) const
virtual SoFieldContainer * copyThroughConnection (void) const

🫶 Public Member Functions inherited from `SoFieldContainer`

void setToDefaults (void)
SbBool hasDefaultValues (void) const
SbBool fieldsAreEqual (const SoFieldContainer *container) const
void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0)
SbBool set (const char *const fielddata)
void get (SbString &fielddata)
virtual int getFields (SoFieldList &l) const
virtual int getAllFields (SoFieldList &l) const
virtual SoField * getField (const SbName &name) const
virtual SoField * getEventIn (const SbName &name) const
virtual SoField * getEventOut (const SbName &name) const
SbBool getFieldName (const SoField *const field, SbName &name) const
SbBool enableNotify (const SbBool flag)
SbBool isNotifyEnabled (void) const
SbBool set (const char *fielddata, SoInput *in)
void get (SbString &fielddata, SoOutput *out)
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
SbBool getIsBuiltIn (void) const
void setUserData (void *userdata) const
void * getUserData (void) const

🫶 Public Member Functions inherited from `SoBase`

void ref (void) const
void unref (void) const
void unrefNoDelete (void) const
int32_t getRefCount (void) const
void touch (void)
SbBool isOfType (SoType type) const
virtual SbName getName (void) const
virtual void setName (const SbName &newname)
void addAuditor (void *const auditor, const SoNotRec::Type type)
void removeAuditor (void *const auditor, const SoNotRec::Type type)
const SoAuditorList & getAuditors (void) const
SbBool shouldWrite (void)
void assertAlive (void) const

🌟 Static Public Member Functions

static SoType getClassTypeId (void)
static void initClass (void)

🌟 Static Public Member Functions inherited from `SoSpotLight`

static SoType getClassTypeId (void)
static void initClass (void)

🌟 Static Public Member Functions inherited from `SoLight`

static SoType getClassTypeId (void)
static void initClass (void)

🌟 Static Public Member Functions inherited from `SoNode`

static uint32_t getCompatibilityTypes (const SoType &nodetype)
static SoType getClassTypeId (void)
static SoNode * getByName (const SbName &name)
static int getByName (const SbName &name, SoNodeList &l)
static void initClass (void)
static void initClasses (void)
static uint32_t getNextNodeId (void)
static int getActionMethodIndex (const SoType type)
static void getBoundingBoxS (SoAction *action, SoNode *node)
static void GLRenderS (SoAction *action, SoNode *node)
static void callbackS (SoAction *action, SoNode *node)
static void getMatrixS (SoAction *action, SoNode *node)
static void handleEventS (SoAction *action, SoNode *node)
static void pickS (SoAction *action, SoNode *node)
static void rayPickS (SoAction *action, SoNode *node)
static void searchS (SoAction *action, SoNode *node)
static void writeS (SoAction *action, SoNode *node)
static void audioRenderS (SoAction *action, SoNode *node)
static void getPrimitiveCountS (SoAction *action, SoNode *node)

🌟 Static Public Member Functions inherited from `SoFieldContainer`

static void initClass (void)
static SoType getClassTypeId (void)
static void initCopyDict (void)
static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy)
static SoFieldContainer * checkCopy (const SoFieldContainer *orig)
static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections)
static void copyDone (void)

🌟 Static Public Member Functions inherited from `SoBase`

static void initClass (void)
static SoType getClassTypeId (void)
static void addName (SoBase *const base, const char *const name)
static void removeName (SoBase *const base, const char *const name)
static void incrementCurrentWriteCounter (void)
static void decrementCurrentWriteCounter (void)
static SoBase * getNamedBase (const SbName &name, SoType type)
static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type)
static SbBool read (SoInput *in, SoBase *&base, SoType expectedtype)
static void setInstancePrefix (const SbString &c)
static void setTraceRefs (SbBool trace)
static SbBool getTraceRefs (void)
static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
static SbBool readRoute (SoInput *in)

🔒 Protected Member Functions

virtual const SoFieldData * getFieldData (void) const
~SoSpotLightManip ()
void setDragger (SoDragger *newdragger)
virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections)

🔒 Protected Member Functions inherited from `SoSpotLight`

virtual ~SoSpotLight ()

🔒 Protected Member Functions inherited from `SoLight`

SoLight (void)
virtual ~SoLight ()

🔒 Protected Member Functions inherited from `SoNode`

SoNode (void)
virtual ~SoNode ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)

🔒 Protected Member Functions inherited from `SoFieldContainer`

SoFieldContainer (void)
~SoFieldContainer ()

🔒 Protected Member Functions inherited from `SoBase`

SoBase (void)
virtual ~SoBase ()
virtual void destroy (void)
SbBool hasMultipleWriteRefs (void) const
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
void writeFooter (SoOutput *out) const
virtual const char * getFileFormatName (void) const

🧚 Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)
static void transferFieldValues (const SoSpotLight *from, SoSpotLight *to)
static void valueChangedCB (void *f, SoDragger *d)
static void fieldSensorCB (void *f, SoSensor *d)

🧚 Static Protected Member Functions inherited from `SoSpotLight`

static const SoFieldData ** getFieldDataPtr (void)

🧚 Static Protected Member Functions inherited from `SoLight`

static const SoFieldData ** getFieldDataPtr (void)

🧚 Static Protected Member Functions inherited from `SoNode`

static const SoFieldData ** getFieldDataPtr (void)
static void setNextActionMethodIndex (int index)
static int getNextActionMethodIndex (void)
static void incNextActionMethodIndex (void)
static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)

🧚 Static Protected Member Functions inherited from `SoBase`

static uint32_t getCurrentWriteCounter (void)
static void staticDataLock (void)
static void staticDataUnlock (void)

🍓 Protected Attributes

SoFieldSensor * locationFieldSensor
SoFieldSensor * directionFieldSensor
SoFieldSensor * angleFieldSensor
SoFieldSensor * colorFieldSensor
SoChildList * children

🍓 Protected Attributes inherited from `SoNode`

uint32_t uniqueId

🍓 Protected Attributes inherited from `SoFieldContainer`

SbBool isBuiltIn

🌈 Additional Inherited Members

Public Types inherited from `SoNode`

enum NodeType { INVENTOR = 0x0000, VRML1 = 0x0001, VRML2 = 0x0002, INVENTOR_1 = 0x0004, INVENTOR_2_0 = 0x0008, INVENTOR_2_1 = 0x0010, INVENTOR_2_5 = 0x0020, INVENTOR_2_6 = 0x0040, COIN_1_0 = 0x0080, COIN_2_0 = 0x0100, EXTENSION = 0x0200, COIN_2_2 = 0x0400, COIN_2_3 = 0x0800, COIN_2_4 = 0x1000, INVENTOR_5_0 = 0x2000, COIN_2_5 = 0x4000 }

Public Attributes inherited from `SoSpotLight`

SoSFVec3f location
SoSFVec3f direction
SoSFFloat dropOffRate
SoSFFloat cutOffAngle

Public Attributes inherited from `SoLight`

SoSFBool on
SoSFFloat intensity
SoSFColor color

Protected Types inherited from `SoBase`

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

Static Protected Attributes inherited from `SoNode`

static uint32_t nextUniqueId = 0
static int nextActionMethodIndex = 0

✨ Detailed Description ✨

SoSpotLightManip is the class used to manipulate spot light nodes. she's the handler, she's the manager, she's the one running the whole operation 💅

So how does a manipulator actually work? okay so boom: a manipulator is used by replacing the node you want to edit in the graph with the manipulator. Draggers are used to manipulate the node. And when the manipulation is finished, the node gets put back into the graph, replacing the manipulator. swap in, vibe, swap out — main character energy ✨

✨ Constructor & Destructor Documentation ✨

🎀 `SoSpotLightManip::SoSpotLightManip (void )`

The constructor sets up the internal SoSpotLightDragger used for manipulation. bestie it's building the little grabby guy so you can actually drag the light around 🫶

References angleFieldSensor, children, colorFieldSensor, directionFieldSensor, fieldSensorCB(), locationFieldSensor, setDragger(), and SoSpotLightManip().

Referenced by copyContents(), fieldSensorCB(), getFieldData(), replaceManip(), SoSpotLightManip(), and valueChangedCB().

🎀 `SoSpotLightManip::~SoSpotLightManip () [protected]`

Destructor. she's leaving, say bye 😭

References angleFieldSensor, children, colorFieldSensor, directionFieldSensor, locationFieldSensor, and setDragger().

💅 MEMBER FUNCTION DOCUMENTATION 💅

okay bestie, this is the big one — every member function, every reference, every "reimplemented from", all of it. no skips, no cap. let's get into it. 💖✨

`SoType SoSpotLightManip::getTypeId (void ) const` [virtual]

the moment you've been waiting for — this gives you the type identification of an object derived from a class that inherits SoBase. it's used for run-time type checking and "downward" casting, iykyk. 🔍

usage example, bestie:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
  else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
    SoGroup * group = (SoGroup *)node;  // safe downward cast, knows the type
  }
}

so if you're an application programmer wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. it's typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. 🛠️

for more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Reimplemented from: SoSpotLight.

`const SoFieldData * SoSpotLightManip::getFieldData (void ) const` [protected], [virtual]

returns a pointer to the class-wide field data storage object for this instance. if no fields are present, returns NULL. simple as that. 💅

Reimplemented from: SoSpotLight.

References: SoSpotLightManip().

`SoDragger * SoSpotLightManip::getDragger (void )`

returns pointer to internal dragger. that's it, that's the tweet. 🎯

References: children, SoBase::isOfType(), SoDebugError::post(), and SoNode::SoNode().

Referenced by: fieldSensorCB(), and setDragger().

`SbBool SoSpotLightManip::replaceNode (SoPath * path)`

replaces the node specified by path with this manipulator. the manipulator will copy the field data from the node, to make it affect the state in the same way as the node. no cap. 🔄

References: fieldSensorCB(), SoFullPath::getLength(), SoFullPath::getNodeFromTail(), SoBaseKit::getPart(), SoBaseKit::getPartString(), SoFullPath::getTail(), SoPath::getTail(), SoBase::isOfType(), SoDebugError::post(), SoBase::ref(), SoBaseKit::setPart(), SoNode::SoNode(), SoSpotLight::SoSpotLight(), transferFieldValues(), and SoBase::unrefNoDelete().

`SbBool SoSpotLightManip::replaceManip (SoPath * path, SoSpotLight * newone) const`

replaces this manipulator from the position specified by path with newnode. if newnode is NULL, an SoSpotLight will be created for you. 🪄

References: SoSpotLight::SoSpotLight(), and SoSpotLightManip().

`void SoSpotLightManip::doAction (SoAction * action)` [virtual]

this function performs the typical operation of a node for any action. it's the main character energy of action handling. 👑

Reimplemented from: SoNode.

References: children, and SoAction::getPathCode().

Referenced by: callback(), GLRender(), handleEvent(), pick(), and search().

`void SoSpotLightManip::callback (SoCallbackAction * action)` [virtual]

action method for SoCallbackAction. simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph. 📊

Reimplemented from: SoLight.

References: SoLight::callback(), and doAction().

`void SoSpotLightManip::GLRender (SoGLRenderAction * action)` [virtual]

action method for the SoGLRenderAction. this is called during rendering traversals. nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method. 💥

Reimplemented from: SoSpotLight.

References: doAction(), and SoSpotLight::GLRender().

`void SoSpotLightManip::getBoundingBox (SoGetBoundingBoxAction * action)` [virtual]

action method for the SoGetBoundingBoxAction. calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node. 📦

nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables.

Reimplemented from: SoNode.

References: children, SoNode::getBoundingBox(), SoGetBoundingBoxAction::getCenter(), SoAction::getPathCode(), SoGetBoundingBoxAction::isCenterSet(), SoGetBoundingBoxAction::resetCenter(), and SoGetBoundingBoxAction::setCenter().

`void SoSpotLightManip::getMatrix (SoGetMatrixAction * action)` [virtual]

action method for SoGetMatrixAction. updates action by accumulating with the transformation matrix of this node (if any). 🧮

Reimplemented from: SoNode.

References: children, and SoAction::getPathCode().

`void SoSpotLightManip::handleEvent (SoHandleEventAction * action)` [virtual]

action method for SoHandleEventAction. inspects the event data from action, and processes it if it is something which this node should react to. 👀

nodes influencing relevant state variables for how event handling is done also overrides this method.

Reimplemented from: SoNode.

References: doAction(), and SoNode::handleEvent().

`void SoSpotLightManip::pick (SoPickAction * action)` [virtual]

action method for SoPickAction. does common processing for SoPickAction action instances. 🎯

Reimplemented from: SoNode.

References: doAction(), and SoNode::pick().

`void SoSpotLightManip::search (SoSearchAction * action)` [virtual]

action method for SoSearchAction. compares the search criteria from the action to see if this node is a match. searching is done by matching up all criteria set up in the SoSearchAction — if any of the requested criteria is a miss, the search is not deemed successful for the node. 🔎

See also: SoSearchAction

Reimplemented from: SoNode.

References: doAction(), SoSearchAction::isFound(), and SoNode::search().

`SoChildList * SoSpotLightManip::getChildren (void ) const` [virtual]

this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. 🤫

returns the children of this node. this node only has the dragger as a child.

Reimplemented from: SoNode.

References: children.

`void SoSpotLightManip::setDragger (SoDragger * newdragger)` [protected]

set dragger to use for user interaction. 🕹️

References: SoDragger::addValueChangedCallback(), children, fieldSensorCB(), getDragger(), SoDragger::removeValueChangedCallback(), and valueChangedCB().

Referenced by: copyContents(), SoSpotLightManip(), and ~SoSpotLightManip().

`void SoSpotLightManip::copyContents (const SoFieldContainer * from, SbBool copyconnections)` [protected], [virtual]

makes a deep copy of all data of from into this instance, except external scenegraph references if copyconnections is FALSE. 🧬

this is the protected method that should be overridden by extension node / engine / dragger / whatever subclasses which needs to account for internal data that are not handled automatically.

for copying nodes from application code, you should not invoke this function directly, but rather call the SoNode::copy() function:

SoNode * mynewnode = templatenode->copy();

the same also goes for engines.

make sure that when you override the copyContents() method in your extension class that you also make it call upwards to it's parent superclass in the inheritance hierarchy, as copyContents() in for instance SoNode and SoFieldContainer does important work. it should go something like this:

void
MyCoinExtensionNode::copyContents(const SoFieldContainer * from,
                                  SbBool copyconnections)
{
  // let parent superclasses do their thing (copy fields, copy
  // instance name, etc etc)
  SoNode::copyContents(from, copyconnections);

  // [..then copy internal data..]
}

Reimplemented from: SoNode.

References: SoNode::copy(), SoFieldContainer::copyContents(), SoBase::isOfType(), setDragger(), and SoSpotLightManip().

`void SoSpotLightManip::transferFieldValues (const SoSpotLight * from, SoSpotLight * to)` [static], [protected]

this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. 🤐

copies field values.

References: SoLight::color, SoSpotLight::cutOffAngle, SoSpotLight::direction, SoSpotLight::location, and SoSpotLight::SoSpotLight().

Referenced by: replaceNode().

`void SoSpotLightManip::valueChangedCB (void * m, SoDragger * dragger)` [static], [protected]

this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. 🤐

updates the fields when the motion matrix changes.

References: SoSpotLight::cutOffAngle, SoSpotLight::direction, SoDragger::getMotionMatrix(), SbMatrix::getTransform(), SoBase::isOfType(), SoSpotLight::location, SbMatrix::multDirMatrix(), SoDebugError::post(), and SoSpotLightManip().

Referenced by: setDragger().

`void SoSpotLightManip::fieldSensorCB (void * m, SoSensor * d)` [static], [protected]

this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. 🤐

updates the dragger whenever a field is modified.

References: SoSpotLightDragger::angle, SoLight::color, SoSpotLight::cutOffAngle, SoMaterial::diffuseColor, SoSpotLight::direction, SoMaterial::emissiveColor, getDragger(), SoDragger::getMotionMatrix(), SoMField::getNum(), SoBaseKit::getPart(), SbMatrix::getTransform(), SoBase::isOfType(), SoSpotLight::location, SoDragger::setMotionMatrix(), SoInteractionKit::setPart(), SbMatrix::setTransform(), SbRotation::setValue(), and SoSpotLightManip().

Referenced by: replaceNode(), setDragger(), and SoSpotLightManip().

✨ MEMBER DATA DOCUMENTATION ✨

okay bestie, this is the part where we peek behind the curtain at the protected member data 👀 — and just so you know up front, every single one of these is flagged as internal to the library, which basically means "not for you, gorgeous, the library handles it." They're not likely to be of any interest to the application programmer. But we're nosy, so let's list them anyway 💅

`SoFieldSensor* SoSpotLightManip::locationFieldSensor` [protected]

This API member is considered internal to the library — it's not likely to be of interest to the application programmer, so don't stress about it, bestie 💖

It gets referenced by SoSpotLightManip(), and ~SoSpotLightManip().

`SoFieldSensor* SoSpotLightManip::directionFieldSensor` [protected]

Same energy, different sensor 🦋 — this API member is considered internal to the library, and it's not likely to be of interest to the application programmer.

It gets referenced by SoSpotLightManip(), and ~SoSpotLightManip().

`SoFieldSensor* SoSpotLightManip::angleFieldSensor` [protected]

yep, another one 🎀 — this API member is considered internal to the library, and it is not likely to be of interest to the application programmer.

It gets referenced by SoSpotLightManip(), and ~SoSpotLightManip().

`SoFieldSensor* SoSpotLightManip::colorFieldSensor` [protected]

the last of the sensor squad 🌈 — this API member is considered internal to the library, and it's not likely to be of interest to the application programmer.

It gets referenced by SoSpotLightManip(), and ~SoSpotLightManip().

`SoChildList* SoSpotLightManip::children` [protected]

and this one is the popular girl at the function party, fr fr 👑 — this API member is considered internal to the library, and it's not likely to be of interest to the application programmer.

It gets referenced by doAction(), getBoundingBox(), getChildren(), getDragger(), getMatrix(), setDragger(), SoSpotLightManip(), and ~SoSpotLightManip().

🌸 AUTHOR 🌸

Generated automatically by Doxygen for Coin from the source code. (yes, the docs wrote themselves, we're just here to make them cute 💅)

and that's a wrap on this one, bestie!! this lil' beauty is from Coin, Version 2.5.0, and it's the SoSpotLightManip(3) page — go forth and manipulate those spotlights, you absolute icon 🫶✨💖

📦 where this page comes from

fedora 43: Coin2-devel 2.5.0-52.fc43 · GPL-2.0-only
fedora 43: Coin2-devel 2.5.0-52.fc43 · GPL-2.0-only
fedora 44: Coin2-devel 2.5.0-54.fc44 · GPL-2.0-only
fedora 44: Coin2-devel 2.5.0-54.fc44 · GPL-2.0-only
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms

SoSpotLightManip(3)