SoPointLightManip(3)

📦 version 3.1.3, in fedora 43, fedora 44

✨ NAME ✨

SoPointLightManip(3) — straight outta the Library Functions Manual, bestie. The SoPointLightManip class is used to manipulate point light nodes. 💡💅

🎀 SYNOPSIS 🎀

#include <Inventor/manips/SoPointLightManip.h>

Inherits SoPointLight. (Yes queen, it's a light that you can actually mess with — the whole point is that you swap it into the graph and drag stuff around. More on that below. 🦋)

💖 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=FALSE) 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=FALSE)
  • 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 *input)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
  • SbBool getIsBuiltIn (void) const
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) 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 cleanupClass (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 *input, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *input)

💅 Protected Member Functions 💅

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoPointLightManip (void)
  • 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)
  • virtual ~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,
    COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000 }

🌟 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 = 1
  • static int nextActionMethodIndex = 0

💫 Detailed Description 💫

The SoPointLightManip class is used to manipulate point light nodes. 🎯

Okay so here's the tea: a manipulator does its thing by replacing the node you want to edit in the graph with the manipulator itself. Draggers are what actually do the manipulating. And when the manipulation is finished? The node gets put back into the graph, replacing the manipulator. It's giving swap, slay, swap back. 🔥👑

🎀 Constructor & Destructor Documentation 🎀

SoPointLightManip::SoPointLightManip (void )

The constructor. Creates a default dragger. ✨

SoPointLightManip::~SoPointLightManip (void ) [protected], [virtual]

The destructor. 💀

💖 Member Function Documentation 💖

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

Okay bestie, this one is the type ID girlie. It hands you back the type identification of any object derived from SoBase, and the whole reason she exists is for run-time type checking and "downward" casting (iykyk).

Usage example, straight up:

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

Now for the application programmers who wanna extend the library with new nodes, engines, nodekits, draggers or whatever else — this method needs to be overridden in all subclasses. That's normally done as part of setting up the full type system for extension classes, which usually happens via the pre-defined macros you can get 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. 🌈

Want 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 no fields present? She returns NULL. Periodt. 💅

Reimplemented from SoPointLight.

SoDragger * SoPointLightManip::getDragger (void )

Gives you back the current dragger. That's it, that's the whole job. 🫶

See also: setDragger()

SbBool SoPointLightManip::replaceNode (SoPath * path)

Replaces the node specified by path with this manipulator. The manipulator will copy the field data from the node, so it affects the state in exactly the same way as the node did. Glow-up via copy-paste, honestly. ✨

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

Replaces this manipulator from the position specified by path with newnode. And if newnode is NULL, don't stress — an SoPointLight will be created for you. 🎀

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

This function performs the typical operation of a node for any action. Any action. She's flexible like that. 💁♀️

Reimplemented from SoNode.

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

Action method for SoCallbackAction.

Basically she just 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. Sneaky little info pipeline, we love her. 🔍

Reimplemented from SoLight.

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

Action method for the SoGLRenderAction.

This gets called during rendering traversals. Nodes that influence the rendering state in any way — or who just wanna throw geometry primitives at OpenGL — override this method. Main character energy, honestly. 👑

Reimplemented from SoPointLight.

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

Action method for the SoGetBoundingBoxAction.

Calculates the bounding box and center coordinates for the node, then 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. Math girlie behavior. 📐

Nodes that influence how geometry nodes calculate their bounding box also override this method to change the relevant state variables.

Reimplemented from SoNode.

void SoPointLightManip::getMatrix (SoGetMatrixAction * action) [virtual]

Action method for SoGetMatrixAction.

Updates action by accumulating with the transformation matrix of this node (if any). If there isn't one, no biggie. 🦋

Reimplemented from SoNode.

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

Action method for SoHandleEventAction.

She inspects the event data from action, and processes it if it's something this node should react to. Not everything deserves a reaction, bestie — she's selective. 💅

Nodes that influence relevant state variables for how event handling is done also override this method.

Reimplemented from SoNode.

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

Action method for SoPickAction.

Does the common processing for SoPickAction action instances. Lowkey essential, highkey underrated. ✨

Reimplemented from SoNode.

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

Action method for SoSearchAction.

Compares the search criteria from the action to see if this node is a match. Searching happens by matching up all criteria set up in the SoSearchAction — and if any of the requested criteria is a miss, the search is not deemed successful for the node. All or nothing, no partial credit, sorry babe. 💀

See also: SoSearchAction

Reimplemented from SoNode.

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

Returns the children of this node. And fun fact — this node only has the dragger as a child. One (1) child, and it's the dragger. Simple life. 🍓

Reimplemented from SoNode.

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

The method can be used to replace the dragger with your own dragger. Customize away, bestie. 🎀

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.

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

🚨 For copying nodes from application code, you should not invoke this function directly. Call the SoNode::copy() function instead:
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.

void SoPointLightManip::transferFieldValues (const SoPointLight * from, SoPointLight * 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. That's the vibe. 💜

void SoPointLightManip::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.

void SoPointLightManip::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.

🧚 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.

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.

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.

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. Not a human, just a very hardworking little documentation robot. 🤖💖

And that's the whole page, bestie!! This little icon came from Coin, Version 3.1.3, dated as SoPointLightManip(3) — go forth and manipulate those point lights with confidence. Slay, take care, and remember: always call copyContents() upward to your superclass. 💅✨🦋

📦 where this page comes from