SoCacheHint(3)

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

✨ SoCacheHint(3) ✨ — a Coin moment 💅

Hiii bestie, welcome to the manual page for SoCacheHint(3), straight outta Coin. She's niche, she's experimental, she's lowkey iconic, and we're gonna read her together. Grab a boba, this is part 1 of 2 🍓

🎀 NAME 🎀

SoCacheHint — the SoCacheHint class is a node containing hints about how to cache geometry. That's it, that's her whole thing. No cap. 💖

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoCacheHint.h>

Inherits SoNode.

🌸 Public Member Functions 🌸

  • virtual SoType getTypeId (void) const
  • SoCacheHint (void)
  • virtual void doAction (SoAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void pick (SoPickAction *action)

That's her whole personal squad of overrides, bestie. The rest she inherited, and we're getting to those rn. 🫶

💜 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 getMatrix (SoGetMatrixAction *action)
  • virtual void handleEvent (SoHandleEventAction *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) — Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. (the classic little setup ritual, we love her)

💫 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 🎀

  • SoSFFloat memValue
  • SoSFFloat gfxValue

the two actual fields, our leading ladies 💅

🔮 Protected Member Functions 🔮

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

🔮 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 🌈

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

🔐 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 SoCacheHint class is a node containing hints about how to cache geometry. (yes, same energy as the NAME section, she's consistent, we stan)

The SoCacheHint node is used to set up clues to the rendering subsystem about how Coin should cache vertex data.

Please note that this is an experimental class. The API might change a lot before/if it is included in any official Coin release. — so like, don't get too attached to the exact shape of her, bestie. She's still figuring herself out. 🫠

FILE FORMAT/DEFAULTS:

CacheHint {
    memValue 0.5
    gfxValue 0.5
}

🎀 Constructor & Destructor Documentation 🎀

💜 SoCacheHint::SoCacheHint (void ) 💜

Constructor. she's born ✨

💜 SoCacheHint::~SoCacheHint () [protected], [virtual] 💜

Destructor. she leaves the group chat 😭 (protected, so only the inner circle gets to do it)

💖 Member Function Documentation 💖

okay so bestie, this is the part where we meet all the member functions. no cap, they're literally the main characters of this class. let's go. 🫶

🌟 SoType SoCacheHint::getClassTypeId (void ) [static] 🌟

This static method returns the SoType object associated with objects of this class. it's giving type-identity realness, periodt. 💅

✨ SoType SoCacheHint::getTypeId (void ) const [virtual] ✨

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting. Implements SoBase. ngl, this is the runtime type-check + cast vibe check you need. 🦋

🔒 const SoFieldData ** SoCacheHint::getFieldDataPtr (void ) [static], [protected] 🔒

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. so if you're an app dev, you can lowkey ignore it, but it's still here, iconic.

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

🔐 const SoFieldData * SoCacheHint::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. Reimplemented from SoFieldContainer. it's giving field-data pointer realness. 🌸

⚡ void SoCacheHint::doAction (SoAction * action) [virtual] ⚡

This function performs the typical operation of a node for any action. Reimplemented from SoNode. basically the default action behavior, slay. 💫

🎨 void SoCacheHint::GLRender (SoGLRenderAction * action) [virtual] 🎨

Action method for the SoGLRenderAction. This is called during rendering traversals. Nodes influencing the rendering state in any way or want to throw geometry primitives at OpenGL override this method. Reimplemented from SoNode. it's giving render traversal energy, no cap. 🔥

📞 void SoCacheHint::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 SoNode. iykyk. 🧚

📦 void SoCacheHint::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 calculate their bounding box also override this method to change the relevant state variables. Reimplemented from SoNode. literally bounding box math, bestie. 📐

🎯 void SoCacheHint::pick (SoPickAction * action) [virtual] 🎯

Action method for SoPickAction. Does common processing for SoPickAction action instances. Reimplemented from SoNode. pick pick pick, periodt. 🍓

💾 Member Data Documentation 💾

🧠 SoSFFloat SoCacheHint::memValue 🧠

Sets the value for main memory usage. Should be a number between 0 and 1. A higher value will use more memory for caching. Default value is 0.5 — so like, turn it up if you want more main-memory cache, but stay in the 0-to-1 lane, bestie. ✨

🖥️ SoSFFloat SoCacheHint::gfxValue 🖥️

Sets the value for gfx memory usage. Should be a number between 0 and 1. A higher value will use more memory for caching. Default value is 0.5 — same vibe, but for gfx memory. default is literally 0.5. 💜

✍️ Author ✍️

Generated automatically by Doxygen for Coin from the source code.

and that's the whole page, bestie! 🫶 this one came from Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's literally SoCacheHint(3). slay, bye! 💅✨

📦 where this page comes from