SoTexture2Transform(3)

📦 version 3.1.3, in fedora 43, fedora 44

🌸 SoTexture2Transform(3) — the one where we spin your textures around 💅

okay bestie, sit down, hydrate, because this is the SoTexture2Transform(3) manual page and it's lowkey iconic ✨ It's a Library Functions Manual situation, and yes it is long, so buckle up.

✨ NAME ✨

SoTexture2Transform — the class that is used to define 2D texture transformations. that's the whole job. that's what she does. 👑

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoTexture2Transform.h>

Inherits SoNode. yes she's a node girlie, she inherited everything from her mother SoNode 💖

💅 Public Member Functions

  • virtual SoType getTypeId (void) const
  • SoTexture2Transform (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

  • SoSFVec2f translation
  • SoSFFloat rotation
  • SoSFVec2f scaleFactor
  • SoSFVec2f center

🫶 Protected Member Functions

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

🌈 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 💅

okay so the SoTexture2Transform class is used to define 2D texture transformations. that's the vibe, that's the mission 🫶

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 2D can all be done. all of it. she's versatile like that 💁‍♀️

The default settings of this node's fields equals a "nulltransform", ie no transformation. so out of the box she does absolutely nothing and honestly? relatable. resting. 🌸

FILE FORMAT/DEFAULTS:

Texture2Transform {
    translation 0 0
    rotation 0
    scaleFactor 1 1
    center 0 0
}

👀 See also

SoTexture3Transform — her 3D sister, go say hi 💖

🛠️ Constructor & Destructor Documentation 🛠️

🦋 SoTexture2Transform::SoTexture2Transform (void )

Constructor. she's born. iconic entrance. no notes. ✨

🎀 SoTexture2Transform::~SoTexture2Transform () [protected], [virtual]

Destructor. she's leaving, protected and virtual about it, as is her right 💅

💖 MEMBER FUNCTION DOCUMENTATION 💖

okay bestie, let's get into the member functions. These are the methods that make SoTexture2Transform do its thing. No cap. ✨

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

This one is virtual and returns an SoType. It's giving "who dis?" for your objects. It gives you the type identification of any object derived from a class that inherits SoBase. You use it for run-time type checking and "downward" casting. iykyk. 💅

Usage example, periodt:

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

Now, 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. That's usually part of setting up the full type system for extension classes, which is typically done 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, see the class documentation of the toplevel superclasses for the various class groups. Implements SoBase. 👑

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

This one is protected and virtual, bestie. It hands you a pointer to the class-wide field data storage object for this instance. If there are no fields present, it returns NULL. No cap. Reimplemented from SoFieldContainer. 🫶

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

This function does the typical operation of a node for any action. Periodt. Reimplemented from SoNode. 💫

void SoTexture2Transform::callback (SoCallbackAction * action) [virtual]

Action method for SoCallbackAction. It literally just updates the state according to how the node behaves for the render action, so you (the application programmer) can use SoCallbackAction for extracting information about the scene graph. It's giving "state update realness". Reimplemented from SoNode. 🔥

void SoTexture2Transform::GLRender (SoGLRenderAction * action) [virtual]

Action method for the SoGLRenderAction. This gets called during rendering traversals. Nodes that influence the rendering state in any way, or who wants to throw geometry primitives at OpenGL, override this method. Slay. Reimplemented from SoNode. 🌈

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

Action method for SoGetMatrixAction. It updates the action by accumulating with the transformation matrix of this node (if any). Reimplemented from SoNode. 💜

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

Action method for SoPickAction. It does the common processing for SoPickAction action instances. Reimplemented from SoNode. 🎀

✨ MEMBER DATA DOCUMENTATION ✨

Now for the member data, bestie. These are the fields you can set. 💖

SoSFVec2f SoTexture2Transform::translation

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

SoSFFloat SoTexture2Transform::rotation

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

SoSFVec2f SoTexture2Transform::scaleFactor

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

SoSFVec2f SoTexture2Transform::center

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

👑 AUTHOR 👑

This page was generated automatically by Doxygen for Coin from the source code. So you know it's legit. 💯

Okay bestie, that's the tea. This was Coin version 3.1.3, manual page SoTexture2Transform(3). Stay slay. 💖✨

📦 where this page comes from