SoVRMLTexture(3)

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

okay so bestie, gather round πŸ’– this is the manual page for SoVRMLTexture, from the Library Functions Manual, and it is long β€” like, so long it comes in 2 parts, and this right here is part 1. More parts follow, so don't you dare close the tab. 🫢


🌸 NAME 🌸

SoVRMLTexture β€” she's the superclass for VRML texture nodes. The blueprint. The mother of the texture girlies. πŸ’…


✨ SYNOPSIS ✨

#include <Inventor/VRMLnodes/SoVRMLTexture.h>

She inherits SoNode. πŸŽ€

She's inherited by SoVRMLImageTexture, SoVRMLMovieTexture, and SoVRMLPixelTexture β€” her three iconic daughters, all carrying the family name. πŸ‘‘

πŸ’œ Public Member Functions πŸ’œ

  • virtual SoType getTypeId (void) const
  • virtual void GLRender (SoGLRenderAction *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 doAction (SoAction *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)

🌟 Public Attributes 🌟

  • SoSFBool repeatS
  • SoSFBool repeatT

πŸ”’ Protected Member Functions πŸ”’

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

πŸ”’ 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 SoVRMLTexture class is a superclass for VRML texture nodes. That's the whole description, bestie β€” she's the template, the blueprint, the energy every VRML texture node is built on top of. The daughters do the actual texturing; she sets the standard. πŸ‘‘


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

SoVRMLTexture::SoVRMLTexture (void ) [protected]

Constructor. 🍼 (protected, so she's for family only β€” no randoms instantiating her directly.)

SoVRMLTexture::~SoVRMLTexture () [protected], [virtual]

Destructor. πŸ’€ (also protected, also virtual, so cleanup behaves when the subclasses come through.)


✨ Member Function Documentation ✨

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

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

Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)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. That's 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. Macros doing the heavy lifting = the real main character energy. πŸ’…

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

Implements SoBase.

Reimplemented in SoVRMLImageTexture, SoVRMLMovieTexture, and SoVRMLPixelTexture.

const SoFieldData * SoVRMLTexture::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.

Reimplemented in SoVRMLImageTexture, SoVRMLMovieTexture, and SoVRMLPixelTexture.

void SoVRMLTexture::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 want to throw geometry primitives at OpenGL, override this method.

Reimplemented from SoNode.

Reimplemented in SoVRMLImageTexture, SoVRMLMovieTexture, and SoVRMLPixelTexture.

πŸ’– Member Data Documentation πŸ’–

okay bestie, this is the part where we meet the two actual data members you can poke at. there are literally only two of them and they're both vibes, so let's go ✨

  • SoSFBool SoVRMLTexture::repeatS β€” this lil baby is TRUE when the texture should be repeated in the S direction, i.e. the way you'd tile it horizontally. the default is TRUE, so it's already repeating out of the box. icon behavior honestly.
  • SoSFBool SoVRMLTexture::repeatT β€” same energy but for the T direction, the vertical one. TRUE means repeat, and the default is TRUE here too. so yeah, by default both directions are tiling, no cap.

and that's genuinely it for the data β€” two booleans, both defaulting to TRUE, both controlling how the texture wraps around. the way that the whole tiling situation is just two SoSFBools... it's giving minimalist queen πŸ‘‘

quick reminder bestie: these are SoSFBool fields, so they're the "single field" flavor of the field family β€” one value each, no list shenanigans. set them to FALSE if you want clamping instead of repeating. that's the whole vibe check. πŸ¦‹

🌸 Author 🌸

so this absolute masterpiece of a manpage was Generated automatically by Doxygen for Coin from the source code. β€” yeah, nobody hand-wrote this, it's a robot doing its little robot thing, and honestly? it ate. πŸ’…


Coin Β· Version 3.1.3 Β· SoVRMLTexture(3)

that's the whole page bestie, sourced from Coin, stamped Version 3.1.3, and the date is just kinda vibing wherever Doxygen left it πŸŽ€ thanks for reading all the way to the end, you're the main character fr fr 🫢✨

πŸ“¦ where this page comes from