SoTranslation(3)

📦 version 2.5.0, in fedora 43, fedora 44

✨ NAME ✨

Okay bestie, meet SoTranslation 💖 — full name SoTranslation, and it's the absolute icon of a page you're reading right now: SoTranslation(3). Yes, section 3, library functions manual, we're in the C++ API part of the building, iykyk 💅.

So what is it? It's the class that specifies geometry translations. That's the whole vibe. It says what it does on the tin, no cap.

🦋 SYNOPSIS 🦋

So here's how you pull this class into your life:

#include <Inventor/nodes/SoTranslation.h>
  • Inherits SoTransformation. 👑
  • Inherited by SoShuttle. 🦋

💫 Public Member Functions 💫

These are the ones SoTranslation itself brings to the group chat:

  • virtual SoType getTypeId (void) const
  • SoTranslation (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=0) 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=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 ⭐

The ones that don't need an object, they just show up for everyone:

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

🌈 Public Attributes 🌈

  • SoSFVec3f translation — this is the field, the whole main character of this node. ✨

🔒 Protected Member Functions 🔒

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

🔒 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)
  • ~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 }

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 = 0
  • static int nextActionMethodIndex = 0

🌟 DETAILED DESCRIPTION 🌟

So the tea: the SoTranslation class is a node type for specifying geometry translations. 🎀

And if all you wanna do is translate some geometry in a scene graph? Bestie, this is literally the node type for you. Use it. No notes. 💅

FILE FORMAT/DEFAULTS:

Translation {
    translation 0 0 0
}
Notice the default, bestie: translation 0 0 0. That's the starting point. ✨

💖 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 💖

🌸 SoTranslation::SoTranslation (void ) 🌸

Constructor. It builds the thing. 🫶

It references SoTranslation(), and translation.

It's referenced by getFieldData(), and SoTranslation().

🥀 SoTranslation::~SoTranslation () [protected], [virtual] 🥀

Destructor. It cleans up after the thing. 😭

💖 Member Function Documentation 💖

getTypeId() — the type-ID check-in 🦋

SoType SoTranslation::getTypeId (void ) const [virtual]

okay so bestie, this one hands you back the type identification of an object that descends from SoBase. What's it even for? Run-time type checking and "downward" casting, that's what. It's giving detective energy, fr fr. 🔍

Usage example, and yes you're gonna want to screenshot this:

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

Now for the application programmers who wanna extend the library with new nodes, engines, nodekits, draggers or whatever else — listen up. 🌟 This method needs to be overridden in all subclasses. No skipping, no "I'll do it later", no cap. 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, 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. The macros are literally right there, they're iconic, use them. 💅

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups. Go read it, it's good for you. 📚

  • Reimplemented from SoTransformation.
  • Reimplemented in SoShuttle.

getFieldData() — the field-data plug 🔌

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

Returns a pointer to the class-wide field data storage object for this instance. And if there are no fields present? It returns NULL. That's it, that's the whole deal. Simple, clean, we love a low-drama function. 🎀

  • Reimplemented from SoTransformation.
  • Reimplemented in SoShuttle.
  • References SoTranslation().

doAction() — the main character doing main character things 👑

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

This function performs the typical operation of a node for any action. Yes, any. It's the generalist, the one who shows up to every party. 🎉

  • Reimplemented from SoNode.
  • References SoAction::getState(), and translation.
  • Referenced by callback(), getBoundingBox(), getPrimitiveCount(), GLRender(), and pick().

callback() — the SoCallbackAction hook ☎️

void SoTranslation::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. Sneaky little info-extraction moment, we love it. 🕵️‍♀️

  • Reimplemented from SoNode.
  • References doAction().

GLRender() — pixels time 🔥

void SoTranslation::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. That's you. You're that node. 💅

  • Reimplemented from SoNode.
  • References doAction().

getBoundingBox() — where even are you 📦

void SoTranslation::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. Basically it's out here centering you, literally and geometrically. ✨

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

  • Reimplemented from SoNode.
  • References doAction().

getMatrix() — math but make it matrix 🧮

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

Action method for SoGetMatrixAction.

Updates action by accumulating with the transformation matrix of this node (if any). Note the "(if any)" — we stay honest in this house. 🫶

  • Reimplemented from SoNode.
  • References SoGetMatrixAction::getInverse(), SoGetMatrixAction::getMatrix(), SbMatrix::multLeft(), SbMatrix::multRight(), SbMatrix::setTranslate(), and translation.

pick() — click detection vibes 🎯

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

Action method for SoPickAction.

Does common processing for SoPickAction action instances. Common processing = the shared chores. Someone has to do them. 🌸

  • Reimplemented from SoNode.
  • References doAction().

getPrimitiveCount() — counting era 🔢

void SoTranslation::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. It's just doing inventory, bestie. 📝

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

  • Reimplemented from SoNode.
  • References doAction().

🌈 Member Data Documentation 🌈

translation 💜

SoSFVec3f SoTranslation::translation

Set the X, Y and Z translation values. Defaults to <0, 0, 0> — so if you do nothing, nothing moves. Extremely on brand for a default. 🛋️

  • Referenced by doAction(), SoHandleBoxDragger::dragStart(), SoTransformerDragger::dragStart(), getMatrix(), SoShuttle::SoShuttle(), and SoTranslation().

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. Yeah, a robot wrote this, and honestly? It ate. 🤖✨

aaaand that's a wrap on SoTranslation(3), bestie!! This little beauty is from Coin, Version 2.5.0, and it lives in section 3 of the manual. Go forth and translate your whole scene, you absolute icon. 🎀💖🦋🌸💅

📦 where this page comes from