SOTEXTURECOORDINATEFUNCTION(3coin2)

πŸ“¦ version 2.5.0, in fedora 43, fedora 44

πŸ’– SoTextureCoordinateFunction(3) πŸ’– β€” Library Functions Manual

okay bestie, listen. this is the manual page for SoTextureCoordinateFunction, and it lives in the Library Functions Manual (this is the 3coin2 flavor of Coin, iykyk). it's an abstract base class, which means it's basically the blueprint, the mood board, the idea of texture-coordinate-generating nodes, and not really a thing you instantiate and vibe with on its own. no cap. let's get into it πŸ¦‹


✨ NAME ✨

SoTextureCoordinateFunction β€” the SoTextureCoordinateFunction class is an abstract base class for texture coordinate generating nodes.

that's the whole name section. short, sweet, iconic. πŸŽ€


🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoTextureCoordinateFunction.h>

Inherits SoNode.

Inherited by SoTextureCoordinateDefault, SoTextureCoordinateEnvironment, and SoTextureCoordinatePlane.

so like. three whole classes said "yes and" to this one. main character energy fr fr. πŸ‘‘

πŸ’… Public Member Functions

virtual SoType getTypeId (void) const
SoTextureCoordinateFunction (void)

πŸ’œ Public Member Functions inherited from SoNode

bestie there are SO many. I am not skipping a single one of them. every last one ate.

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 doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void pick (SoPickAction *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

the great-great-grandparent of the whole family tree. respect. πŸ™‡β€β™€οΈ

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)

πŸ”’ Protected Member Functions

these ones are, like, for the family only. you can't just walk in. πŸ’€

virtual const SoFieldData * getFieldData (void) const
virtual ~SoTextureCoordinateFunction ()

πŸ“ 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 πŸ‘‘

the little extras. the accessories to the outfit. πŸ’…

πŸ’œ 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
    }

look at all those bit flags. it's giving hexadecimal rainbow. 🌈

πŸ” 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 here's the actual tea, bestie:

The SoTextureCoordinateFunction class is an abstract base class for texture coordinate generating nodes.

and the way that it works? Classes reimplementing SoTextureCoordinateFunction generate texture coordinates by projecting object space surface points using some function. that's the whole mechanic. project the point, run it through a function, boom, texture coordinate. simple, elegant, slay. πŸ’–

ngl, the word "some function" is doing a LOT of heavy lifting there, but that's literally what the manpage says, so I'm not gonna invent details for you. πŸ™ˆ

πŸ”₯ Constructor & Destructor Documentation πŸ”₯

🧚 SoTextureCoordinateFunction::SoTextureCoordinateFunction (void )

Constructor. yes bestie, it exists. πŸŽ€

References SoTextureCoordinateFunction().

Referenced by getFieldData(), and SoTextureCoordinateFunction().

(not me noticing it references itself. that's so real of it. self-love is the moment. πŸ’…)

πŸ’€ SoTextureCoordinateFunction::~SoTextureCoordinateFunction () [protected], [virtual]

Destructor.

it's protected and virtual, so like β€” it's not for you, it's for the subclasses. know your place, bestie. 😌


✨ Member Function Documentation ✨

πŸ’– SoType SoTextureCoordinateFunction::getTypeId (void ) const [virtual]

Okay bestie, this one is literally the vibe check for types. It hands you back the type identification of an object derived from a class that inherits SoBase. What's it for? Run-time type checking and "downward" casting, periodt. 🫢

Usage example, and yes you're getting the whole thing verbatim because it's iconic:

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

See how it ate? Safe casts only, no guessing, no vibes-based pointer crimes. πŸ’…

Now, for the application programmers out there who wanna extend the library with new nodes, engines, nodekits, draggers or whatever else β€” listen up β€” this method needs to be overridden in all subclasses. Not some. All. It's giving "mandatory homework". πŸ“š

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 β€” that's where SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR live for node classes πŸŽ€
  • Inventor/engines/SoSubEngine.h β€” for engine classes
  • and so on. 🌸

For more info on writing Coin extensions, go check the class documentation of the toplevel superclasses for the various class groups. iykyk. ✨

Implements SoBase.
Reimplemented in SoTextureCoordinateDefault, SoTextureCoordinateEnvironment, and SoTextureCoordinatePlane.

πŸ¦‹ const SoFieldData * SoTextureCoordinateFunction::getFieldData (void ) const [protected], [virtual]

This one's a lil lowkey one, protected AND virtual, very mysterious of it. πŸ‘‘

It returns a pointer to the class-wide field data storage object for this instance. That's it. That's the whole job. And if there are no fields present? It returns NULL. Bestie said "no fields, no data, no problem". πŸ’€

Reimplemented from SoFieldContainer.
Reimplemented in SoTextureCoordinateDefault, SoTextureCoordinateEnvironment, and SoTextureCoordinatePlane.

References SoTextureCoordinateFunction().


πŸŽ€ Author πŸŽ€

Generated automatically by Doxygen for Coin from the source code.

Like, the docs wrote themselves. Main character energy fr fr. ✨


And that's a wrap on the SoTextureCoordinateFunction(3) page bestie!! 🫢 This whole thing came from the Coin library, Version 2.5.0, and it's dated and sourced straight from the Coin source tree β€” go off, Doxygen, you absolute icon. πŸ’–πŸŒΈ

πŸ“¦ where this page comes from