SoPointLightManip(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoPointLightManip(3) — Library Functions Manual, but make it fashion 💖

okay bestie, gather round, because today we're reading the manual page for SoPointLightManip, and it is lowkey iconic. this is SoPointLightManip(3) from the Library Functions Manual and we are going to get through every single line of it together. no skimming. no skipping. we eat the whole plate. 🍓

✨ NAME ✨

SoPointLightManip — the class that is used to manipulate point light nodes. it's giving "glow-up handler". 💡

🌸 SYNOPSIS 🌸

#include <Inventor/manips/SoPointLightManip.h>

Inherits SoPointLight. yes, it's a nepo baby, but a talented one. 👑

🫶 Public Member Functions

  • virtual SoType getTypeId (void) const
  • SoPointLightManip (void)
  • SoDragger * getDragger (void)
  • SbBool replaceNode (SoPath *path)
  • SbBool replaceManip (SoPath *path, SoPointLight *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 SoPointLight

  • SoPointLight (void)

🧬 Public Member Functions inherited from SoNode

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

  • 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
  • ~SoPointLightManip ()
  • void setDragger (SoDragger *newdragger)
  • virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections)

🧬 Protected Member Functions inherited from SoPointLight

  • virtual ~SoPointLight ()

🧬 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 SoPointLight *from, SoPointLight *to)
  • static void valueChangedCB (void *f, SoDragger *d)
  • static void fieldSensorCB (void *f, SoSensor *d)

🧬 Static Protected Member Functions inherited from SoPointLight

  • 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 * 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 SoPointLight

  • SoSFVec3f location

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 🦋

so the SoPointLightManip class is used to manipulate point light nodes. that's the whole job description, and it serves. ✨

a manipulator works by replacing the node you want to edit in the graph with the manipulator itself. Draggers are the little handles used to manipulate the node. when the manipulation is finished, the node gets put back into the graph, replacing the manipulator. it's like a substitute teacher that actually knows the material and then dips. 💅

🌟 Constructor & Destructor Documentation 🌟

SoPointLightManip::SoPointLightManip (void )

the constructor. creates a default dragger. 🎀

References children, colorFieldSensor, fieldSensorCB(), locationFieldSensor, setDragger(), and SoPointLightManip().

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

SoPointLightManip::~SoPointLightManip () [protected]

the destructor. say bye bestie. 😭

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

okay so that's part one and we are not done yet — more is coming, don't go anywhere 💖

💫 Member Function Documentation 💫

SoType SoPointLightManip::getTypeId (void ) const [virtual]

Okay so this one hands you the type identification of any object derived from a class that inherits SoBase. Bestie, this is literally how run-time type checking and "downward" casting work. Iconic behaviour, no cap.

Usage example:

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
  }
}

Now listen up if you're an application programmer wanting to extend the library with new nodes, engines, nodekits, draggers or whatever — this method needs to be overridden in all subclasses. That's not a suggestion, that's the vibe. You typically do it 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 (that's SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

For more info on writing Coin extensions, go read the class documentation of the toplevel superclasses for the various class groups. 💅

Reimplemented from SoPointLight.

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

Returns a pointer to the class-wide field data storage object for this instance. And if there are literally no fields present? It returns NULL. That's it, that's the whole deal.

Reimplemented from SoPointLight.

References: SoPointLightManip().

SoDragger * SoPointLightManip::getDragger (void )

Returns the current dragger. Simple as that. 🎀

See also: setDragger()

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

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

SbBool SoPointLightManip::replaceNode (SoPath * path)

Replaces the node specified by path with this manipulator. And the manipulator will copy the field data from the node, so it affects the state in the same way as the node did. Glow-up but make it seamless ✨

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

SbBool SoPointLightManip::replaceManip (SoPath * path, SoPointLight * newone) const

Replaces this manipulator from the position specified by path with newnode. And if newnode is NULL? A whole SoPointLight gets created for you. We love a convenience 🫶

References: SoPointLight::SoPointLight(), and SoPointLightManip().

void SoPointLightManip::doAction (SoAction * action) [virtual]

This function performs the typical operation of a node for any action. The whole main-character moment of node behaviour, honestly.

Reimplemented from SoNode.

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

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

void SoPointLightManip::callback (SoCallbackAction * action) [virtual]

Action method for SoCallbackAction.

It 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. Info extraction? Ate. 💜

Reimplemented from SoLight.

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

void SoPointLightManip::GLRender (SoGLRenderAction * action) [virtual]

Action method for the SoGLRenderAction.

This gets called during rendering traversals. Nodes influencing the rendering state in any way — or who just want to throw geometry primitives at OpenGL — override this method. Live your truth, throw the primitives 🔥

Reimplemented from SoPointLight.

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

void SoPointLightManip::getBoundingBox (SoGetBoundingBoxAction * action) [virtual]

Action method for the SoGetBoundingBoxAction.

It calculates the bounding box and center coordinates for the 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. Very "center of attention", very on brand.

Nodes influencing how geometry nodes calculate their bounding box also override 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 SoPointLightManip::getMatrix (SoGetMatrixAction * action) [virtual]

Action method for SoGetMatrixAction.

It updates action by accumulating with the transformation matrix of this node (if any). Math girlies rise 🧚

Reimplemented from SoNode.

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

void SoPointLightManip::handleEvent (SoHandleEventAction * action) [virtual]

Action method for SoHandleEventAction.

It inspects the event data from action, and processes it if it's something this node should react to. And yes — nodes influencing relevant state variables for how event handling is done also override this method. You know the drill by now.

Reimplemented from SoNode.

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

void SoPointLightManip::pick (SoPickAction * action) [virtual]

Action method for SoPickAction.

It does the common processing for SoPickAction action instances. Picking, but make it standard 🍓

Reimplemented from SoNode.

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

void SoPointLightManip::search (SoSearchAction * action) [virtual]

Action method for SoSearchAction.

It 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 — and if any of the requested criteria is a miss, then the search is not deemed successful for the node. One miss and it's over, no partial credit 😭

See also: SoSearchAction

Reimplemented from SoNode.

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

SoChildList * SoPointLightManip::getChildren (void ) const [virtual]

Returns the children of this node. And plot twist: this node only has the dragger as a child. Just the one. Minimalist queen 👑

Reimplemented from SoNode.

References: children.

void SoPointLightManip::setDragger (SoDragger * newdragger) [protected]

This method can be used to replace the dragger with your own dragger. Custom dragger? We love to see it 💖

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

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

void SoPointLightManip::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. Deep copy, no shortcuts.

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

For copying nodes from application code, you should not invoke this function directly — instead 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, you also make it call upwards to its parent superclass in the inheritance hierarchy, because 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: SoFieldContainer::copyContents(), getDragger(), SoBase::isOfType(), setDragger(), and SoPointLightManip().

void SoPointLightManip::transferFieldValues (const SoPointLight * from, SoPointLight * to) [static], [protected]

Heads up bestie: 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. That's the whole job description.

References: SoLight::color, SoPointLight::location, and SoPointLight::SoPointLight().

Referenced by: replaceNode().

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

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

References: SoDragger::getMotionMatrix(), SoPointLight::location, and SoPointLightManip().

Referenced by: setDragger().

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

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

References: SoLight::color, SoMaterial::diffuseColor, SoMaterial::emissiveColor, getDragger(), SoDragger::getMotionMatrix(), SoMField::getNum(), SoBaseKit::getPart(), SoPointLight::location, SoDragger::setMotionMatrix(), SoInteractionKit::setPart(), and SoPointLightManip().

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

🦋 Member Data Documentation 🦋

SoFieldSensor* SoPointLightManip::locationFieldSensor [protected]

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

Referenced by: SoPointLightManip(), and ~SoPointLightManip().

SoFieldSensor* SoPointLightManip::colorFieldSensor [protected]

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

Referenced by: SoPointLightManip(), and ~SoPointLightManip().

SoChildList* SoPointLightManip::children [protected]

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

Referenced by: doAction(), getBoundingBox(), getChildren(), getDragger(), getMatrix(), setDragger(), SoPointLightManip(), and ~SoPointLightManip().

🌈 Author 🌈

Generated automatically by Doxygen for Coin from the source code.

And that's the whole page, bestie — we did it 💖 This lovely lil' doc ships with Coin, Version 2.5.0, and it's filed under SoPointLightManip(3). Go forth and manipulate those point lights, you gorgeous genius. Periodt. 💅✨

📦 where this page comes from