SoTranslation(3)

📦 version 3.1.3, in fedora 43, fedora 44

okay bestie, we're reading the SoTranslation(3) page from the Library Functions Manual 💖 it's giving scene-graph royalty, and we're about to get into every single detail. no cap. ✨

✨ NAME ✨

SoTranslation — the class that is literally a node type for specifying geometry translations. that's the whole vibe. 🦋

🎀 SYNOPSIS 🎀

#include <Inventor/nodes/SoTranslation.h>

Inherits SoTransformation.

Inherited by SoShuttle.

💖 Public Member Functions 💖

  • 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=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 🌟

  • SoSFVec3f translation

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

okay so SoTranslation is literally a node type for specifying geometry translations — that's its whole main character energy. 💅

if you just wanna translate some geometry in a scene graph, you can use this node type. periodt. no extra steps, no drama. 🦋

FILE FORMAT/DEFAULTS:

Translation {
    translation 0 0 0
}

🎬 Constructor & Destructor Documentation 🎬

🍼 SoTranslation::SoTranslation (void ) 🍼

Constructor. that's it, that's the tea. it's giving new object, fresh start, slay. ✨

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

Destructor. the end of the era, bestie. clean up, close the chapter. 💖

💖 Member Function Documentation 💖

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

OK so this one? It's the whole personality of the class system, bestie. It hands you back the type identification of any object derived from SoBase, and that's what makes run-time type checking and "downward" casting possible. iykyk.

Usage example, and yes this is verbatim, don't come for me:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

Now listen — if you're an application programmer and you wanna extend the library with new nodes, engines, nodekits, draggers or whatever else? You must override this method in all subclasses. Not optional, periodt. Usually you do it as part of setting up the full type system for your extension classes, and the way that's normally accomplished is with the pre-defined macros from, 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. 🦋

Want the full lore on writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. Slay.

Reimplemented from SoTransformation.

Reimplemented in SoShuttle.

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

Gives you back a pointer to the class-wide field data storage object for this instance. And if there are <em>no</em> fields present? It returns NULL. That's it, that's the whole vibe. ✨

Reimplemented from SoTransformation.

Reimplemented in SoShuttle.

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

This function performs the typical operation of a node for any action. Main character energy for literally any action, fr fr.

Reimplemented from SoNode.

🌸 void SoTranslation::callback (SoCallbackAction * action) [virtual]

Action method for SoCallbackAction.

Lowkey simple: it just updates the state according to how the node behaves for the render action, so that you, the application programmer, can use SoCallbackAction to extract information about the scene graph. Very demure, very mindful. 💜

Reimplemented from SoNode.

🔥 void SoTranslation::GLRender (SoGLRenderAction * action) [virtual]

Action method for the SoGLRenderAction.

This one gets called during rendering traversals. Any node that influences the rendering state in any way — or that just wants to throw geometry primitives at OpenGL — overrides this method. Iconic behavior honestly.

Reimplemented from SoNode.

🦋 void SoTranslation::getBoundingBox (SoGetBoundingBoxAction * action) [virtual]

Action method for the SoGetBoundingBoxAction.

It calculates bounding box and center coordinates for the node, and then it 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. Bestie it is repositioning the whole scene's center, no cap.

And heads up: nodes that influence how geometry nodes calculate their bounding box also override this method, so they can change the relevant state variables.

Reimplemented from SoNode.

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

Action method for SoGetMatrixAction.

It updates the action by accumulating with the transformation matrix of this node — if any. (That "if any" is doing a lot of work, respect.)

Reimplemented from SoNode.

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

Action method for SoPickAction.

Does the common processing for SoPickAction action instances. Short, sweet, ate. 🍓

Reimplemented from SoNode.

👑 void SoTranslation::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual]

Action method for the SoGetPrimitiveCountAction.

It calculates the number of triangle, line segment and point primitives for the node, and adds these to the counters of the action. Numbers go brrr. 🔢

And same deal as bounding box: nodes that influence how geometry nodes calculate their primitive count also override this method to change the relevant state variables.

Reimplemented from SoNode.

💖 Member Data Documentation 💖

🎀 SoSFVec3f SoTranslation::translation

Set the X, Y and Z translation values. Defaults to <0, 0, 0>.

Okay so literally if you don't touch it, your thing does not move. At all. <0, 0, 0> is the default and it is staying put until you say otherwise. 🌈

✨ Author ✨

Generated automatically by Doxygen for Coin from the source code.

And that's the whole page, bestie!! 🫶 This was Coin Version 3.1.3, and the page you're reading is SoTranslation(3) — go forth and translate your little hearts out. 💖✨🌸

📦 where this page comes from