SoVRMLTextureTransform(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoVRMLTextureTransform — Library Functions Manual 💖

okay so bestie, welcome to the SoVRMLTextureTransform(3) page, part one of two (yes there's more, stay with me 💅). This is a Library Functions Manual entry and it is long, so hydrate, sit criss-cross, and let's go.

🌸 NAME 🌸

SoVRMLTextureTransform — the class that defines a transformation applied to texture coordinates. that's the whole vibe, no cap. ✨

✨ SYNOPSIS ✨

#include <Inventor/VRMLnodes/SoVRMLTextureTransform.h>

Inherits SoNode. 🫶 (yes she's a node, she's in the family tree, we love an inheritance moment)

🎀 Public Member Functions

  • virtual SoType getTypeId (void) const — the type-id getter, iconic as always 💅
  • SoVRMLTextureTransform (void) — the constructor, she's here 🎀
  • 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=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

  • 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

bestie these are the fields, the actual data of this node, and they are so important:

  • SoSFVec2f translation
  • SoSFFloat rotation
  • SoSFVec2f scale
  • SoSFVec2f center

🧚 Protected Member Functions

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

🌸 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 glory, verbatim, do not touch a single bit of it:

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
okay bestie, that's the synopsis and the whole inheritance situation — and there is more coming, so don't you dare close the tab. part two is right behind me. 💅✨

✨ Detailed Description ✨

Okay so bestie, the SoVRMLTextureTransform class is literally the definition of a transformation that gets applied to texture coordinates. 💅

The detailed deets below are taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It's copyright The Web3D Consortium, and they're letting us use it with permission:

TextureTransform {
  exposedField SFVec2f center      0 0     # (-inf, inf)
  exposedField SFFloat rotation    0       # (-inf, inf)
  exposedField SFVec2f scale       1 1     # (-inf, inf)
  exposedField SFVec2f translation 0 0     # (-inf, inf)
}

So the TextureTransform node defines a 2D transformation that's applied to texture coordinates (peep SoVRMLTextureCoordinate). This node changes how texture coordinates get applied to the geometric surface. The transformation goes in this order:

  • a translation;
  • a rotation about the centre point;
  • a non-uniform scale about the centre point.

These parameters let you change the size, orientation, and position of textures on shapes. But heads up: these operations look reversed when you view them on the surface of the geometry. For example, a scale value of (2 2) will scale the texture coordinates and have the net effect of shrinking the texture size by a factor of 2 (because the texture coordinates are twice as large, so the texture repeats). A translation of (0.5 0.0) translates the texture coordinates +.5 units along the S-axis, and that has the net effect of translating the texture -0.5 along the S-axis on the geometry's surface. And a rotation of pi/2 of the texture coordinates results in a -pi/2 rotation of the texture on the geometry. 🤯

The center field specifies a translation offset in texture coordinate space that the rotation and scale fields get applied around. The scale field is a scaling factor in S and T of the texture coordinates about the center point. Important: scale values shall be in the range (-pi, pi). The rotation field is a rotation in radians of the texture coordinates about the center point after the scale has been applied. A positive rotation value makes the texture coordinates rotate counterclockwise about the centre, which rotates the appearance of the texture itself clockwise. The translation field is just a translation of the texture coordinates.

In matrix transformation notation, where Tc is the untransformed texture coordinate, Tc' is the transformed texture coordinate, C (center), T (translation), R (rotation), and S (scale) are the intermediate transformation matrices,

Tc' = -C × S × R × C × T × Tc

Note that this transformation order is the reverse of the Transform node transformation order, because it's the texture coordinates being transformed, not the texture itself (i.e., it's the texture coordinate system). 🔄

🎀 Constructor & Destructor Documentation 🎀

SoVRMLTextureTransform::SoVRMLTextureTransform (void ) 💖

Constructor. Yep, it constructs things. ✨

It references center, rotation, scale, SoVRMLTextureTransform(), and translation.

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

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

Destructor. It destroys. Bye! 👋

🔥 Member Function Documentation 🔥

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

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting.

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 * SoVRMLTextureTransform::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 SoVRMLTextureTransform().

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

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

Reimplemented from SoNode.

References SoAction::getState().

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

void SoVRMLTextureTransform::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.

Reimplemented from SoNode.

References doAction().

void SoVRMLTextureTransform::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.

Reimplemented from SoNode.

References doAction().

void SoVRMLTextureTransform::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(), and SbMatrix::multRight().

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

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoNode.

References doAction().

💎 Member Data Documentation 💎

SoSFVec2f SoVRMLTextureTransform::translation

Translation value. Default values is (0, 0, 0).

Referenced by SoVRMLTextureTransform().

SoSFFloat SoVRMLTextureTransform::rotation

Rotation, in radians, around the centre points. Default value is 0.

Referenced by SoVRMLTextureTransform().

SoSFVec2f SoVRMLTextureTransform::scale

Scale vector about the centre point. Default value is (1, 1).

Referenced by SoVRMLTextureTransform().

SoSFVec2f SoVRMLTextureTransform::center

Texture centre. Default value is (0.0, 0.0).

Referenced by SoVRMLTextureTransform().

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

This page is from Coin, version 2.5.0, and it's the man page for SoVRMLTextureTransform(3). Stay slay, bestie! 💖✨

📦 where this page comes from