SoVRMLImageTexture(3)

📦 version 2.5.0, in fedora 43, fedora 44

✨ SoVRMLImageTexture ✨

okay bestie, welcome to SoVRMLImageTexture(3) — this is the Coin/Inventor node that takes a texture file and slaps it onto your geometry. it's a whole vibe. 💅

🌸 NAME 🌸

SoVRMLImageTexture — the class that maps a texture file onto geometry. that's it, that's the girl. 🎀

🦋 SYNOPSIS 🦋

#include <Inventor/VRMLnodes/SoVRMLImageTexture.h>

Inherits SoVRMLTexture. so it already got the family genes, periodt. 👑

💖 Public Member Functions 💖

  • virtual SoType getTypeId (void) const
  • SoVRMLImageTexture (void)
  • void allowPrequalifyFile (SbBool enable)
  • virtual void doAction (SoAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • void setImage (const SbImage &image)
  • const SbImage * getImage (void) const

🫶 Public Member Functions inherited from SoNode 🫶

the whole roster it picked up from SoNode, no gatekeeping:

  • 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 getMatrix (SoGetMatrixAction *action)
  • virtual void handleEvent (SoHandleEventAction *action)
  • virtual void pick (SoPickAction *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 void setDelayFetchURL (const SbBool onoff)
  • static void setPrequalifyFileCallBack (VRMLPrequalifyFileCallback *cb, void *closure)
  • static void setImageDataMaxAge (const uint32_t maxage)

⭐ Static Public Member Functions inherited from SoVRMLTexture ⭐

  • 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 🎀

  • SoMFString url — the actual URL(s) of the texture file. the moment. 💅

🌸 Public Attributes inherited from SoVRMLTexture 🌸

  • SoSFBool repeatS
  • SoSFBool repeatT

🔥 Protected Member Functions 🔥

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoVRMLImageTexture ()
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)
  • int getReadStatus (void) const
  • void setReadStatus (int status)

🦋 Protected Member Functions inherited from SoVRMLTexture 🦋

  • SoVRMLTexture (void)
  • virtual ~SoVRMLTexture ()

💜 Protected Member Functions inherited from SoNode 💜

  • SoNode (void)
  • virtual ~SoNode ()

💖 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 SoVRMLTexture ⭐

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

🎀 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 bestie, so the SoVRMLImageTexture class is literally the thing that maps a texture file onto geometry. that's its whole job. slay.

the detailed class documentation here is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). it's copyright The Web3D Consortium, and it's used with their permission, so we're being very polite about it:

ImageTexture {
  exposedField MFString url     []
  field        SFBool   repeatS TRUE
  field        SFBool   repeatT TRUE
}

the ImageTexture node defines a texture map by specifying an image file and some general parameters for mapping it to geometry. texture maps live in a 2D coordinate system (s, t) that ranges from [0.0, 1.0] in both directions. the bottom edge of the image corresponds to the S-axis of the texture map, and the left edge of the image corresponds to the T-axis. the lower-left pixel of the image is s=0, t=0, and the top-right pixel is s=1, t=1. all of these relationships are depicted in Figure 6.9. iconic behavior tbh.

Figure 6.9

the texture is read from the URL specified by the url field. when the url field contains no values ([]), texturing is disabled. browsers shall support the JPEG and PNG image file formats. in addition, browsers may support other image formats (e.g. CGM) which can be rendered into a 2D image. support for the GIF format is also recommended (including transparency, yes ma'am).

details on the url field can be found in 4.5, VRML and the World Wide Web.

see 4.6.11, Texture maps (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.11) for a general description of texture maps.

see 4.14, Lighting model (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.14) for a description of the lighting equations and the whole interaction between textures, materials, and geometry appearance. it's giving physics but make it fashion.

the repeatS and repeatT fields specify how the texture wraps in the S and T directions. if repeatS is TRUE (the default), the texture map gets repeated outside the [0.0, 1.0] texture coordinate range in the S direction so that it fills the shape. if repeatS is FALSE, the texture coordinates are clamped in the S direction to lie within the [0.0, 1.0] range. the repeatT field is analogous to the repeatS field. twin queens fr fr.

the rest of this class documentation is not from the VRML97 standards documentation — it was written specifically for the Coin3D API documentation. so this part is us talking, bestie.

okay so one common flaw with a LOT of programs that support exporting VRML or Inventor files? they export the same texture file several times, but as different nodes. 😭 and that can cause excessive texture memory usage and slow rendering. not the vibe. below is an example program that fixes this by replacing all instances of the same texture with a pointer to the first node:

#include <Inventor/actions/SoSearchAction.h>
#include <Inventor/actions/SoWriteAction.h>
#include <Inventor/VRMLnodes/SoVRMLGroup.h>
#include <Inventor/VRMLnodes/SoVRMLImageTexture.h>
#include <Inventor/VRMLnodes/SoVRMLAppearance.h>
#include <Inventor/SoDB.h>
#include <Inventor/SoInput.h>
#include <Inventor/SoOutput.h>
#include <assert.h>

int main(int argc, char ** argv)
{
  if (argc < 2) return -1;
  SoDB::init();

  SoInput in;
  if (!in.openFile(argv[1])) return -1;

  if (!in.isFileVRML2()) return -1; // file is not a vrml2 file

  SoVRMLGroup * root = SoDB::readAllVRML(&in);

  if (!root) return -1;
  root->ref();

  SoSearchAction sa;
  sa.setType(SoVRMLImageTexture::getClassTypeId());
  sa.setInterest(SoSearchAction::ALL);
  sa.setSearchingAll(TRUE);
  sa.apply(root);
  SoPathList & pl = sa.getPaths();
  SbDict namedict;

  for (int i = 0; i < pl.getLength(); i++) {
    SoFullPath * p = (SoFullPath*) pl[i];
    if (p->getTail()->isOfType(SoVRMLImageTexture::getClassTypeId())) {
      SoVRMLImageTexture * tex = (SoVRMLImageTexture*) p->getTail();
      if (tex->url.getNum()) {
        // FIXME: we only check the first name here. Should really check all of them
        SbName name = tex->url[0].getString();
        unsigned long key = (unsigned long) ((void*) name.getString());
        void * tmp;
        if (!namedict.find(key, tmp)) {
          (void) namedict.enter(key, tex);
        }
        else if (tmp != (void*) tex) {
          SoNode * parent = p->getNodeFromTail(1);
          if (parent->isOfType(SoVRMLAppearance::getClassTypeId())) {
            ((SoVRMLAppearance*)parent)->texture = (SoNode*) tmp;
          }
          else {
            // not a valid VRML2 file. Print a warning or something.
          }
        }
      }
    }
  }
  sa.reset();
  SoOutput out;
  out.setHeaderString("#VRML V2.0 utf8");
  SoWriteAction wa(&out);
  wa.apply(root);
  root->unref();
}

🎀 Constructor & Destructor Documentation 🎀

SoVRMLImageTexture::SoVRMLImageTexture (void )

Constructor. yes bestie, it constructs. 💅

references SoVRMLImageTexture().

referenced by getFieldData(), and SoVRMLImageTexture().

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

Destructor. it destructs. rip little node 🫶

🌸 Member Function Documentation 🌸

SoType SoVRMLImageTexture::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. (downward casting is not a metaphor bestie, it's real and it's powerful.)

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. it's giving inheritance homework but we respect it.

reimplemented from SoVRMLTexture.

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

references SoNode::rayPickS(), and SoVRMLImageTexture().

void SoVRMLImageTexture::setDelayFetchURL (const SbBool onoff) [static]

sets whether the image loading is delayed until the first time the image is needed, or if the image is loaded immediately when the url field is changed/set. default value is TRUE. patience is a virtue, bestie.

void SoVRMLImageTexture::setPrequalifyFileCallBack (VRMLPrequalifyFileCallback * cb, void * closure) [static]

sets the prequalify callback for ImageTexture nodes. this is a callback that will be called when an image is about to be read. 👀

void SoVRMLImageTexture::allowPrequalifyFile (SbBool enable)

enable prequalify file loading.

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

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

reimplemented from SoNode.

references SoAction::getState(), SbVec2s::getValue(), SbImage::hasData(), SoNode::isOverride(), SoVRMLTexture::repeatS, and SoVRMLTexture::repeatT.

referenced by callback(), and rayPick().

void SoVRMLImageTexture::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. throw them primitives bestie, yeet.

reimplemented from SoVRMLTexture.

references SoAction::getState(), SoState::isCacheOpen(), SoNode::isOverride(), SoVRMLTexture::repeatS, and SoVRMLTexture::repeatT.

void SoVRMLImageTexture::callback (SoCallbackAction * action) [virtual]

action method for SoCallbackAction.

it 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. lowkey a spy mission. 🕵️

reimplemented from SoNode.

references doAction().

void SoVRMLImageTexture::rayPick (SoRayPickAction * action) [virtual]

action method for SoRayPickAction.

checks the ray specification of the action and tests for intersection with the data of the node.

nodes influencing relevant state variables for how picking is done also override this method.

reimplemented from SoNode.

references doAction().

void SoVRMLImageTexture::setImage (const SbImage & image)

set the image data for this node. can be used by the prequalify callback to set the data in the node.

references SoBase::touch().

const SbImage * SoVRMLImageTexture::getImage (void ) const

returns the texture image. here it is bestie, your texture. 💖

void SoVRMLImageTexture::setImageDataMaxAge (const uint32_t maxage) [static]

this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. so like, mind your business (affectionately). 🙈

SbBool SoVRMLImageTexture::readInstance (SoInput * in, unsigned short flags) [protected], [virtual]

this method is mainly intended for internal use during file import operations.

it reads a definition of an instance from the input stream in. the input stream state points to the start of a serialized / persistant representation of an instance of this class type.

TRUE or FALSE is returned, depending on if the instantiation and configuration of the new object of this class type went ok or not. the import process should be robust and handle corrupted input streams by returning FALSE.

flags is used internally during binary import when reading user extension nodes, group nodes or engines.

reimplemented from SoNode.

references SoInput::getDirectories(), SoReadError::post(), SoFieldContainer::readInstance(), and setReadStatus().

int SoVRMLImageTexture::getReadStatus (void ) const [protected]

returns the read status. that's it, that's the whole function. periodt.

void SoVRMLImageTexture::setReadStatus (int status) [protected]

sets the read status.

referenced by readInstance().

👑 Author 👑

generated automatically by Doxygen for Coin from the source code. so if you have notes, take them up with the robot, not me. 😌

and that's a wrap on this page bestie — this one came from Coin Version 2.5.0 and it's filed under SoVRMLImageTexture(3). go forth and texture your geometry responsibly. slay, no cap, you got this. 💅✨🦋

📦 where this page comes from