SoVRMLTransform(3)
β¨ NAME β¨
SoVRMLTransform β okay so bestie, listen. This is the grouping node that defines a transformation for its children. That's the whole gig. It groups stuff and it transforms it. π
π SYNOPSIS π
#include <Inventor/VRMLnodes/SoVRMLTransform.h>
Inherits SoVRMLGroup.
π Public Member Functions
Here's the full roster, no skips, no cuts, all of it:
virtual SoType getTypeId (void) constSoVRMLTransform (void)SoVRMLTransform (int children)void pointAt (const SbVec3f &from, const SbVec3f &to)void getScaleSpaceMatrix (SbMatrix &matrix, SbMatrix &inverse) constvoid getRotationSpaceMatrix (SbMatrix &matrix, SbMatrix &inverse) constvoid getTranslationSpaceMatrix (SbMatrix &matrix, SbMatrix &inverse) constvoid multLeft (const SbMatrix &matrix)void multRight (const SbMatrix &matrix)void combineLeft (SoVRMLTransform *leftnode)void combineRight (SoVRMLTransform *rightnode)void setMatrix (const SbMatrix &matrix)void recenter (const SbVec3f &newcenter)virtual void doAction (SoAction *action)virtual void callback (SoCallbackAction *action)virtual void getBoundingBox (SoGetBoundingBoxAction *action)virtual void getMatrix (SoGetMatrixAction *action)virtual void rayPick (SoRayPickAction *action)virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)virtual void audioRender (SoAudioRenderAction *action)virtual void GLRenderBelowPath (SoGLRenderAction *action)virtual void GLRenderInPath (SoGLRenderAction *action)virtual void notify (SoNotList *list)
πΈ Public Member Functions inherited from SoVRMLGroup
SoVRMLGroup (void)SoVRMLGroup (int numChildren)virtual void GLRender (SoGLRenderAction *action)virtual void search (SoSearchAction *action)virtual void write (SoWriteAction *action)virtual void GLRenderOffPath (SoGLRenderAction *action)
π¦ Public Member Functions inherited from SoVRMLParent
virtual SbBool affectsState (void) constvirtual void addChild (SoNode *child)virtual void insertChild (SoNode *child, int idx)virtual SoNode * getChild (int idx) constvirtual int findChild (const SoNode *child) constvirtual int getNumChildren (void) constvirtual void removeChild (int idx)virtual void removeChild (SoNode *child)virtual void removeAllChildren (void)virtual void replaceChild (int idx, SoNode *child)virtual void replaceChild (SoNode *old, SoNode *child)virtual SoChildList * getChildren (void) const
π«Ά Public Member Functions inherited from SoGroup
SoGroup (void)SoGroup (int nchildren)virtual void handleEvent (SoHandleEventAction *action)virtual void pick (SoPickAction *action)
π Public Member Functions inherited from SoNode
void setOverride (const SbBool state)SbBool isOverride (void) constvoid setNodeType (const NodeType type)NodeType getNodeType (void) constvirtual SoNode * copy (SbBool copyconnections=FALSE) constvirtual void grabEventsSetup (void)virtual void grabEventsCleanup (void)virtual void startNotify (void)uint32_t getNodeId (void) constvirtual void writeInstance (SoOutput *out)virtual SoNode * addToCopyDict (void) constvirtual SoFieldContainer * copyThroughConnection (void) const
π Public Member Functions inherited from SoFieldContainer
void setToDefaults (void)SbBool hasDefaultValues (void) constSbBool fieldsAreEqual (const SoFieldContainer *container) constvoid copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE)SbBool set (const char *const fielddata)void get (SbString &fielddata)virtual int getFields (SoFieldList &l) constvirtual int getAllFields (SoFieldList &l) constvirtual SoField * getField (const SbName &name) constvirtual SoField * getEventIn (const SbName &name) constvirtual SoField * getEventOut (const SbName &name) constSbBool getFieldName (const SoField *const field, SbName &name) constSbBool enableNotify (const SbBool flag)SbBool isNotifyEnabled (void) constSbBool 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) constvirtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) constvoid setUserData (void *userdata) constvoid * getUserData (void) const
π Public Member Functions inherited from SoBase
void ref (void) constvoid unref (void) constvoid unrefNoDelete (void) constint32_t getRefCount (void) constvoid touch (void)SbBool isOfType (SoType type) constvirtual SbName getName (void) constvirtual 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) constSbBool shouldWrite (void)void assertAlive (void) const
β Static Public Member Functions
static SoType getClassTypeId (void)static void initClass (void)
π§ Static Public Member Functions inherited from SoVRMLGroup
static SoType getClassTypeId (void)static void initClass (void)static void setNumRenderCaches (int num)static int getNumRenderCaches (void)
πΈ Static Public Member Functions inherited from SoVRMLParent
static SoType getClassTypeId (void)static void initClass (void)static void updateChildList (const SoNode *const *nodes, const int numnodes, SoChildList &cl)static void updateChildList (SoNode *nodewithsfnode, SoChildList &cl)
π¦ 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 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
These are the fields you actually get to play with, bestie:
SoSFVec3f translationSoSFRotation rotationSoSFVec3f scaleSoSFRotation scaleOrientationSoSFVec3f center
β¨ Public Attributes inherited from SoVRMLGroup
SoSFEnum renderCachingSoSFEnum boundingBoxCachingSoSFEnum renderCullingSoSFEnum pickCullingSoSFVec3f bboxCenterSoSFVec3f bboxSize
π Public Attributes inherited from SoVRMLParent
SoMFNode children
π Protected Member Functions
virtual const SoFieldData * getFieldData (void) constvirtual ~SoVRMLTransform ()
π¦ Protected Member Functions inherited from SoVRMLGroup
virtual ~SoVRMLGroup ()virtual SbBool cullTest (SoState *state)
π§ Protected Member Functions inherited from SoVRMLParent
SoVRMLParent (void)SoVRMLParent (int approxchildren)virtual ~SoVRMLParent ()virtual SbBool readInstance (SoInput *in, unsigned short flags)virtual void copyContents (const SoFieldContainer *from, SbBool copyConn)
πΈ Protected Member Functions inherited from SoGroup
virtual ~SoGroup ()virtual SbBool readChildren (SoInput *in)
β Protected Member Functions inherited from SoNode
SoNode (void)virtual ~SoNode ()
π«Ά 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) constSbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) constvoid writeFooter (SoOutput *out) constvirtual const char * getFileFormatName (void) const
π Static Protected Member Functions
static const SoFieldData ** getFieldDataPtr (void)
π Static Protected Member Functions inherited from SoVRMLGroup
static const SoFieldData ** getFieldDataPtr (void)
π Static Protected Member Functions inherited from SoVRMLParent
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)
and that's part one, bestie β more coming, don't go anywhere π
β¨ Additional Inherited Members β¨
okay bestie, before we even get into the main character energy of SoVRMLTransform, hereβs all the inherited lore from its ancestors. family reunion but make it C++ π
Public Types inherited from SoVRMLGroup
enum CacheEnabled { OFF, ON, AUTO }β the cache vibe check. lowkey iconic.
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 }
thatβs the whole enum, no cap. all the node-type flags are living in there π«Ά
Protected Types inherited from SoBase
enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }β protected base flags, for the internal lore only.
Protected Attributes inherited from SoVRMLParent
SoMFNode addChildrenSoMFNode removeChildren
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 SoVRMLGroup
static int numRenderCaches = 2
Static Protected Attributes inherited from SoNode
static uint32_t nextUniqueId = 1static int nextActionMethodIndex = 0
πΈ Detailed Description πΈ
The SoVRMLTransform class is a grouping node that defines a transformation for its children. literally the blueprint for moving your whole squad around the scene π
The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium:
Transform {
eventIn MFNode addChildren
eventIn MFNode removeChildren
exposedField SFVec3f center 0 0 0 # (-inf,inf)
exposedField MFNode children []
exposedField SFRotation rotation 0 0 1 0 # [-1,1],(-inf,inf)
exposedField SFVec3f scale 1 1 1 # (0,inf)
exposedField SFRotation scaleOrientation 0 0 1 0 # [-1,1],(-inf,inf)
exposedField SFVec3f translation 0 0 0 # (-inf,inf)
field SFVec3f bboxCenter 0 0 0 # (-inf,inf)
field SFVec3f bboxSize -1 -1 -1 # (0,inf) or -1,-1,-1
}
The Transform node is a grouping node that defines a coordinate system for its children that is relative to the coordinate systems of its ancestors. See 4.4.4, Transformation hierarchy (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.4.4), and 4.4.5, Standard units and coordinate system (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.4.5), for a description of coordinate systems and transformations. itβs giving ancestry.com but for 3D coordinates π³β¨
4.6.5, Grouping and children nodes (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.5), provides a description of the children, addChildren, and removeChildren fields and eventIns.
The bboxCenter and bboxSize fields specify a bounding box that encloses the children of the Transform node. This is a hint that may be used for optimization purposes. The results are undefined if the specified bounding box is smaller than the actual bounding box of the children at any time. A default bboxSize value, (-1, -1, -1), implies that the bounding box is not specified and, if needed, shall be calculated by the browser. The bounding box shall be large enough at all times to enclose the union of the groupβs childrenβs bounding boxes; it shall not include any transformations performed by the group itself (i.e., the bounding box is defined in the local coordinate system of the children). The results are undefined if the specified bounding box is smaller than the true bounding box of the group. A description of the bboxCenter and bboxSize fields is provided in 4.6.4, Bounding boxes (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.4).
bestie, if you make that bounding box too small, the results are undefined β thatβs chaos, not cute π keep it large enough, periodt.
The translation, rotation, scale, scaleOrientation and center fields define a geometric 3D transformation consisting of (in order):
- a (possibly) non-uniform scale about an arbitrary point;
- a rotation about an arbitrary point and axis;
- a translation.
The center field specifies a translation offset from the origin of the local coordinate system (0,0,0). The rotation field specifies a rotation of the coordinate system. The scale field specifies a non-uniform scale of the coordinate system. scale values shall be greater than zero. The scaleOrientation specifies a rotation of the coordinate system before the scale (to specify scales in arbitrary orientations). The scaleOrientation applies only to the scale operation. The translation field specifies a translation to the coordinate system.
Given a 3-dimensional point P and Transform node, P is transformed into point P' in its parentβs coordinate system by a series of intermediate transformations. In matrix transformation notation, where C (center), SR (scaleOrientation), T (translation), R (rotation), and S (scale) are the equivalent transformation matrices,
P' = T Γ C Γ R Γ SR Γ S Γ -SR Γ -C Γ P
The following Transform node:
Transform {
center C
rotation R
scale S
scaleOrientation SR
translation T
children [...]
}
is equivalent to the nested sequence of:
Transform {
translation T
children Transform {
translation C
children Transform {
rotation R
children Transform {
rotation SR
children Transform {
scale S
children Transform {
rotation -SR
children Transform {
translation -C
children [...]
}
}
}
}
}
}
}
π Constructor & Destructor Documentation π
SoVRMLTransform::SoVRMLTransform (void )
Constructor. basic constructor, no args, just vibes β¨
SoVRMLTransform::SoVRMLTransform (int numchildren)
Constructor. numchildren is the expected number of children. like, tell it how many besties are coming to the party π
SoVRMLTransform::~SoVRMLTransform () [protected], [virtual]
Destructor. the goodbye era, protected and virtual, no cap π¦
π Member Function Documentation π
π SoType SoVRMLTransform::getTypeId(void) const [virtual]
okay so this is the β¨vibe checkβ¨ of the class hierarchy β it hands you back the type identification for any object derived from SoBase. What's it for? Run-time type checking and "downward" casting, bestie. That's it. That's the whole job.
Usage example, and no I'm not paraphrasing this, it's literal:
void foo(SoNode * node)
{
if (node->getTypeId() == SoFile::getClassTypeId()) {
SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type
}
}
Now for the application programmers who wanna extend the library with brand-new nodes, engines, nodekits, draggers or whatever else: this method needs to be overridden in all subclasses. Not optional, not a suggestion, it's giving mandatory. You typically do this as part of setting up the full type system for extension classes, and that's usually handled 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 and so forth.
Wanna know more about writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. π«Ά
Reimplemented from SoVRMLGroup.
π const SoFieldData * SoVRMLTransform::getFieldData(void) const [protected], [virtual]
Returns 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 the tea. π
Reimplemented from SoVRMLGroup.
π¦ void SoVRMLTransform::pointAt(const SbVec3f & from, const SbVec3f & to)
Sets the transformation to translate to frompoint, with a rotation so that the (0,0,-1) vector is rotated into the vector from frompoint to topoint. Pointing. At things. Iconic behaviour honestly.
πΈ void SoVRMLTransform::getScaleSpaceMatrix(SbMatrix & matrix, SbMatrix & inverse) const
Calculates the matrices to/from scale space. Both of them, the forward one and the inverse. Slay.
π void SoVRMLTransform::getRotationSpaceMatrix(SbMatrix & matrix, SbMatrix & inverse) const
Calculates the matrices to/from rotation space. Same deal, matrix and inverse. π«
β void SoVRMLTransform::getTranslationSpaceMatrix(SbMatrix & matrix, SbMatrix & inverse) const
Calculates the matrices to/from translation space. You already know the format by now, bestie: matrix + inverse. Periodt.
π void SoVRMLTransform::multLeft(const SbMatrix & matrix)
Premultiplies this transformation by mat. (yes, the docs say mat while the parameter is called matrix β not my business, I don't make the rules π)
π void SoVRMLTransform::multRight(const SbMatrix & matrix)
Postmultiplies this transformation by mat. The other direction. Balance. π§
β¨ void SoVRMLTransform::combineLeft(SoVRMLTransform * leftnode)
Premultiplies this transformation by the transformation in leftnode. Combining, but from the left.
π void SoVRMLTransform::combineRight(SoVRMLTransform * rightnode)
Postmultiplies this transformation by the transformation in rightnode. Combining, but from the right. Symmetry ate.
π void SoVRMLTransform::setMatrix(const SbMatrix & matrix)
Sets the fields to create a transformation equal to mat. Boom. Done. Main character energy. π
π void SoVRMLTransform::recenter(const SbVec3f & newcenter)
Sets the center field to newcenter. Fair warning though: this might affect one or more of the other fields. Not just a quiet little update, okay? π
π₯ void SoVRMLTransform::doAction(SoAction * action) [virtual]
This function performs the typical operation of a node for any action. Any. Action. Versatile queen.
Reimplemented from SoVRMLGroup.
π«Ά void SoVRMLTransform::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. Very "here's what's going on in the graph, bestie" of it.
Reimplemented from SoVRMLGroup.
π void SoVRMLTransform::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.
Also: nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables. iykyk.
Reimplemented from SoVRMLGroup.
π« void SoVRMLTransform::getMatrix(SoGetMatrixAction * action) [virtual]
Action method for SoGetMatrixAction.
Updates action by accumulating with the transformation matrix of this node (if any). The "(if any)" is doing a lot of heavy lifting there ngl.
Reimplemented from SoVRMLGroup.
π void SoVRMLTransform::rayPick(SoRayPickAction * action) [virtual]
Action method for SoRayPickAction.
Checks the ray specification of the action and tests for intersection with the data of the node. Ray go in, does it hit? That's the whole plot.
Nodes influencing relevant state variables for how picking is done also overrides this method.
Reimplemented from SoVRMLGroup.
π void SoVRMLTransform::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! Points! Counting them all, meticulously, no skips.
Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables.
Reimplemented from SoVRMLGroup.
π§ void SoVRMLTransform::audioRender(SoAudioRenderAction * action) [virtual]
Action method for SoAudioRenderAction.
Does common processing for SoAudioRenderAction action instances. Common processing! Shared labour! We love to see it. π
Reimplemented from SoVRMLGroup.
β void SoVRMLTransform::GLRenderBelowPath(SoGLRenderAction * action) [virtual]
Implements the SoAction::BELOW_PATH traversal method for the rendering action.
Reimplemented from SoVRMLGroup.
πΈ void SoVRMLTransform::GLRenderInPath(SoGLRenderAction * action) [virtual]
Implements the SoAction::IN_PATH traversal method for the rendering action.
Reimplemented from SoVRMLGroup.
π void SoVRMLTransform::notify(SoNotList * l) [virtual]
Notifies all auditors for this instance when changes are made. The group chat gets pinged. Everyone knows. π«Ά
Reimplemented from SoVRMLGroup.
π§ Member Data Documentation π§
π SoSFVec3f SoVRMLTransform::translation
The translation vector. Default value is (0, 0, 0). Starting from the origin, as one does.
π« SoSFRotation SoVRMLTransform::rotation
The rotation around the center point. Default value is null-rotation.
π SoSFVec3f SoVRMLTransform::scale
The scale vector about the center point. Default value is (1, 1, 1). Normal size. Unbothered. Regular.
π SoSFRotation SoVRMLTransform::scaleOrientation
The scale orientation. Default value is a null-rotation.
π¦ SoSFVec3f SoVRMLTransform::center
The center point. Default value is (0, 0, 0). Right in the middle, literally.
β¨ Author β¨
Generated automatically by Doxygen for Coin from the source code. So no, a human did not hand-write this one, it was birthed by tooling, and honestly? It still ate. π
and that's a wrap on the whole page bestie!! π the footer on this one says Coin, Version 3.1.3, manpage SoVRMLTransform(3) β that's your source, your version, and your section, all in one little line. go transform something. mwah. ππ¦β¨
π¦ where this page comes from
- fedora 43: Coin3-devel 3.1.3-40.fc43 Β· GPL-2.0-only
- fedora 43: Coin3-devel 3.1.3-40.fc43 Β· GPL-2.0-only
- fedora 44: Coin3-devel 3.1.3-42.fc44 Β· GPL-2.0-only
- fedora 44: Coin3-devel 3.1.3-42.fc44 Β· GPL-2.0-only
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms