SoTransformSeparator(3)

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

🎀 SoTransformSeparator(3) — Coin 🎀

okay bestie so this is the manual page for SoTransformSeparator, section 3 of the Coin manual, and it is long, so buckle up. This is part 1, and yes there's more coming, so don't wander off 💅

💖 NAME 💖

SoTransformSeparator — it's a class that's a group node, and the whole ~thing~ about it is that it preserves the current transformations. That's the vibe. That's the whole assignment. Slay.

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoTransformSeparator.h>

It inherits from SoGroup. So everything SoGroup can do, this girl can do too (and more, lowkey). 🦋

🌸 Public Member Functions 🌸

  • virtual SoType getTypeId (void) const — the type-id getter, and it's virtual, so it knows who it is at runtime. main character energy fr 💅
  • SoTransformSeparator (void) — the no-args constructor. brand new, no children, fresh start ✨
  • SoTransformSeparator (int nChildren) — the constructor that takes nChildren, so you can roll in with your child slots already prepped 👑
  • virtual void doAction (SoAction *action) — the generic action hook. it does the action thing.
  • virtual void callback (SoCallbackAction *action) — the callback-action hook.
  • virtual void GLRender (SoGLRenderAction *action) — the render hook, i.e. the one that makes pixels happen 🌈
  • virtual void pick (SoPickAction *action) — the pick-action hook.
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — the bounding-box hook 📦
  • virtual void getMatrix (SoGetMatrixAction *action) — the matrix hook. matrices are literally the whole personality of this node, iykyk 🔥
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — the primitive-counting hook.
  • virtual void audioRender (SoAudioRenderAction *action) — the audio-render hook 🔊

🦋 Public Member Functions inherited from SoGroup 🦋

  • SoGroup (void) — constructor, no children.
  • SoGroup (int nchildren) — constructor, with a slot count.
  • virtual void addChild (SoNode *node) — add a child.
  • virtual void insertChild (SoNode *child, int newchildindex) — insert a child at a specific index, very specific of you 💖
  • virtual SoNode * getChild (int index) const — grab the child at index.
  • virtual int findChild (const SoNode *node) const — find where a given child lives.
  • virtual int getNumChildren (void) const — how many children do we have? the census.
  • virtual void removeChild (int childindex) — yeet the child at childindex.
  • virtual void removeChild (SoNode *child) — yeet a specific child.
  • virtual void removeAllChildren (void) — yeet all of them. clear the whole roster 💀
  • virtual void replaceChild (int index, SoNode *newchild) — swap by index.
  • virtual void replaceChild (SoNode *oldchild, SoNode *newchild) — swap by pointer. out with the old, in with the new 🎀
  • virtual void handleEvent (SoHandleEventAction *action) — event-handling hook.
  • virtual void search (SoSearchAction *action) — search-action hook.
  • virtual void write (SoWriteAction *action) — write-action hook, for when you gotta save it.
  • virtual SoChildList * getChildren (void) const — hands you the actual child list pointer.
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) — adds a write reference; note the isfromfield=FALSE default, don't forget it ⭐

🌈 Public Member Functions inherited from SoNode 🌈

  • void setOverride (const SbBool state) — sets the override state.
  • SbBool isOverride (void) const — asks: is it override?
  • void setNodeType (const NodeType type) — sets the node type.
  • NodeType getNodeType (void) const — gets the node type.
  • virtual SoNode * copy (SbBool copyconnections=FALSE) const — makes a copy, with copyconnections=FALSE as the default. careful with those connections bestie 🙈
  • virtual SbBool affectsState (void) const — does it affect state?
  • virtual void GLRenderBelowPath (SoGLRenderAction *action) — render below path.
  • virtual void GLRenderInPath (SoGLRenderAction *action) — render in path.
  • virtual void GLRenderOffPath (SoGLRenderAction *action) — render off path.
  • virtual void rayPick (SoRayPickAction *action) — ray pick hook.
  • virtual void grabEventsSetup (void) — grab-events setup.
  • virtual void grabEventsCleanup (void) — grab-events cleanup.
  • virtual void startNotify (void) — kicks off notification.
  • virtual void notify (SoNotList *l) — the notification itself.
  • SbUniqueId getNodeId (void) const — your node's unique id, like a little name tag 👑
  • virtual void writeInstance (SoOutput *out) — writes this instance out.
  • virtual SoNode * addToCopyDict (void) const — adds itself to the copy dictionary.
  • virtual SoFieldContainer * copyThroughConnection (void) const — copies through a connection.

💜 Public Member Functions inherited from SoFieldContainer 💜

  • void setToDefaults (void) — reset everything to defaults.
  • SbBool hasDefaultValues (void) const — are we all defaults?
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const — do our fields match container's?
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE) — copies field values over, with copyconnections=FALSE by default.
  • SbBool set (const char *const fielddata) — set from a field-data string.
  • void get (SbString &fielddata) — get out as a field-data string.
  • virtual int getFields (SoFieldList &l) const — get the fields into l.
  • virtual int getAllFields (SoFieldList &l) const — get all the fields into l.
  • virtual SoField * getField (const SbName &name) const — grab the field called name.
  • virtual SoField * getEventIn (const SbName &name) const — grab the event-in called name.
  • virtual SoField * getEventOut (const SbName &name) const — grab the event-out called name.
  • SbBool getFieldName (const SoField *const field, SbName &name) const — figure out a field's name.
  • SbBool enableNotify (const SbBool flag) — toggle notifications on/off.
  • SbBool isNotifyEnabled (void) const — are notifications enabled?
  • SbBool set (const char *fielddata, SoInput *input) — the SoInput-flavoured set.
  • void get (SbString &fielddata, SoOutput *out) — the SoOutput-flavoured get.
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval) — validate a new value before it lands.
  • SbBool getIsBuiltIn (void) const — is it built in?
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const — reports memory sizes into managed and unmanaged.
  • void setUserData (void *userdata) const — stash your own user data.
  • void * getUserData (void) const — get your own user data back 🫶

🎀 Public Member Functions inherited from SoBase 🎀

  • void ref (void) const — bump the reference count.
  • void unref (void) const — drop the reference count.
  • void unrefNoDelete (void) const — drop the count but no delete. rude to delete, honestly.
  • int32_t getRefCount (void) const — how many refs we got?
  • void touch (void) — touch it. it knows. ✨
  • SbBool isOfType (SoType type) const — Returns TRUE if the type of this object is either of the same type or inherited from type. so it's giving "am I one of you?" energy.
  • virtual SbName getName (void) const — get the name.
  • virtual void setName (const SbName &newname) — set the name to newname.
  • void addAuditor (void *const auditor, const SoNotRec::Type type) — add an auditor of a given SoNotRec::Type.
  • void removeAuditor (void *const auditor, const SoNotRec::Type type) — remove that auditor.
  • const SoAuditorList & getAuditors (void) const — get the whole auditor list.
  • SbBool shouldWrite (void) — should this be written?
  • void assertAlive (void) const — asserts the object is alive. dramatic but necessary 💀

⭐ Static Public Member Functions ⭐

  • static SoType getClassTypeId (void) — the class type id, static version.
  • 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. so basically it does the admin so you don't have to 👑

✨ Static Public Member Functions inherited from SoGroup ✨

  • static SoType getClassTypeId (void) — class type id, static.
  • 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 Public Member Functions inherited from SoNode ✨

  • static uint32_t getCompatibilityTypes (const SoType &nodetype) — compatibility types, as a uint32_t.
  • static SoType getClassTypeId (void) — class type id, static.
  • static SoNode * getByName (const SbName &name) — look a node up by name.
  • static int getByName (const SbName &name, SoNodeList &l) — look nodes up by name into 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) — plural! init all the classes 💅
  • static SbUniqueId getNextNodeId (void) — hand out the next unique node id.
  • static int getActionMethodIndex (const SoType type) — action method index for type.
  • static void getBoundingBoxS (SoAction *action, SoNode *node) — the S-suffixed static for bounding box.
  • static void GLRenderS (SoAction *action, SoNode *node) — the S-suffixed static for GL render.
  • static void callbackS (SoAction *action, SoNode *node) — the S-suffixed static for callback.
  • static void getMatrixS (SoAction *action, SoNode *node) — the S-suffixed static for matrix.
  • static void handleEventS (SoAction *action, SoNode *node) — the S-suffixed static for handle event.
  • static void pickS (SoAction *action, SoNode *node) — the S-suffixed static for pick.
  • static void rayPickS (SoAction *action, SoNode *node) — the S-suffixed static for ray pick.
  • static void searchS (SoAction *action, SoNode *node) — the S-suffixed static for search.
  • static void writeS (SoAction *action, SoNode *node) — the S-suffixed static for write.
  • static void audioRenderS (SoAction *action, SoNode *node) — the S-suffixed static for audio render.
  • static void getPrimitiveCountS (SoAction *action, SoNode *node) — the S-suffixed static for primitive count.

💖 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) — cleanup time, tidy up bestie 🧹
  • static void initCopyDict (void) — init the copy dictionary.
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — register a copy of orig.
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — check whether orig has a copy.
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — find the copy of orig, respecting copyconnections.
  • static void copyDone (void) — copying's done, wrap it up ✨

🫶 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) — give base the name name.
  • static void removeName (SoBase *const base, const char *const name) — take that name away.
  • static void incrementCurrentWriteCounter (void) — bump the current write counter.
  • static void decrementCurrentWriteCounter (void) — drop the current write counter.
  • static SoBase * getNamedBase (const SbName &name, SoType type) — get the named base of a given type.
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — get named bases into baselist.
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — read from input, expecting expectedtype.
  • static void setInstancePrefix (const SbString &c) — set the instance prefix to c.
  • static void setTraceRefs (SbBool trace) — toggle reference tracing.
  • static SbBool getTraceRefs (void) — get the reference tracing setting.
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — wire up a route from one node/field to another. matchmaking, but for fields 💘
  • static SbBool readRoute (SoInput *input) — read a route in.

🫶 Protected Member Functions 🫶

  • virtual const SoFieldData * getFieldData (void) const — the protected field-data getter.
  • virtual ~SoTransformSeparator () — the destructor, and it's virtual. say bye properly 💅

🌸 Protected Member Functions inherited from SoGroup 🌸

  • virtual ~SoGroup () — virtual destructor.
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — read an instance from in with flags.
  • virtual SbBool readChildren (SoInput *in) — read the children from in.
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections) — copy the contents from from.
  • virtual SoNotRec createNotRec (void) — create a notification record.
  • void setOperation (const SoNotRec::OperationType opType=SoNotRec::UNSPECIFIED, const SoNode *cc=NULL, const SoNode *pc=NULL, const int ci=-1) — set the operation, and look at those defaults: opType=SoNotRec::UNSPECIFIED, cc=NULL, pc=NULL, ci=-1. keep them exactly as written bestie ⭐

🦋 Protected Member Functions inherited from SoNode 🦋

  • SoNode (void) — protected constructor.
  • virtual ~SoNode () — virtual destructor.

💜 Protected Member Functions inherited from SoFieldContainer 💜

  • SoFieldContainer (void) — protected constructor.
  • virtual ~SoFieldContainer () — virtual destructor.

🎀 Protected Member Functions inherited from SoBase 🎀

  • SoBase (void) — protected constructor.
  • virtual ~SoBase () — virtual destructor.
  • virtual void destroy (void) — destroy.
  • SbBool hasMultipleWriteRefs (void) const — does it have multiple write refs?
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — write the header out.
  • void writeFooter (SoOutput *out) const — write the footer out.
  • virtual const char * getFileFormatName (void) const — get the file format name.

💅 Static Protected Member Functions 💅

  • static const SoFieldData ** getFieldDataPtr (void) — the static protected field-data pointer getter.

✨ Static Protected Member Functions inherited from SoGroup ✨

  • static const SoFieldData ** getFieldDataPtr (void) — same deal, SoGroup edition.

🌈 Static Protected Member Functions inherited from SoNode 🌈

  • static const SoFieldData ** getFieldDataPtr (void) — same deal, SoNode edition.
  • static void setNextActionMethodIndex (int index) — set the next action method index to index.
  • static int getNextActionMethodIndex (void) — get the next action method index.
  • static void incNextActionMethodIndex (void) — increment it.
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — set compatibility types for nodetype using bitmask.

🫶 Static Protected Member Functions inherited from SoBase 🫶

  • static uint32_t getCurrentWriteCounter (void) — get the current write counter.
  • static void staticDataLock (void) — lock the static data 🔒
  • static void staticDataUnlock (void) — unlock the static data 🔓

👑 Additional Inherited Members 👑

🌟 Public Types inherited from SoNode 🌟

the NodeType enum, and it's a whole mood board of versions:

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 SoGroup 🌸

  • SoChildList * children — the children list pointer. it's protected, so hands off 🙈

🦋 Protected Attributes inherited from SoNode 🦋

  • SbUniqueId uniqueId — every node's own unique id.

💜 Protected Attributes inherited from SoFieldContainer 💜

  • SbBool isBuiltIn — whether it's built in or not.

⭐ Static Protected Attributes inherited from SoNode ⭐

  • static SbUniqueId nextUniqueId = 1 — starts at 1, no cap.
  • static int nextActionMethodIndex = 0 — starts at 0.

okay that's part 1 done and dusted, bestie — do NOT go anywhere because part 2 is literally right there 💖✨🎀

💖 DETAILED DESCRIPTION 💖

Okay bestie, listen up, because SoTransformSeparator is lowkey one of the most useful little gremlins in the whole scene graph. 🎀

The SoTransformSeparator class is a group node that preserves the current transformations. That's its whole thing. That's the assignment and it ate. 💅

It works exactly like the SoSeparator group node — except it only stores and restores the current model matrix transformation. That's it. That's the only state it's gatekeeping. ✨

Everything else? Materials, textures, cameras, lights, etc. — all of those appearance settings will affect the remaining parts of the scene graph after traversal, just like they would with the SoGroup node. So don't come for this node expecting it to hold your textures too, because it said no. 🙈

FILE FORMAT/DEFAULTS:

TransformSeparator {
}

See also

  • SoSeparator, SoGroup

🛠️ CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 🛠️

SoTransformSeparator::SoTransformSeparator (void )

Default constructor. The classic. The OG. No arguments, no drama. 🦋

SoTransformSeparator::SoTransformSeparator (int nChildren)

Constructor, but make it informed. 📝

The argument should be the approximate number of children which is expected to be inserted below this node. The number need not be exact, because bestie it is literally just a hint for better memory resource allocation — it's the node's little heads-up so it can pre-game the memory situation. It's giving "I'm manifesting this many children." 💫

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

Destructor. Protected, virtual, and minding its own business. 🫶

✨ MEMBER FUNCTION DOCUMENTATION ✨

SoType SoTransformSeparator::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class. Static, so you don't even need an instance to ask. Iconic behaviour, honestly. 👑

SoType SoTransformSeparator::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.

Reimplemented from SoGroup.

Runtime type checking and downward casting, no cap. 🔍

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

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

So like, unless you're doing library-internal shenanigans, this one's not for you, bestie. 🚪

const SoFieldData * SoTransformSeparator::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 SoGroup.

NULL! If there are no fields, you get NULL. That's the deal. 💀

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

This function performs the typical operation of a node for any action. Any action, one method, the multitasker of the century. 🌈

Reimplemented from SoGroup.

void SoTransformSeparator::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.

Yes bestie, it's literally just updating state so you can go extract scene graph info. You're welcome. 🕵️

Reimplemented from SoGroup.

void SoTransformSeparator::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.

Throwing geometry primitives at OpenGL is such a mood, fr fr. 🔥

Reimplemented from SoGroup.

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

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Common processing, no fuss, no notes. 💅

Reimplemented from SoGroup.

void SoTransformSeparator::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.

So it's out here doing math: expanding the action's values to swallow up this node's bounding box, AND nudging the scene's center point closer to this node's own center. Two jobs. Slay. 📐✨

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

Reimplemented from SoGroup.

void SoTransformSeparator::getMatrix (SoGetMatrixAction * action) [virtual]

Action method for SoGetMatrixAction.

Updates action by accumulating with the transformation matrix of this node (if any).

(if any) — the parenthetical that keeps us humble. 😌

Reimplemented from SoGroup.

void SoTransformSeparator::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual]

Action method for the SoGetPrimitiveCountAction.

Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action.

Triangles, line segments AND points — it's counting all three, bestie. Very thorough. 🧮

Nodes influencing how geometry nodes calculate their primitive count also override this method to change the relevant state variables.

Reimplemented from SoGroup.

void SoTransformSeparator::audioRender (SoAudioRenderAction * action) [virtual]

Action method for SoAudioRenderAction.

Does common processing for SoAudioRenderAction action instances.

Audio representation, but make it common processing. 🎧

Reimplemented from SoGroup.

👑 AUTHOR 👑

Generated automatically by Doxygen for Coin from the source code.

And that's the whole page, babe! 💜 This was Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00, so like… future-coded of them. 🦋✨ Go forth and separate those transforms, SoTransformSeparator(3) bestie. Periodt. 💅🎀

📦 where this page comes from