SoTexture3Transform(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoTexture3Transform 💖

okay so bestie, you've landed on the manual page for SoTexture3Transform — that's the class from the Library Functions Manual (section 3, iykyk) that handles your 3D texture transformations. buckle up, it's a whole vibe.

✨ NAME ✨

SoTexture3Transform — the class that defines 3D texture transformations. that's the whole name, periodt.

🌸 SYNOPSIS 🌸

first things first, you gotta pull in the header:

#include <Inventor/nodes/SoTexture3Transform.h>

and yes, it Inherits SoNode — the family tree goes deep, we'll get there.

🫶 Public Member Functions

here's what's actually yours, front and center:

  • virtual SoType getTypeId (void) const
  • SoTexture3Transform (void)
  • virtual void doAction (SoAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void pick (SoPickAction *action)

🧚 Public Member Functions inherited from SoNode

the whole inheritance glow-up, no cap:

  • 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 getBoundingBox (SoGetBoundingBoxAction *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 getPrimitiveCount (SoGetPrimitiveCountAction *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 you can call without an instance, iconic:

  • 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

the actual knobs you get to twist, and they are EVERYTHING:

  • SoSFVec3f translation
  • SoSFRotation rotation
  • SoSFVec3f scaleFactor
  • SoSFRotation scaleOrientation
  • SoSFVec3f center

🙈 Protected Member Functions

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

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

the enum, in all its bitmask glory:

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 🔥

okay so The SoTexture3Transform class is used to define 3D texture transformations. that's the headline, and it ate.

here's the tea: textures applied to shapes in the scene can be transformed by "prefixing" in the state with instances of this node type. Translations, rotations and scaling in 3D can all be done — the full trio, no crumbs left.

the default settings of this node's fields equals a "nulltransform", ie no transformation. so out of the box it's giving "i'm just standing here, minding my business."

⚠️ bestie, heads up: be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. so don't go looking for it in the OGs, she's a Coin exclusive. 💅

📄 FILE FORMAT/DEFAULTS:

Texture3Transform {
    translation 0 0 0
    rotation 0 0 1  0
    scaleFactor 1 1 1
    scaleOrientation 0 0 1  0
    center 0 0 0
}

👀 See also

  • SoTexture2Transform

⏳ Since

  • Coin 2.0
  • TGS Inventor 2.6

🛠️ Constructor & Destructor Documentation 🛠️

SoTexture3Transform::SoTexture3Transform (void )

Constructor. she's born. ✨

References center, rotation, scaleFactor, scaleOrientation, SoTexture3Transform(), and translation.

Referenced by getFieldData(), and SoTexture3Transform().

SoTexture3Transform::~SoTexture3Transform () [protected], [virtual]

Destructor. she's logging off. 😭

okay so that's the whole first half of this page, bestie — and there's more coming, so don't go anywhere 💖✨

✨ Member Function Documentation ✨

💅 SoType SoTexture3Transform::getTypeId (void ) const [virtual]

Okay bestie, this is the vibe check for your objects 💖. It returns the type identification of an object derived from a class inheriting SoBase. This is what powers run-time type checking and "downward" casting. No cap.

Usage example:

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

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. 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. 🦋

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

Implements SoBase.

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

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

Reimplemented from SoFieldContainer.

References SoTexture3Transform().

🔥 void SoTexture3Transform::doAction (SoAction * action) [virtual]

This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

References SoAction::getState(), SbMatrix::setTransform(), and translation.

Referenced by callback(), GLRender(), and pick().

🌈 void SoTexture3Transform::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. It's giving "here's what's up" energy ✨.

Reimplemented from SoNode.

References doAction().

👑 void SoTexture3Transform::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. Main character rendering energy, fr fr.

Reimplemented from SoNode.

References doAction(), SoAction::getState(), SbMatrix::setTransform(), and translation.

💜 void SoTexture3Transform::getMatrix (SoGetMatrixAction * action) [virtual]

Action method for SoGetMatrixAction.

Updates action by accumulating with the transformation matrix of this node (if any).

Reimplemented from SoNode.

References SoGetMatrixAction::getTextureInverse(), SoGetMatrixAction::getTextureMatrix(), SbMatrix::inverse(), SbMatrix::multLeft(), SbMatrix::multRight(), SbMatrix::setTransform(), and translation.

🫶 void SoTexture3Transform::pick (SoPickAction * action) [virtual]

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoNode.

References doAction().

🌸 Member Data Documentation 🌸

🍓 SoSFVec3f SoTexture3Transform::translation

Texture coordinate translation. Default value is [0, 0, 0].

Referenced by doAction(), getMatrix(), GLRender(), and SoTexture3Transform().

🧚 SoSFRotation SoTexture3Transform::rotation

Texture coordinate rotation (s is x-axis, t is y-axis and r is z-axis). Defaults to an identity rotation (ie zero rotation).

Referenced by SoTexture3Transform().

⭐ SoSFVec3f SoTexture3Transform::scaleFactor

Texture coordinate scale factors. Default value is [1, 1, 1].

Referenced by SoTexture3Transform().

🦋 SoSFRotation SoTexture3Transform::scaleOrientation

The orientation the texture is set to before scaling. Defaults to an identity rotation (ie zero rotation).

Referenced by SoTexture3Transform().

💖 SoSFVec3f SoTexture3Transform::center

Center for scale and rotation. Default value is [0, 0, 0].

Referenced by SoTexture3Transform().

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

And that's a wrap, bestie 🎀 — this was Coin, version 2.5.0, on the page SoTexture3Transform(3). Slay, you made it to the end 💅✨

📦 where this page comes from