SOTEXTURECOORDINATEFUNCTION(3coin3)

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

🌸 NAME 🌸

SoTextureCoordinateFunction β€” okay bestie, this is the manual page SoTextureCoordinateFunction(3) from the Library Functions Manual. The SoTextureCoordinateFunction class is an abstract base class for texture coordinate generating nodes. It's giving foundational abstract-base energy, no cap. πŸ’–


✨ SYNOPSIS ✨

#include <Inventor/nodes/SoTextureCoordinateFunction.h>

Inherits SoNode.

Inherited by SoTextureCoordinateDefault, SoTextureCoordinateEnvironment, SoTextureCoordinateNormalMap, SoTextureCoordinateObject, SoTextureCoordinatePlane, and SoTextureCoordinateReflectionMap. The whole texture-coordinate squad, fr fr. πŸ¦‹


πŸ’… Public Member Functions πŸ’…

  • virtual SoType getTypeId (void) const
  • SoTextureCoordinateFunction (void)

πŸ¦‹ Public Member Functions inherited from SoNode πŸ¦‹

These are the SoNode hand-me-downs, and they ate. πŸ’…

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

🫢 Protected Member Functions 🫢

  • 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)
  • 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 SoTextureCoordinateFunction class is an abstract base class for texture coordinate generating nodes.

Classes reimplementing SoTextureCoordinateFunction generate texture coordinates by projecting object space surface points using some function.


πŸŽ€ Constructor & Destructor Documentation πŸŽ€

πŸ“ SoTextureCoordinateFunction::SoTextureCoordinateFunction (void ) πŸ“

Constructor.

πŸ¦‹ SoTextureCoordinateFunction::~SoTextureCoordinateFunction () [protected], [virtual] πŸ¦‹

Destructor.


Part 2 is loading, bestie β€” more inherited-member lore and the rest of the page are coming through. πŸ’…βœ¨

πŸ’– Member Function Documentation πŸ’–

✨ getTypeId β€” the "who even are you" detector ✨

  • SoType SoTextureCoordinateFunction::getTypeId (void ) const [virtual] β€” bestie this is the method that tells you the type identification of an object derived from a class inheriting SoBase. It's what makes run-time type checking and "downward" casting possible. iykyk.

Like, usage example, because seeing it is believing:

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

okay so if you're an application programmer wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. no skipping, bestie, all of them πŸ’…. 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. the way that the macros do all the heavy lifting for you… obsessed 😭

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups. πŸ‘‘

  • Implements SoBase.
  • Reimplemented in SoTextureCoordinateDefault, SoTextureCoordinateEnvironment, SoTextureCoordinateNormalMap, SoTextureCoordinateObject, SoTextureCoordinatePlane, and SoTextureCoordinateReflectionMap. not one, not two, but six whole icons reimplementing this 🫢

🌸 getFieldData β€” the field-data hookup 🌸

  • const SoFieldData * SoTextureCoordinateFunction::getFieldData (void ) const [protected], [virtual] β€” returns a pointer to the class-wide field data storage object for this instance. and if no fields are present? it returns NULL. that's it, that's the whole vibe, short and sweet πŸŽ€
  • Reimplemented from SoFieldContainer.
  • Reimplemented in SoTextureCoordinateDefault, SoTextureCoordinateEnvironment, SoTextureCoordinateNormalMap, SoTextureCoordinateObject, SoTextureCoordinatePlane, and SoTextureCoordinateReflectionMap. same iconic lineup as above, fr fr πŸ’œ

πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for Coin from the source code. yes bestie, a robot wrote this one, not me, and honestly? slay πŸ€–βœ¨


and that's a wrap on the whole page!! this was Coin Version 3.1.3, and the page you've been reading is SoTextureC...ateFunction(3). ty for coming to my ted talk, go cast some types safely, mwah πŸ’–πŸ’…πŸ¦‹
πŸ“¦ where this page comes from