SoTransformSeparator(3)

📦 version 2.5.0, in fedora 43, fedora 44

okay bestie, pull up a chair and charge your phone, because this is SoTransformSeparator(3) — part 1 of the manual, and it's literally the page for a group node that preserves the current transformations. no cap. 💖

✨ NAME ✨

  • SoTransformSeparator — The SoTransformSeparator class is a group node preserving the current transformations. 🦋

💅 SYNOPSIS 💅

#include <Inventor/nodes/SoTransformSeparator.h>

Inherits SoGroup.

👑 Public Member Functions

  • virtual SoType getTypeId (void) const
  • SoTransformSeparator (void)
  • SoTransformSeparator (int nChildren)
  • virtual void doAction (SoAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void pick (SoPickAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)

👑 Public Member Functions inherited from SoGroup

  • SoGroup (void)
  • SoGroup (int nchildren)
  • virtual void addChild (SoNode *node)
  • virtual void insertChild (SoNode *child, int newchildindex)
  • virtual SoNode * getChild (int index) const
  • virtual int findChild (const SoNode *node) const
  • virtual int getNumChildren (void) const
  • virtual void removeChild (int childindex)
  • virtual void removeChild (SoNode *child)
  • virtual void removeAllChildren (void)
  • virtual void replaceChild (int index, SoNode *newchild)
  • virtual void replaceChild (SoNode *oldchild, SoNode *newchild)
  • virtual void handleEvent (SoHandleEventAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual SoChildList * getChildren (void) const

👑 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 rayPick (SoRayPickAction *action)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • virtual void notify (SoNotList *l)
  • uint32_t getNodeId (void) const
  • virtual void writeInstance (SoOutput *out)
  • virtual SoNode * addToCopyDict (void) const
  • 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)
  • static void initClass (void)

👑 Static Public Member Functions inherited from SoGroup

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

👑 Protected Member Functions

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

👑 Protected Member Functions inherited from SoGroup

  • virtual ~SoGroup ()
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)
  • virtual SbBool readChildren (SoInput *in)
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)

👑 Protected Member Functions inherited from SoNode

  • SoNode (void)
  • virtual ~SoNode ()

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

👑 Static Protected Member Functions inherited from SoGroup

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

Protected Types inherited from SoBase

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

Protected Attributes inherited from SoGroup

  • SoChildList * children

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 🌸

The SoTransformSeparator class is a group node preserving the current transformations. ✨

This node works like the SoSeparator group node, except that it only stores and restores the current model matrix transformation. Other appearance settings, like materials, textures, cameras, lights, etc, will affect the remaining parts of the scenegraph after traversal, just like as for the SoGroup node. 🦋

FILE FORMAT/DEFAULTS:

TransformSeparator {
}

🔍 See also 🔍

  • SoSeparator, SoGroup

🛠️ Constructor & Destructor Documentation 🛠️

SoTransformSeparator::SoTransformSeparator (void )

Default constructor. 💅

References SoTransformSeparator().

Referenced by getFieldData(), SoTransformSeparator(), and SoTransformSeparator().

SoTransformSeparator::SoTransformSeparator (int nChildren)

Constructor. ✨

The argument should be the approximate number of children which is expected to be inserted below this node. The number need not be exact, as it is only used as a hint for better memory resource allocation.

References SoTransformSeparator().

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

Destructor. 💖

okay bestie, that's part 1, but there's more manual coming, so stay perched 🦋✨

✨ Member Function Documentation ✨

SoType SoTransformSeparator::getTypeId (void ) const — [virtual] 🌈

Okay bestie, this one is literally the ✨identity check✨ of the whole class system. It hands you back the type identification of any object derived from a class that inherits SoBase. What's it for? Run-time type checking and "downward" casting. iykyk 💅

Usage example, and yes we're keeping it exactly as-is because it's iconic:

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 your heart desires — this method needs to be overridden in all subclasses. No skipping, no shortcuts, periodt. 🫶

The way you normally do it is as part of setting up the full type system for your extension classes, which usually means 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 down the line.

Want more info on writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. 🎀

Reimplemented from SoGroup.

const SoFieldData * SoTransformSeparator::getFieldData (void ) const — [protected], [virtual] 🦋

This one gives you back a pointer to the class-wide field data storage object for this instance. And if there are literally no fields present? It returns NULL. That's it, that's the whole vibe. 💜

Reimplemented from SoGroup. References SoTransformSeparator().

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

This function performs the typical operation of a node for any action. Any action at all, bestie — it's the generalist. 👑

Reimplemented from SoGroup. References SoGroup::doAction(), and SoAction::getState(). Referenced by getPrimitiveCount().

void SoTransformSeparator::callback (SoCallbackAction * action) — [virtual] 🍓

Action method for SoCallbackAction.

It simply updates the state according to how the node behaves for the render action, so that you, the application programmer, can use SoCallbackAction for extracting information about the scene graph. Very demure, very mindful. 🌸

Reimplemented from SoGroup. References SoGroup::callback(), and SoAction::getState().

void SoTransformSeparator::GLRender (SoGLRenderAction * action) — [virtual] ⭐

Action method for the SoGLRenderAction.

This is the one that gets called during rendering traversals. Any node that influences the rendering state in any way, or who wants to throw geometry primitives at OpenGL, overrides this method. Main character energy fr fr. 💅

Reimplemented from SoGroup. References SoAction::getState(), and SoGroup::GLRender().

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

Action method for SoPickAction.

Does the common processing for SoPickAction action instances. Simple, clean, does what it says on the tin. ✨

Reimplemented from SoGroup. References SoAction::getState(), and SoGroup::pick().

void SoTransformSeparator::getBoundingBox (SoGetBoundingBoxAction * action) — [virtual] 📦

Action method for the SoGetBoundingBoxAction.

Calculates bounding box and center coordinates for the node, then 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 that influence how geometry nodes calculate their bounding box also override this method to change the relevant state variables. 💖

Reimplemented from SoGroup. References SoGroup::getBoundingBox(), and SoAction::getState().

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

Action method for SoGetMatrixAction.

Updates the action by accumulating with the transformation matrix of this node (if there is one, no pressure). 🌈

Reimplemented from SoGroup. References SoGroup::children, and SoAction::getPathCode().

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. Math but make it cute. 🎀

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

Reimplemented from SoGroup. References doAction().

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

Action method for SoAudioRenderAction.

Does the common processing for SoAudioRenderAction action instances. Sound on, bestie. 🔊

Reimplemented from SoGroup. References SoGroup::audioRender(), and SoAction::getState().

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. Not a human, not a vibe curator, just a very dedicated documentation generator doing its thing. 🙈

Okay so that's a wrap on SoTransformSeparator(3) — the whole thing was generated by Doxygen for Coin, and it's Version 2.5.0. Go forth and separate those transforms, bestie. You ate. 💅✨👑

📦 where this page comes from