SoTexture3Transform(3)

📦 version 3.1.3, in fedora 43, fedora 44

✨ SoTexture3Transform(3) ✨

okay bestie, welcome to the glow-up zone 💖 This is a page from the Library Functions Manual, and it's all about SoTexture3Transform — the class that gives you 3D texture transformations. It's a long one so we're doing this in two parts, and this is part 1. Buckle up, it's giving ✨structured✨.

🎀 NAME 🎀

SoTexture3Transform — the class used to define 3D texture transformations. 💅

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoTexture3Transform.h>

Inherits SoNode.

🦋 Public Member Functions 🦋

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

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

The SoTexture3Transform class is used to define 3D texture transformations. periodt 💅

So here's the tea, bestie: textures applied to shapes in the scene can be transformed by "prefixing" in the state with instances of this node type. And the range?? Translations, rotations and scaling, all in 3D, all doable. Obsessed. 🔥

The default settings of this node's fields equals a "nulltransform", ie no transformation. It's giving does nothing and that's the point ✨.

🚨 okay important 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 if you go looking for it there… she's not there, bestie. 😭

Here's the 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, and TGS Inventor 2.6 💫

🎀 Constructor & Destructor Documentation 🎀

💖 SoTexture3Transform::SoTexture3Transform (void ) 💖

Constructor. She's born ✨.

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

Destructor. She's leaving, but make it protected and virtual 💅.

💖 Member Function Documentation 💖

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

Okay bestie, this one hands you back the type identification of an object that derives from a class inheriting SoBase. It's what makes run-time type checking and "downward" casting possible. Iconic behavior honestly.

Usage example:

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

Now listen — for application programmers who wanna extend the library with new nodes, engines, nodekits, draggers or whatever else: this method needs to be overridden in all subclasses. Not optional, 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.

For more info on writing Coin extensions, go peek at 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. And if there are no fields present? It returns NULL. That's it, that's the whole thing. 🎀

Reimplemented from SoFieldContainer.

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

This function performs the typical operation of a node for any action. Your general-purpose lil workhorse. 🐝

Reimplemented from SoNode.

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. Basically it's giving state update so you can snoop on the scene graph. 🦋

Reimplemented from SoNode.

void SoTexture3Transform::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 who wants to throw geometry primitives at OpenGL, overrides this method. If that's you, go off. 🔥

Reimplemented from SoNode.

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

Action method for SoGetMatrixAction.

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

Reimplemented from SoNode.

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

Action method for SoPickAction.

Does common processing for SoPickAction action instances. Standard procedure, nothing wild. ✨

Reimplemented from SoNode.

🌸 Member Data Documentation 🌸

SoSFVec3f SoTexture3Transform::translation

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

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). Axis queen behavior. 💫

SoSFVec3f SoTexture3Transform::scaleFactor

Texture coordinate scale factors. Default value is [1, 1, 1]. Not too big, not too small, just right. 🍓

SoSFRotation SoTexture3Transform::scaleOrientation

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

SoSFVec3f SoTexture3Transform::center

Center for scale and rotation. Default value is [0, 0, 0]. Everything orbits around this bestie. 🌈

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code. Not me writing a novel, the robot did it, and honestly? Slay. 🤖✨

And that's a wrap on part 2, bestie!! This page came from Coin, Version 3.1.3, and it's the SoTexture3Transform(3) manual page. Go transform some texture coordinates, you absolute icon. 💅💖🎀🦋
📦 where this page comes from