SoResetTransform(3)

📦 version 3.1.3, in fedora 43, fedora 44

💅 NAME 💅

okay so bestie, welcome to SoResetTransform(3) — that's the Library Functions Manual entry, and the star of the show is the SoResetTransform class, a node type which makes it possible to "nullify" state during traversal. that's the whole personality. no notes. 🫶

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoResetTransform.h>

It inherits from SoTransformation, like a good little transformation-adjacent node. 🌸

🎀 Public Types

  • enum ResetType { TRANSFORM = 0x01, BBOX = 0x02 }

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 Member Functions

  • virtual SoType getTypeId (void) const
  • SoResetTransform (void)
  • 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 pick (SoPickAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *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 GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *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 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 SoTransformation

  • 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

  • SoSFBitMask whatToReset

🔒 Protected Member Functions

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

Protected Member Functions inherited from SoTransformation

  • SoTransformation (void)
  • virtual ~SoTransformation ()

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 SoTransformation

  • 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

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

okay so here's the tea: the SoResetTransform class is a node type which makes it possible to "nullify" state during traversal. yes, literally that. nullify. the state just evaporates mid-traversal. 💀

and why would you want that? because SoResetTransform is useful for setting up geometry in the scene graph which will not be influenced by the transformation nodes before it during traversal. so if some transformation way up the graph is trying to put its whole vibe onto your geometry, this node is like "not today bestie" and the geometry stays unbothered. main character energy, honestly. 👑

📄 FILE FORMAT/DEFAULTS:

ResetTransform {
    whatToReset TRANSFORM
}

🔍 MEMBER ENUMERATION DOCUMENTATION

enum SoResetTransform::ResetType

The different options for what to reset. you get to pick your flavor of reset, iykyk.

Enumerator:

  • TRANSFORM — resets the current model transformation. 🫧
  • BBOX — resets the current bounding box settings. 📦

🛠️ CONSTRUCTOR & DESTRUCTOR DOCUMENTATION

SoResetTransform::SoResetTransform (void )

Constructor. it makes a fresh new SoResetTransform, slay. ✨

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

Destructor. protected and virtual, so it's living its best life cleaning up. 🌸

💖 Member Function Documentation 💖

okay bestie, now we're getting into the actual member functions, and there are a lot of them, so buckle up 🎀

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

This is the method that hands you back the type identification of any object that inherits from SoBase. It's the whole run-time type-checking and "downward" casting situation. So like, if you've got a SoNode * and you're wondering if it's secretly a SoFile, this is your girl.

Usage example:

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

For application programmers who wanna extend the library with new nodes, engines, nodekits, draggers, or others: you gotta override this method in all your subclasses. It's 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 (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes), and so on. iykyk 💅

For more info on writing Coin extensions, check the class documentation of the toplevel superclasses for the various class groups.

🔁 Reimplemented from SoTransformation.

✨ const SoFieldData * SoResetTransform::getFieldData (void ) const [protected], [virtual] ✨

This one's giving you a pointer to the class-wide field data storage object for this instance. And if there are no fields present? It returns NULL, periodt.

🔁 Reimplemented from SoTransformation.

✨ void SoResetTransform::doAction (SoAction * action) [virtual] ✨

The basic "do the thing" for any action — this function performs the typical operation of a node for any action.

🔁 Reimplemented from SoNode.

✨ void SoResetTransform::callback (SoCallbackAction * action) [virtual] ✨

Action method for SoCallbackAction. It simply updates the state according to how the node behaves for the render action, so you — the application programmer — can use SoCallbackAction for extracting information about the scene graph. It's lowkey just vibe-matching the render action.

🔁 Reimplemented from SoNode.

✨ void SoResetTransform::GLRender (SoGLRenderAction * action) [virtual] ✨

Action method for the SoGLRenderAction. This is called during rendering traversals. If your node influences the rendering state in any way, or if it wants to throw geometry primitives at OpenGL, you override this method. main character energy only 👑

🔁 Reimplemented from SoNode.

✨ void SoResetTransform::getBoundingBox (SoGetBoundingBoxAction * action) [virtual] ✨

Action method for the SoGetBoundingBoxAction. It calculates the bounding box and center coordinates for the node, then modifies the action's values to encompass this node's bounding box and shifts the scene's center point more towards this node's. If your node influences how geometry nodes calculate their bounding box, you also override this to change the relevant state variables.

🔁 Reimplemented from SoNode.

✨ void SoResetTransform::getMatrix (SoGetMatrixAction * action) [virtual] ✨

Action method for SoGetMatrixAction. It updates the action by accumulating with the transformation matrix of this node (if there is one).

🔁 Reimplemented from SoNode.

✨ void SoResetTransform::pick (SoPickAction * action) [virtual] ✨

Action method for SoPickAction. It does the common processing for SoPickAction action instances.

🔁 Reimplemented from SoNode.

✨ void SoResetTransform::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual] ✨

Action method for the SoGetPrimitiveCountAction. It calculates the number of triangle, line segment, and point primitives for the node, and adds these to the counters of the action. If your node influences how geometry nodes calculate their primitive count, you also override this to change the relevant state variables.

🔁 Reimplemented from SoNode.

🌸 Member Data Documentation 🌸

💜 SoSFBitMask SoResetTransform::whatToReset

What this node instance should reset in the state when met during traversal. Default value is SoResetTransform::TRANSFORM. Don't forget it, bestie 💅

🎀 Author 🎀

Generated automatically by Doxygen for Coin from the source code.

and that's the tea! ☕ this page was brought to you by Coin, Version 3.1.3, and it's the SoResetTransform(3) manpage. no date on this one, but you get the vibe. slay 💖✨🦋

📦 where this page comes from