SoResetTransform(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoResetTransform(3) 💖

Library Functions Manual ✨ okay bestie, buckle up, because today we're reading the SoResetTransform(3) page and it's genuinely one of the most underrated little nodes in Coin/Inventor. it's giving "invisible reset button for your scene graph". no cap. 🦋

✨ NAME ✨

SoResetTransform — the class that's a node type which makes it possible to "nullify" state during traversal. 🫶

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoResetTransform.h>

Inherits SoTransformation.

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

🌈 Public Member Functions

virtual SoType getTypeId (void) const — the classic "who am I really" type-ID getter, virtual as always.
SoResetTransform (void) — constructor, hi bestie.
virtual void doAction (SoAction *action) — the general action dispatcher.
virtual void callback (SoCallbackAction *action) — handles callback actions.
virtual void GLRender (SoGLRenderAction *action) — handles GL render actions.
virtual void getBoundingBox (SoGetBoundingBoxAction *action) — handles bounding-box queries.
virtual void getMatrix (SoGetMatrixAction *action) — handles matrix queries.
virtual void pick (SoPickAction *action) — handles picking.
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — counts primitives, iconic behaviour honestly.

💜 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 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=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) — grab the class type ID, statically.
static void initClass (void) — sets the whole class up, call it once and you're golden.

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

🎀 Public Attributes

SoSFBitMask whatToReset — the one and only field, a bitmask saying what to reset. main character energy honestly.

🦋 Protected Member Functions

virtual const SoFieldData * getFieldData (void) const — grabs the field data, virtually.
virtual ~SoResetTransform () — destructor, protected, virtual, bye bestie.

🦋 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)
~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) — the static pointer-to-field-data getter.

🌟 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 = 0
static int nextActionMethodIndex = 0

🦋 Detailed Description 🦋

okay so the whole vibe: SoResetTransform is a node type which makes it possible to "nullify" state during traversal. 🌈

SoResetTransform is useful for setting up geometry in the scene graph which will not be influenced by the transformation nodes before it during traversal. literally the "don't let the parents touch me" node. periodt. 💅

FILE FORMAT/DEFAULTS:

ResetTransform {
    whatToReset TRANSFORM
}

🔥 Member Enumeration Documentation 🔥

`enum SoResetTransform::ResetType`

The different options for what to reset. lowkey a tiny menu of chaos. 🍓

Enumerator

TRANSFORM — Reset current model transformation. ✨
BBOX — Reset current bounding box settings. 🎀

💀 Constructor & Destructor Documentation 💀

`SoResetTransform::SoResetTransform (void )`

Constructor. it's giving new-beginning energy. 🌸

References BBOX, SoResetTransform(), TRANSFORM, and whatToReset.

Referenced by getFieldData(), and SoResetTransform().

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

Destructor. protected, virtual, and honestly kind of mysterious. 🙈

and that's where part 1 wraps — more of this page is coming, so don't go anywhere bestie 💜

✨ Member Function Documentation ✨

🌟 `SoType SoResetTransform::getTypeId (void ) const` [virtual]

okay bestie so this one is THE vibe check of the type system 💅 it hands you back the type identification of any object derived from SoBase, which is what powers run-time type checking and "downward" casting (iykyk — that's when you know what you're pointing at and you just go for it).

Usage example, and yes it's giving exact and untouched:

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 else — this method needs to be overridden in all subclasses, no exceptions, periodt. Usually you do that as part of setting up the full type system for your extension classes, and the way that's normally done is 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

Want the full lore on writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. 🦋

Reimplemented from SoTransformation.

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

Gives you back 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 thing 💀

Reimplemented from SoTransformation.

References SoResetTransform().

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

This function performs the typical operation of a node for any action. Main character behaviour, honestly 👑