SoCacheHint(3)

Bestie, welcome to the SoCacheHint(3) page from the Library Functions Manual. This is part 1, so buckle up. 💖

✨ NAME ✨

SoCacheHint — the SoCacheHint class is a node containing hints about how to cache geometry. It's literally the node that tells Coin how to remember vertex data, no cap. 💅

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoCacheHint.h>

Inherits SoNode.

💅 Public Member Functions 💅

Here's the main squad:

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)

💖 Public Member Functions inherited from SoNode 💖

These are the ones you get for free 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)
uint32_t 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
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)
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)

🎀 Public Attributes 🎀

SoSFFloat memValue
SoSFFloat gfxValue

🔒 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

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

🌈 Protected Types inherited from SoBase 🌈

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

🌈 Protected Attributes inherited from SoNode 🌈

uint32_t uniqueId

🌈 Protected Attributes inherited from SoFieldContainer 🌈

SbBool isBuiltIn

🌈 Static Protected Attributes inherited from SoNode 🌈

static uint32_t nextUniqueId = 1
static int nextActionMethodIndex = 0

💖 Detailed Description 💖

The SoCacheHint class is a node containing hints about how to cache geometry. It's giving "I know how to make your rendering faster". ✨

The SoCacheHint node is used to set up clues to the rendering subsystem about how Coin should cache vertex data. So like, it's the whisper network for your GPU. 🧠💅

Please note that this is an experimental class. The API might change a lot before/if it's included in any official Coin release. So don't get too attached, bestie. 😭

FILE FORMAT/DEFAULTS:

CacheHint {
    memValue 0.5
    gfxValue 0.5
}

🎀 Constructor & Destructor Documentation 🎀

SoCacheHint::SoCacheHint (void )

Constructor. It constructs the thing. Iconic behavior. 💅

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

Destructor. It's protected and virtual, so it's lowkey exclusive. 🫶

💫 MEMBER FUNCTION DOCUMENTATION 💫

okay bestie, this is where the actual functions live. buckle up 🎀

---

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

Returns the type identification of an object derived from a class inheriting SoBase. Basically it's the little name tag your object wears so the library can do run-time type checking and "downward" casting. no cap, this is the moment.

Usage example:

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

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. it's not optional, bestie, it's giving required 💅

This is typically done 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. the macros are literally doing the most so you don't have to 🫶

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups. iykyk.

Implements SoBase.

---

const SoFieldData * SoCacheHint::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 SoFieldContainer.

---

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

This function performs the typical operation of a node for any action. it's the general-purpose entrance, the main character of action handling ✨

Reimplemented from SoNode.

---

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 who wants to throw geometry primitives at OpenGL, override this method. so if your node has opinions about pixels, this is where you speak up 💅

Reimplemented from SoNode.

---

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. it's giving "quietly observe and report" energy 🙈

Reimplemented from SoNode.

---

void SoCacheHint::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. basically it's nudging the scene's center of gravity toward itself, main character behavior fr fr.

Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables.

Reimplemented from SoNode.

---

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

Action method for SoPickAction. 🎯

Does common processing for SoPickAction action instances.

Reimplemented from SoNode.

---

🌸 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. ⭐

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

both default to 0.5, bestie — so if you don't touch anything, you get the balanced middle-of-the-road caching vibe. don't come for me, that's just what the docs say 💖

---

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code. (yes, a robot wrote it. and it ate. 💅)

---

and that's the whole page, bestie — you made it to the end 🎉 this was Coin, Version 3.1.3, page SoCacheHint(3), and honestly? iconic. go forth and cache responsibly 🫶✨💖