SoMatrixTransform(3)

📦 version 3.1.3, in fedora 43, fedora 44

NAME 🦋

okay so bestie, SoMatrixTransform(3) — literally the transformation node class. That's the whole vibe. It's a node that does transformations. Periodt. 💅

SYNOPSIS ✨

#include <Inventor/nodes/SoMatrixTransform.h>

Inherits SoTransformation.

Public Member Functions 💖

  • virtual SoType getTypeId (void) const
  • SoMatrixTransform (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 💖

  • SoSFMatrix matrix

Protected Member Functions 🫶

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

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 🌟

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 SoMatrixTransform class is a transformation node.

bestie, this class is literally the most flexible transformation node, because you can use it to accumulate any kind of transformation matrix on top of the current model transformation matrix. It's giving main character energy. 👑

FILE FORMAT/DEFAULTS 📝

         MatrixTransform {
             matrix 1 0 0 0
       0 1 0 0
       0 0 1 0
       0 0 0 1
         }

See also 👀

SoTransform

Constructor & Destructor Documentation 🎂

SoMatrixTransform::SoMatrixTransform (void ) 💅

Constructor. It does the constructor thing. Slay.

SoMatrixTransform::~SoMatrixTransform () [protected], [virtual] 💀

Destructor. It cleans up the vibe. Protected and virtual, no cap.

part 1 of 2, bestie — part 2 is coming, don't go anywhere ✨

💅 Member Function Documentation 💅

okay bestie, this is the part where we go method by method. every single one, no skipping. periodt. 💖

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

This one hands you the type ID for any object that comes from a class inheriting SoBase. It's literally how the library does run-time type checking and "downward" casting. iykyk.

Usage example, bestie:

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. That's usually part of setting up the full type system for extension classes, which is typically done 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.

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

Reimplemented from SoTransformation.

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

Returns a pointer to the class-wide field data storage object for this instance. If there are no fields present, it returns NULL. That's it. no cap.

Reimplemented from SoTransformation.

void SoMatrixTransform::doAction (SoAction * action) [virtual] 🌸

This function performs the typical operation of a node for any action. Like, it does the thing. ✨

Reimplemented from SoNode.

void SoMatrixTransform::callback (SoCallbackAction * action) [virtual] 🎀

Action method for SoCallbackAction. It simply updates the state according to how the node behaves for the render action, so the application programmer can use SoCallbackAction for extracting information about the scene graph. slay.

Reimplemented from SoNode.

void SoMatrixTransform::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, overrides this method. periodt.

Reimplemented from SoNode.

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

Action method for the SoGetBoundingBoxAction. It 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. lowkey important.

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

Reimplemented from SoNode.

void SoMatrixTransform::getMatrix (SoGetMatrixAction * action) [virtual] 💫

Action method for SoGetMatrixAction. Updates the action by accumulating with the transformation matrix of this node (if any). yes bestie.

Reimplemented from SoNode.

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

Action method for SoPickAction. Does common processing for SoPickAction action instances. iconic.

Reimplemented from SoNode.

void SoMatrixTransform::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 queen energy.

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

Reimplemented from SoNode.

💎 Member Data Documentation 💎

SoSFMatrix SoMatrixTransform::matrix 👑

The transformation matrix. Defaults to the identity matrix. the main character of this whole node, honestly.

✍️ Author ✍️

Generated automatically by Doxygen for Coin from the source code. 🤖✨

and that's the whole page, bestie. the footer says Coin, Version 3.1.3, SoMatrixTransform(3). that's the source, the version, and the page name. no date in the footer, just so you know. bye 💖🫶

📦 where this page comes from