SoGetMatrixAction(3)

📦 version 2.5.0, in fedora 43, fedora 44

✨ SoGetMatrixAction(3) ✨

okay so bestie, this page comes straight out of the Library Functions Manual, and it's all about SoGetMatrixAction. buckle up, it's giving transformation-matrix realness 💅

🌸 NAME 🌸

SoGetMatrixAction — the action class for accumulating the transformation matrix of a subgraph. no cap.

🦋 SYNOPSIS 🦋

#include <Inventor/actions/SoGetMatrixAction.h>

Inherits SoAction. it's literally in the family tree, iykyk 🌈

💅 Public Member Functions 💅

virtual SoType getTypeId (void) const — the type-checking baddie
SoGetMatrixAction (const SbViewportRegion &region) — constructor, say hi
virtual ~SoGetMatrixAction () — destructor, bye bestie
void setViewportRegion (const SbViewportRegion &region) — sets the viewport region
const SbViewportRegion & getViewportRegion (void) const — gets the viewport region back
SbMatrix & getMatrix (void) — the accumulated transformation matrix
SbMatrix & getInverse (void) — the inverse of that matrix
SbMatrix & getTextureMatrix (void) — the accumulated texture matrix
SbMatrix & getTextureInverse (void) — the inverse of the texture matrix

🫶 Public Member Functions inherited from `SoAction` 🫶

virtual ~SoAction ()
virtual SbBool isOfType (SoType type) const
virtual void apply (SoNode *root)
virtual void apply (SoPath *path)
virtual void apply (const SoPathList &pathlist, SbBool obeysrules=0)
void apply (SoAction *beingApplied)
virtual void invalidateState (void)
AppliedCode getWhatAppliedTo (void) const
SoNode * getNodeAppliedTo (void) const
SoPath * getPathAppliedTo (void) const
const SoPathList * getPathListAppliedTo (void) const
const SoPathList * getOriginalPathListAppliedTo (void) const
SbBool isLastPathListAppliedTo (void) const
PathCode getPathCode (int &numindices, const int *&indices)
void traverse (SoNode *const node)
SbBool hasTerminated (void) const
const SoPath * getCurPath (void)
SoState * getState (void) const
PathCode getCurPathCode (void) const
virtual SoNode * getCurPathTail (void)
void usePathCode (int &numindices, const int *&indices)
void pushCurPath (const int childindex, SoNode *node=NULL)
void popCurPath (const PathCode prevpathcode)
void pushCurPath (void)
void popPushCurPath (const int childindex, SoNode *node=NULL)
void popCurPath (void)
void switchToPathTraversal (SoPath *path)
void switchToNodeTraversal (SoNode *node)

⭐ Static Public Member Functions ⭐

static SoType getClassTypeId (void)
static void addMethod (const SoType type, SoActionMethod method)
static void enableElement (const SoType type, const int stackindex)
static void initClass (void)

💜 Static Public Member Functions inherited from `SoAction` 💜

static void initClass (void)
static void initClasses (void)
static SoType getClassTypeId (void)
static void nullAction (SoAction *action, SoNode *node)

🎀 Protected Member Functions 🎀

virtual const SoEnabledElementsList & getEnabledElements (void) const
virtual void beginTraversal (SoNode *node)

🧚 Protected Member Functions inherited from `SoAction` 🧚

SoAction (void)
virtual void endTraversal (SoNode *node)
void setTerminated (const SbBool flag)
virtual SbBool shouldCompactPathList (void) const

🌈 Static Protected Member Functions 🌈

static SoEnabledElementsList * getClassEnabledElements (void)
static SoActionMethodList * getClassActionMethods (void)

🌸 Static Protected Member Functions inherited from `SoAction` 🌸

static SoEnabledElementsList * getClassEnabledElements (void)
static SoActionMethodList * getClassActionMethods (void)

🫶 Additional Inherited Members 🫶

👑 Public Types inherited from `SoAction` 👑

enum AppliedCode { NODE = 0, PATH = 1, PATH_LIST = 2 }
enum PathCode { NO_PATH = 0, IN_PATH = 1, BELOW_PATH = 2, OFF_PATH = 3 }

💜 Protected Attributes inherited from `SoAction` 💜

SoState * state
SoActionMethodList * traversalMethods

🔥 Detailed Description 🔥

okay so SoGetMatrixAction is an action for accumulating the transformation matrix of a subgraph. it's literally the glow-up tool for coordinate systems ✨

This action makes it easy to calculate and convert to and from the global coordinate system of your scene and local coordinates of parts in a hierarchical model. so useful, we're obsessed.

As opposed to most other action types, the SoGetMatrixAction does not traverse children of the node it is applied to — just the node itself. When applied to paths, it stops at the last node and does not continue further with the children of the tail node. it's giving "boundaries", and we respect that 💅

Typical usage when querying for world space position, orientation and/or scaling would be as follows:

// First get hold of an SoPath through the scenegraph down to the
// node ("mynode") you want to query about its current world space
// transformation(s).

SoSearchAction * searchaction = new SoSearchAction;
searchaction->setNode(mynode);
searchaction->apply(myscenegraphroot);

SoPath * path = searchaction->getPath();
assert(path != NULL);

// Then apply the SoGetMatrixAction to get the full transformation
// matrix from world space.

const SbViewportRegion vpr = myviewer->getViewportRegion();
SoGetMatrixAction * getmatrixaction = new SoGetMatrixAction(vpr);
getmatrixaction->apply(path);

SbMatrix transformation = getmatrixaction->getMatrix();

// And if you want to access the individual transformation
// components of the matrix:

SbVec3f translation;
SbRotation rotation;
SbVec3f scalevector;
SbRotation scaleorientation;

transformation.getTransform(translation, rotation, scalevector, scaleorientation);

🎀 Constructor & Destructor Documentation 🎀

🌸 `SoGetMatrixAction::SoGetMatrixAction (const SbViewportRegion & region)` 🌸

Constructor. hi bestie 👋

The region viewport specification is not used by this action, and is passed along in case it is needed by any nodes. so it's like, just holding it for a friend.

References SoGetMatrixAction().

Referenced by addMethod(), and SoGetMatrixAction().

🦋 `SoGetMatrixAction::~SoGetMatrixAction ()` [virtual] 🦋

Destructor. and that's the end of the era 💀

💖 Member Function Documentation 💖

⭐ `SoType SoGetMatrixAction::getTypeId (void ) const` [virtual] ⭐

Returns the type identification of an action derived from a class inheriting SoAction. This is used for run-time type checking and "downward" casting. so basically it's the vibe check for your object types ✨

Usage example:

void bar(SoAction * action)
{
  if (action->getTypeId() == SoGLRenderAction::getClassTypeId()) {
    // safe downward cast, know the type
    SoGLRenderAction * glrender = (SoGLRenderAction *)action;
  }
  return; // ignore if not renderaction
}

For application programmers wanting to extend the library with new actions: this method needs to be overridden in all subclasses. This is 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 Inventor/nodes/SoSubAction.h: SO_ACTION_SOURCE, SO_ACTION_INIT_CLASS and SO_ACTION_CONSTRUCTOR. slay, macros.

For more information on writing Coin extensions, see the SoAction class documentation.

Returns the actual type id of an object derived from a class inheriting SoAction. Needs to be overridden in all subclasses.

Implements SoAction.

💅 `void SoGetMatrixAction::addMethod (const SoType type, SoActionMethod method)` [static] 💅

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. so like, not your business bestie, but we're telling you anyway 🫶

References SoAction::SoAction(), and SoGetMatrixAction().

🌈 `void SoGetMatrixAction::enableElement (const SoType type, const int stackindex)` [static] 🌈

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. same energy, it's giving backstage pass only 💅

🧚 `const SoEnabledElementsList & SoGetMatrixAction::getEnabledElements (void ) const` [protected], [virtual] 🧚

Returns a list of the elements used by action instances of this class upon traversal operations.

Reimplemented from SoAction.

🎀 `void SoGetMatrixAction::setViewportRegion (const SbViewportRegion & region)` 🎀

Set the viewport region. simple as that, no cap.

See also: SoGetMatrixAction::SoGetMatrixAction()

🦋 `const SbViewportRegion & SoGetMatrixAction::getViewportRegion (void ) const` 🦋

Returns the viewport region for the action instance. it's giving "here's the region back" ✨

🔥 `SbMatrix & SoGetMatrixAction::getMatrix (void )` 🔥

Returns the accumulated transformation matrix. the main character, honestly 👑

Note: don't modify the returned matrix. This should only be done if you are implementing your own transformation type node extensions. This advice is also valid for the other matrix access methods documented below. so like, hands off, fr fr.

Referenced by SoTransform::combineLeft(), SoVRMLTransform::combineLeft(), SoTransform::combineRight(), SoVRMLTransform::combineRight(), SoAntiSquish::getMatrix(), SoGeoLocation::getMatrix(), SoGeoSeparator::getMatrix(), SoMatrixTransform::getMatrix(), SoResetTransform::getMatrix(), SoRotation::getMatrix(), SoRotationXYZ::getMatrix(), SoScale::getMatrix(), SoSurroundScale::getMatrix(), SoTransform::getMatrix(), SoTranslation::getMatrix(), SoUnits::getMatrix(), SoVRMLTransform::getMatrix(), and SoDragger::getPartToLocalMatrix().

💜 `SbMatrix & SoGetMatrixAction::getInverse (void )` 💜

Returns the inverse of the accumulated transformation matrix. the uno reverse card of matrices 🃏

Referenced by SoAntiSquish::getMatrix(), SoGeoLocation::getMatrix(), SoGeoSeparator::getMatrix(), SoMatrixTransform::getMatrix(), SoResetTransform::getMatrix(), SoRotation::getMatrix(), SoRotationXYZ::getMatrix(), SoScale::getMatrix(), SoSurroundScale::getMatrix(), SoTransform::getMatrix(), SoTranslation::getMatrix(), SoUnits::getMatrix(), SoVRMLTransform::getMatrix(), and SoDragger::getPartToLocalMatrix().

🌸 `SbMatrix & SoGetMatrixAction::getTextureMatrix (void )` 🌸

Returns the accumulated texture matrix. for when the texture wants to transform too, periodt.

Referenced by SoTexture2Transform::getMatrix(), SoTexture3Transform::getMatrix(), and SoVRMLTextureTransform::getMatrix().

⭐ `SbMatrix & SoGetMatrixAction::getTextureInverse (void )` ⭐

Returns the inverse of the accumulated texture matrix. texture but make it inverse ✨

Referenced by SoTexture2Transform::getMatrix(), SoTexture3Transform::getMatrix(), and SoVRMLTextureTransform::getMatrix().

🫶 `void SoGetMatrixAction::beginTraversal (SoNode * node)` [protected], [virtual] 🫶

This virtual method is called from SoAction::apply(), and is the entry point for the actual scenegraph traversal. it's giving "the doors open, let's go" 🚪

It can be overridden to initialize the action at traversal start, for specific initializations in the action subclasses inheriting SoAction.

Default method just calls traverse(), which any overridden implementation of the method must do too (or call SoAction::beginTraversal()) to trigger the scenegraph traversal. don't skip that step bestie, or nothing happens 💀

Reimplemented from SoAction.

References SoAction::state, SoAction::traversalMethods, and SoAction::traverse().

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. the bots wrote it, we just made it cute 💅

and that's the whole page, bestie 🫶 this was Coin, Version 2.5.0, page SoGetMatrixAction(3) — thanks for reading, ily, go accumulate some matrices ✨🌈💖

📦 where this page comes from

fedora 43: Coin2-devel 2.5.0-52.fc43 · GPL-2.0-only
fedora 43: Coin2-devel 2.5.0-52.fc43 · GPL-2.0-only
fedora 44: Coin2-devel 2.5.0-54.fc44 · GPL-2.0-only
fedora 44: Coin2-devel 2.5.0-54.fc44 · GPL-2.0-only
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms

SoGetMatrixAction(3)