SoShadowCulling(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

✨ SoShadowCulling ✨

okay bestie, you found the SoShadowCulling(3) manpage and I'm genuinely so proud of you 🥹💖 this is a Coin node, it does one (1) thing, and it does it gorgeously. let's get into it, no cap.

🎀 NAME 🎀

SoShadowCulling — the SoShadowCulling class is a node for setting the shadow style on nodes. that's the whole vibe, that's the assignment, and she ate. 💅

🌸 SYNOPSIS 🌸

#include <Inventor/annex/FXViz/nodes/SoShadowCulling.h>

Inherits SoNode. yes bestie she's a node, she's in the family, it's giving legacy 🦋

💅 Public Types

  • enum Mode { AS_IS_CULLING = SoGLShadowCullingElement::AS_IS_CULLING, NO_CULLING = SoGLShadowCullingElement::NO_CULLING }

🦋 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, COIN_4_0 = 0x20000 }

🫶 Public Member Functions

  • virtual SoType getTypeId (void) const
  • SoShadowCulling (void)
  • virtual void GLRender (SoGLRenderAction *action)

🌈 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 doAction (SoAction *action)
  • virtual void GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void handleEvent (SoHandleEventAction *action)
  • virtual void pick (SoPickAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void search (SoSearchAction *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)
  • SbUniqueId getNodeId (void) const
  • virtual SoChildList * getChildren (void) const
  • virtual void writeInstance (SoOutput *out)
  • virtual SoNode * addToCopyDict (void) const
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
  • 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 — returns TRUE if the type of this object is either of the same type or inherited from type.
  • 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 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static void initClasses (void)
  • static SbUniqueId 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class.
  • 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class.
  • 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)

👑 Public Attributes

  • SoSFEnum mode

🌸 Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoShadowCulling ()

🦋 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
  • virtual SoNotRec createNotRec (void)

⭐ Static Protected Member Functions

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

💫 Additional Inherited Members

🍓 Protected Types inherited from SoBase

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

🌸 Protected Attributes inherited from SoNode

  • SbUniqueId uniqueId

🌈 Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

🦋 Static Protected Attributes inherited from SoNode

  • static SbUniqueId nextUniqueId = 1
  • static int nextActionMethodIndex = 0

💖 Detailed Description 💖

The SoShadowCulling class is a node for setting the shadow style on nodes.

(and yes, she said it in the NAME section too. it's not a copy-paste situation, it's an icon being consistent 💅)

FILE FORMAT/DEFAULTS:

ShadowCulling {
    mode AS_IS_CULLING
}

Since

Coin 2.5 🌈 (so she's been here a minute, lowkey a legend)

🎀 Member Enumeration Documentation 🎀

enum SoShadowCulling::Mode

Enumerates the available culling modes. okay so there are exactly two, and bestie they are choices:

Enumerator

  • AS_IS_CULLING — use the culling specified in the scene graph. (i.e. mind your own business, the scene graph already decided ✨)
  • NO_CULLING — render both back facing and front facing triangles into the shadow map. (we're doing the MOST, nothing gets skipped, she's committed 🫶)

🌸 Constructor & Destructor Documentation 🌸

SoShadowCulling::SoShadowCulling (void )

Constructor. she constructs. iconic behaviour honestly, no notes. 💖

SoShadowCulling::~SoShadowCulling () [protected], [virtual]

Destructor. protected and virtual — she's got layers, she's mysterious, she doesn't just let anyone call her 🧚

💖 MEMBER FUNCTION DOCUMENTATION 💖

okay bestie, this is the part where we actually meet the functions 👑 these are the methods hanging off SoShadowCulling, and yes, some of them are marked internal and you're just gonna have to respect that boundary. let's go one by one, no skipping, fr fr.

⭐ getClassTypeId ⭐

SoType SoShadowCulling::getClassTypeId(void)

[static]

This static method returns the SoType object associated with objects of this class. that's the whole assignment bestie, it's giving very "here is the class's little ID badge" and honestly? iconic. 💅

🦋 getTypeId 🦋

SoType SoShadowCulling::getTypeId(void) const

[virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is what the library uses for runtime type checking and "downward" casting — so like, when something needs to figure out what it actually is at runtime instead of what it was declared as. main character energy tbh.

Implements SoBase.

🎀 getFieldDataPtr 🎀

const SoFieldData ** SoShadowCulling::getFieldDataPtr(void)

[static], [protected]

bestie listen 😭 this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. so like, it's there, it's vibing, but it's not for you, iykyk.

Returns the SoFieldData class which holds information about fields in this node. 🌸

💜 getFieldData 💜

const SoFieldData * SoShadowCulling::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, no drama, just a polite nothing. 🙈

Reimplemented from SoFieldContainer.

✨ initClass ✨

void SoShadowCulling::initClass(void)

[static]

okay so the docs literally give us zero description here — no tea, no explanation, just the signature sitting there looking cute. so that's what we're working with. 🫶

🔥 GLRender 🔥

void SoShadowCulling::GLRender(SoGLRenderAction * action)

[virtual]

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes that influence the rendering state in any way, or that want to throw geometry primitives at OpenGL, override this method. so like, if your node has opinions about the render state or wants to yeet some geometry at OpenGL, this is the override for you. slay. 🔥

Reimplemented from SoNode.

🍓 MEMBER DATA DOCUMENTATION 🍓

SoSFEnum SoShadowCulling::mode

Sets the culling mode. Default is AS_IS_CULLING. that's the default, periodt — don't come for me, that's just what it is. ⭐

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code.

and that's a wrap on SoShadowCulling(3) bestie 💖 this whole thing came from Coin, version 4.0.10, stamped Thu Jun 25 2026 00:00:00 — so like, go forth and cull those shadows, you absolute icon 🌈🎀✨

📦 where this page comes from