SoVRMLPixelTexture(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoVRMLPixelTexture(3) — Library Functions Manual 💖

okay bestie, sit DOWN, because this one is a whole thing and I need you to focus. We're looking at the manpage for SoVRMLPixelTexture, from the Library Functions Manual, and it's giving "I map texture images onto geometry" energy, which, honestly? Iconic.

✨ NAME ✨

SoVRMLPixelTexture — the SoVRMLPixelTexture class is used for mapping a texture image onto geometry..

(yes the double period is real, it's in the source, I'm not fixing it, we respect the ancestors 🫶)

🌈 SYNOPSIS 🌈

#include <Inventor/VRMLnodes/SoVRMLPixelTexture.h>

Inherits SoVRMLTexture.

🦋 Public Member Functions 🦋

  • virtual SoType getTypeId (void) const
  • SoVRMLPixelTexture (void)
  • virtual void doAction (SoAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void rayPick (SoRayPickAction *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=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)
  • 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 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 👑

  • SoSFImage image

💅 Public Attributes inherited from SoVRMLTexture

  • SoSFBool repeatS
  • SoSFBool repeatT

🎀 Protected Member Functions 🎀

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoVRMLPixelTexture ()
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)
  • virtual void notify (SoNotList *list)

🍓 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 so, deep breath, here's the actual tea ☕

The SoVRMLPixelTexture class is used for mapping a texture image onto geometry..

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:

PixelTexture {
  exposedField SFImage  image      0 0 0    # see SoSFImage
  field        SFBool   repeatS    TRUE
  field        SFBool   repeatT    TRUE
}

The PixelTexture node defines a 2D image-based texture map as an explicit array of pixel values (the image field) plus parameters controlling tiling repetition of the texture onto geometry. Texture maps are defined in a 2D coordinate system (s, t) that ranges from 0.0 to 1.0 in both directions. The bottom edge of the pixel image corresponds to the S-axis of the texture map, and left edge of the pixel image corresponds to the T-axis of the texture map. The lower-left pixel of the pixel image corresponds to s=0.0, t=0.0, and the top-right pixel of the image corresponds to s = 1.0, t = 1.0. 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. Figure 6.13 depicts an example PixelTexture.

Figure 6.13 — PixelTexture node 👑

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 how the texture values interact with the appearance of the geometry. SoSFImage, describes the specification of an image. 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 is repeated outside the 0-to-1 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 to 1.0 range. The repeatT field is analogous to the repeatS field.

and that's where part 1 wraps, bestie — part 2 is right behind me, don't you dare close the terminal 💜

💅 Constructor & Destructor Documentation 💅

🎀 SoVRMLPixelTexture::SoVRMLPixelTexture (void ) 🎀

Constructor. It makes the thing. 💖

References SoVRMLPixelTexture().

Referenced by getFieldData(), and SoVRMLPixelTexture().

🦋 SoVRMLPixelTexture::~SoVRMLPixelTexture () [protected], [virtual] 🦋

Destructor. It cleans up. Bye bestie. 💀

✨ Member Function Documentation ✨

🌸 SoType SoVRMLPixelTexture::getTypeId (void ) const [virtual] 🌸

Okay so this returns the type identification for any object derived from a class that inherits SoBase. It's how Coin does run-time type checking and "downward" casting.

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

If you're an app programmer and you wanna extend the library with new nodes, engines, nodekits, draggers, or whatever — you gotta override this method in all subclasses. Usually you do that while setting up the full type system for your extension classes, and the move is to use the pre-defined macros from places like 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.

Wanna know more about writing Coin extensions? Go read the class docs for the toplevel superclasses of the different class groups.

Reimplemented from SoVRMLTexture.

💜 const SoFieldData * SoVRMLPixelTexture::getFieldData (void ) const [protected], [virtual] 💜

Hands you a pointer to the class-wide field data storage object for this instance. If there are no fields, it returns NULL.

Reimplemented from SoVRMLTexture.

References SoNode::rayPickS(), and SoVRMLPixelTexture().

🔥 void SoVRMLPixelTexture::doAction (SoAction * action) [virtual] 🔥

This is the function that does the typical operation of a node for any action.

Reimplemented from SoNode.

References SoAction::getState(), SbVec2s::getValue(), SoNode::isOverride(), SoVRMLTexture::repeatS, and SoVRMLTexture::repeatT.

Referenced by callback(), and rayPick().

⭐ void SoVRMLPixelTexture::GLRender (SoGLRenderAction * action) [virtual] ⭐

Action method for SoGLRenderAction.

It gets called during rendering traversals. Any node that messes with the rendering state in any way, or wants to yeet geometry primitives at OpenGL, overrides this method.

Reimplemented from SoVRMLTexture.

References SoAction::getState(), SbVec2s::getValue(), SoState::isCacheOpen(), SoNode::isOverride(), SoVRMLTexture::repeatS, and SoVRMLTexture::repeatT.

🌈 void SoVRMLPixelTexture::callback (SoCallbackAction * action) [virtual] 🌈

Action method for SoCallbackAction.

It just updates the state based on how the node acts for the render action, so app programmers can use SoCallbackAction to extract info about the scene graph.

Reimplemented from SoNode.

References doAction().

🍓 void SoVRMLPixelTexture::rayPick (SoRayPickAction * action) [virtual] 🍓

Action method for SoRayPickAction.

It checks the ray spec from the action and tests for intersection with the data of the node.

Nodes that influence relevant state variables for how picking is done also override this method.

Reimplemented from SoNode.

References doAction().

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

Mainly 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 whether instantiating and configuring the new object of this class type went okay 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 SoFieldContainer::readInstance().

👑 void SoVRMLPixelTexture::notify (SoNotList * list) [protected], [virtual] 👑

Overloaded so it can detect when fields change.

Reimplemented from SoNode.

References SoNode::notify().

📝 Author 📝

Generated automatically by Doxygen for Coin from the source code.

And that's the whole vibe, bestie! This page is from Coin, Version 2.5.0, and it's the SoVRMLPixelTexture(3) manual. Stay slaying 💖✨

📦 where this page comes from