SoVRMLTextureCoordinate(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoVRMLTextureCoordinate(3) 💖

okay bestie, this is the manual page for SoVRMLTextureCoordinate, and it's giving texture-coordinate realness. Part 1 of 2, so don't go anywhere. 💅

✨ NAME ✨

SoVRMLTextureCoordinate — okay so this class? It binds texture coordinates to vertex-based geometry. That's literally the whole point, no cap.

🌸 SYNOPSIS 🌸

first, the include, because you gotta get the header in your life:

#include <Inventor/VRMLnodes/SoVRMLTextureCoordinate.h>

Inherits SoNode.

👑 Public Member Functions

virtual SoType getTypeId (void) const — gives you the type id, iconic.
SoVRMLTextureCoordinate (void) — the constructor, the birth of a node.
virtual void doAction (SoAction *action) — does the action thing.
virtual void callback (SoCallbackAction *action) — handles the callback action.
virtual void GLRender (SoGLRenderAction *action) — renders with OpenGL.
virtual void pick (SoPickAction *action) — does the pick action.
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — gets the primitive count.

🧬 Public Member Functions inherited from SoNode

and here's the whole SoNode family, exact, because we don't erase ancestors in this house:

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 getMatrix (SoGetMatrixAction *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

more inherited goodness, because the family tree is deep:

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

and the SoBase crew, obviously:

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) — class type id, slay.
static void initClass (void) — initializes the class, iconic.

⭐ Static Public Member Functions inherited from SoNode

static energy, inherited:

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

SoMFVec2f point — this is the field that holds the 2D texture coordinates. It's the main character.

🛡️ Protected Member Functions

virtual const SoFieldData * getFieldData (void) const — gets the field data.
virtual ~SoVRMLTextureCoordinate () — destructor, protected and virtual. Sad but necessary.

🛡️ 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) — pointer to field data, periodt.

🔒 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 SoVRMLTextureCoordinate class? It binds texture coordinates to vertex-based geometry. That's the tea.

The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium. Respect the OGs, periodt.

TextureCoordinate {
  exposedField MFVec2f point  []      # (-inf, inf)
}

The TextureCoordinate node specifies a set of 2D texture coordinates used by vertex-based geometry nodes (e.g., SoVRMLIndexedFaceSet and SoVRMLElevationGrid) to map textures to vertices. Textures are two dimensional colour functions that, given an (s, t) coordinate, return a colour value colour(s, t). Texture map values (SoVRMLImageTexture, SoVRMLMovieTexture, and SoVRMLPixelTexture) range from [0.0, 1.0] along the S-axis and T-axis. However, TextureCoordinate values, specified by the point field, may be in the range (-inf,inf). Texture coordinates identify a location (and thus a colour value) in the texture map. The horizontal coordinate s is specified first, followed by the vertical coordinate t. Slay.

If the texture map is repeated in a given direction (S-axis or T-axis), a texture coordinate C (s or t) is mapped into a texture map that has N pixels in the given direction as follows:

Texture map location = (C - floor(C)) × N

If the texture map is not repeated, the texture coordinates are clamped to the 0.0 to 1.0 range as follows:

Texture map location = N, if C > 1.0,
                     = 0.0, if C < 0.0,
                     = C × N, if 0.0 <= C <= 1.0.

Details on repeating textures are specific to texture map node types described in SoVRMLImageTexture, SoVRMLMovieTexture, and SoVRMLPixelTexture.

🛠️ Constructor & Destructor Documentation

🍼 `SoVRMLTextureCoordinate::SoVRMLTextureCoordinate (void )`

Constructor. It's giving new node energy. 💅

💀 `SoVRMLTextureCoordinate::~SoVRMLTextureCoordinate ()` [protected], [virtual]

Destructor. Protected and virtual, so it's a whole thing. 😭

getTypeId — the vibe-check of who you actually are 💅

SoType SoVRMLTextureCoordinate::getTypeId(void) const [virtual] — bestie, this hands you back the type identification of any object derived from a class that inherits SoBase. It's what powers run-time type checking and "downward" casting. iykyk.

Usage example, and yes you're gonna want to screenshot this:

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

So here's the tea for the application programmers out there who wanna extend the library with new nodes, engines, nodekits, draggers or others: you have to override this method in all subclasses. Not optional, no cap. You typically do it as part of setting up the full type system for your extension classes, and that's usually handled by using the pre-defined macros you get 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. Slay.

Wanna know more about writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. 🫶

This one Implements SoBase.

getFieldData — the receipts for your fields 📋

const SoFieldData * SoVRMLTextureCoordinate::getFieldData(void) const [protected], [virtual] — returns a pointer to the class-wide field data storage object for this instance. If no fields are present, it returns NULL. Periodt.

Reimplemented from SoFieldContainer.