SoDirectionalLightManip(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoDirectionalLightManip 💖

okay bestie, welcome to SoDirectionalLightManip(3) from the Library Functions Manual — yes that's the manual name, and yes it's a mouthful, we move.

🌸 NAME 🌸

SoDirectionalLightManip — the class that exists purely so you can manipulate SoDirectionalLight nodes. that's it. that's the whole job. iconic behavior honestly 💅

✨ SYNOPSIS ✨

#include <Inventor/manips/SoDirectionalLightManip.h>
Inherits SoDirectionalLight.

🫶 Public Member Functions

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

  • SoDirectionalLight (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 SoDirectionalLight

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

🎀 Protected Member Functions inherited from SoDirectionalLight

  • virtual ~SoDirectionalLight ()

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

🍓 Static Protected Member Functions inherited from SoDirectionalLight

  • 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 * directionFieldSensor
  • 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 SoDirectionalLight:

  • SoSFVec3f direction

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 like. SoDirectionalLightManip is the class used to manipulate SoDirectionalLight nodes. that's the whole vibe, bestie ✨

here's the lore: a manipulator gets used 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 "borrow your fit and give it back better" energy, honestly 🫶

🧚 Constructor & Destructor Documentation 🧚

SoDirectionalLightManip::SoDirectionalLightManip (void )

the constructor sets up the internal SoDiretionalLightDragger that this manipulator uses. (yes that spelling is exactly what's written, no cap, don't come for me 💀)

References: children, colorFieldSensor, directionFieldSensor, fieldSensorCB(), setDragger(), and SoDirectionalLightManip().

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

SoDirectionalLightManip::~SoDirectionalLightManip () [protected]

destructor. cleans up the resources the manipulator was using. say bye, bestie 🎀

References: children, colorFieldSensor, directionFieldSensor, and setDragger().

part 1 done, more coming — don't go anywhere 💖

✨ Member Function Documentation ✨

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

okay so this one hands you back the type identification of any object derived from a class that inherits SoBase 🫶. what's it 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 whatever — this method needs to be overridden in all subclasses. periodt. that's typically done as part of setting up the full type system for extension classes, and it's 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 info on writing Coin extensions, go check the class documentation of the toplevel superclasses for the various class groups 📚.

Reimplemented from SoDirectionalLight.

const SoFieldData * SoDirectionalLightManip::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? it returns NULL. that's it, that's the whole vibe.

Reimplemented from SoDirectionalLight.

References SoDirectionalLightManip().

SoDragger * SoDirectionalLightManip::getDragger(void)

return pointer to internal SoDirectionalLightDragger dragger 👑.

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

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

SbBool SoDirectionalLightManip::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. slay.

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

SbBool SoDirectionalLightManip::replaceManip(SoPath * path, SoDirectionalLight * newone) const

replaces this manipulator from the position specified by path with newnode 🌸. and if newnode is NULL? an SoDirectionalLight will be created for you, no stress 💖.

References SoDirectionalLight::SoDirectionalLight(), and SoDirectionalLightManip().

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

this function performs the typical operation of a node for any action ⭐.

Reimplemented from SoNode.

References children, and SoAction::getPathCode().

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

void SoDirectionalLightManip::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. it's giving very helpful honestly.

Reimplemented from SoLight.

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

void SoDirectionalLightManip::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 want to throw geometry primitives at OpenGL, override this method. main character energy fr fr.

Reimplemented from SoDirectionalLight.

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

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

action method for the SoGetBoundingBoxAction 🌈.

calculates 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. math but make it cute ✨.

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 SoDirectionalLightManip::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 SoDirectionalLightManip::handleEvent(SoHandleEventAction * action) [virtual]

action method for SoHandleEventAction 💜.

inspects the event data from action, and processes it if it's something which this node should react to. very "if it's not about me i'm not responding" of it ngl.

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

Reimplemented from SoNode.

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

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

action method for SoPickAction 🍓.

does common processing for SoPickAction action instances.

Reimplemented from SoNode.

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

void SoDirectionalLightManip::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. no partial credit, bestie 😭.

See also: SoSearchAction

Reimplemented from SoNode.

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

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

returns the children of this node 💖. and this node only has the dragger as a child — that's the whole squad, one member, iconic.

Reimplemented from SoNode.

References children.

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

set dragger to be used by this manipulator 💅.

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

Referenced by copyContents(), SoDirectionalLightManip(), and ~SoDirectionalLightManip().

void SoDirectionalLightManip::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 — 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 that 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 SoDirectionalLightManip().

void SoDirectionalLightManip::transferFieldValues(const SoDirectionalLight * from, SoDirectionalLight * to) [static], [protected]

copies field values ✨.

References SoLight::color, SoDirectionalLight::direction, and SoDirectionalLight::SoDirectionalLight().

Referenced by replaceNode().

void SoDirectionalLightManip::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 🙈

convert from matrix to direction 🔄.

References SoDirectionalLight::direction, SoDragger::getMotionMatrix(), SbMatrix::multDirMatrix(), SoDebugError::post(), and SoDirectionalLightManip().

Referenced by setDragger().

void SoDirectionalLightManip::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 💀

References SoLight::color, SoMaterial::diffuseColor, SoDirectionalLight::direction, SoMaterial::emissiveColor, getDragger(), SoDragger::getMotionMatrix(), SoMField::getNum(), SoBaseKit::getPart(), SbMatrix::getTransform(), SoDragger::setMotionMatrix(), SoInteractionKit::setPart(), SbMatrix::setTransform(), SbRotation::setValue(), and SoDirectionalLightManip().

Referenced by replaceNode(), setDragger(), and SoDirectionalLightManip().

🎀 Member Data Documentation 🎀

SoFieldSensor* SoDirectionalLightManip::directionFieldSensor [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 SoDirectionalLightManip(), and ~SoDirectionalLightManip().

SoFieldSensor* SoDirectionalLightManip::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 SoDirectionalLightManip(), and ~SoDirectionalLightManip().

SoChildList* SoDirectionalLightManip::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(), SoDirectionalLightManip(), and ~SoDirectionalLightManip().

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code. (yes bestie, the robots wrote the docs, we just made them cute 🫶)

and that's a wrap on the whole page, no cap 💅 that footer energy — Coin, Version 2.5.0, SoDirectionalLightManip(3) — stay iconic, go forth and manipulate those directional lights ✨👑🎀

📦 where this page comes from