SoTextureCubeMap(3)

📦 version 2.5.0, in fedora 43, fedora 44

✨ SoTextureCubeMap(3) — Library Functions Manual ✨

okay bestie, welcome to the manual page for SoTextureCubeMap(3) from the Library Functions Manual. this is part 1, so buckle up, we're going deep. no cap.

🎀 NAME 🎀

SoTextureCubeMap — the class that maps a cube map onto subsequent shape nodes. it's giving texture, it's giving cube, it's giving iconic. 💅

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoTextureCubeMap.h>

Inherits SoNode.

👑 Public Types

  • enum Model { MODULATE = SoTextureImageElement::MODULATE, DECAL = SoTextureImageElement::DECAL, BLEND = SoTextureImageElement::BLEND, REPLACE = SoTextureImageElement::REPLACE }
  • enum Wrap { REPEAT = SoTextureImageElement::REPEAT, CLAMP = SoTextureImageElement::CLAMP }

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

🌟 Public Member Functions

  • virtual SoType getTypeId (void) const
  • SoTextureCubeMap (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 SbBool readImage (const SbString &fname, int &w, int &h, int &nc, unsigned char *&bytes)

✨ 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 filenames
  • SoSFImage imagePosX
  • SoSFImage imageNegX
  • SoSFImage imagePosY
  • SoSFImage imageNegY
  • SoSFImage imagePosZ
  • SoSFImage imageNegZ
  • SoSFEnum wrapS
  • SoSFEnum wrapT
  • SoSFEnum model
  • SoSFColor blendColor

🛡️ Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoTextureCubeMap ()
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)
  • virtual void notify (SoNotList *list)
  • int getReadStatus (void)
  • void setReadStatus (int s)

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

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

The SoTextureCubeMap class is used to map a cube map onto subsequent shape nodes. periodt.

Shape nodes within the scope of SoTextureCubeMap nodes in the scenegraph (ie below the same SoSeparator and to the righthand side of the SoTextureCubeMap) will have the texture applied according to each shape type's individual characteristics. See the documentation of the various shape types (SoFaceSet, SoCube, SoSphere, etc etc) for information about the specifics of how the textures will be applied. it's giving texture mapping, bestie, and you know we love to see it. 💅

FILE FORMAT/DEFAULTS:

TextureCubeMap {
    filenames [  ]
    imagePosX 0 0 0
    imageNegX 0 0 0
    imagePosY 0 0 0
    imageNegY 0 0 0
    imagePosZ 0 0 0
    imageNegZ 0 0 0
    wrapS REPEAT
    wrapT REPEAT
    model MODULATE
    blendColor 0 0 0
}

Since: Coin 2.5

🧩 Member Enumeration Documentation 💅

enum SoTextureCubeMap::Model ✨

Texture mapping model — aka how do we "merge" the texturemap with the object it's mapped onto. Vibe check on your polygons.

Enumerator

  • MODULATE — texture color gets multiplied by the polygon color. Result gets Phong shaded (if light model is PHONG). 💖
  • DECAL — texture image straight-up overwrites polygon shading. Textured pixels will not be Phong shaded. > ⚠️ Has undefined behaviour for grayscale and grayscale-alpha textures. Don't do it bestie, it's giving chaos. 💀
  • BLEND — normally used with monochrome textures (textures with one or two components, iykyk). The first component, the intensity, is then used to blend between the shaded color of the polygon and SoTextureCubeMap::blendColor. 🎀
  • REPLACE — texture image overwrites polygon shading, textured pixels will not be Phong shaded. Supports grayscale and grayscale alpha textures. This feature requires OpenGL 1.1. MODULATE will be used if OpenGL version < 1.1 is detected. 🌈
🫶 Please note that using this texture model will make your Inventor files incompatible with older versions of Coin and Inventor. You need Coin >= 2.2 or TGS Inventor 4.0 to load Inventor files that uses the REPLACE texture model. Fr fr, don't get caught lacking.

enum SoTextureCubeMap::Wrap 🎁

Enumeration of wrapping strategies which can be used when the texturemap doesn't cover the full extent of the geometry.

Enumerator

  • REPEAT — repeat texture when coordinate is not between 0 and 1. 🔁
  • CLAMP — clamp coordinate between 0 and 1. 📌

🏗️ Constructor & Destructor Documentation 🛠️

SoTextureCubeMap::SoTextureCubeMap (void )

Constructor. ✨

References BLEND, blendColor, CLAMP, DECAL, filenames, imageNegX, imageNegY, imageNegZ, imagePosX, imagePosY, imagePosZ, model, MODULATE, REPEAT, REPLACE, SoTextureCubeMap(), wrapS, and wrapT.

Referenced by getFieldData(), and SoTextureCubeMap().

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

Destructor. Frees up internal resources used to store texture image data. Say bye to all that memory, queen 👋

🧠 Member Function Documentation 📚

SoType SoTextureCubeMap::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. 🔍

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.

Implements SoBase.

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

References SoTextureCubeMap().

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

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

Reimplemented from SoNode.

References SoAction::getState(), SbVec2s::getValue(), SoNode::isOverride(), model, and wrapT.

Referenced by callback(), and rayPick().

void SoTextureCubeMap::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 wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoNode.

References blendColor, SoAction::getState(), SoSFImage::getValue(), SoState::isCacheOpen(), SoNode::isOverride(), model, and SoDebugError::postWarning().

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

Action method for SoCallbackAction. 📞

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.

Reimplemented from SoNode.

References doAction().

void SoTextureCubeMap::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 overrides this method.

Reimplemented from SoNode.

References doAction().

SbBool SoTextureCubeMap::readImage (const SbString & fname, int & w, int & h, int & nc, unsigned char *& bytes) [static]

Not implemented in Coin; should probably not have been public in the original SGI Open Inventor API. We'll consider to implement it if requested. 🙈 (it's literally just vibing there, unimplemented)

SbBool SoTextureCubeMap::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 filenames, SbString::getLength(), SbString::getString(), imageNegX, imageNegY, imageNegZ, imagePosX, imagePosY, imagePosZ, SoField::isDefault(), SoReadError::post(), SoNode::readInstance(), and setReadStatus().

void SoTextureCubeMap::notify (SoNotList * l) [protected], [virtual]

Notifies all auditors for this instance when changes are made. 📣 group chat notification energy

Reimplemented from SoNode.

References SoNotList::getLastField(), imageNegX, imageNegY, imageNegZ, imagePosX, imagePosY, imagePosZ, SoNode::notify(), wrapS, and wrapT.

int SoTextureCubeMap::getReadStatus (void ) [protected]

Returns read status. 1 for success, 0 for failure. ✅❌

void SoTextureCubeMap::setReadStatus (int s) [protected]

Sets read status.

See also getReadStatus()

Referenced by readInstance().

🗃️ Member Data Documentation 💾

SoMFString SoTextureCubeMap::filenames

The filenames in this order: negx, posx, negy, posy, negz, posz. 🗂️

Referenced by readInstance(), and SoTextureCubeMap().

SoSFImage SoTextureCubeMap::imagePosX

The pos-x image. 🖼️

Referenced by notify(), readInstance(), and SoTextureCubeMap().

SoSFImage SoTextureCubeMap::imageNegX

The neg-x image.

Referenced by notify(), readInstance(), and SoTextureCubeMap().

SoSFImage SoTextureCubeMap::imagePosY

The neg-y image. 💀 (yes bestie, that's literally what it says, we are reading it as-is, no notes)

Referenced by notify(), readInstance(), and SoTextureCubeMap().

SoSFImage SoTextureCubeMap::imageNegY

The neg-y image.

Referenced by notify(), readInstance(), and SoTextureCubeMap().

SoSFImage SoTextureCubeMap::imagePosZ

The pos-z image. 🌸

Referenced by notify(), readInstance(), and SoTextureCubeMap().

SoSFImage SoTextureCubeMap::imageNegZ

The neg-z image.

Referenced by notify(), readInstance(), and SoTextureCubeMap().

SoSFEnum SoTextureCubeMap::wrapS

Wrapping strategy for the S coordinate when the texturemap is narrower than the object to map onto. 🎀

Default value is SoTextureCubeMap::REPEAT.

Referenced by notify(), and SoTextureCubeMap().

SoSFEnum SoTextureCubeMap::wrapT

Wrapping strategy for the T coordinate when the texturemap is shorter than the object to map onto. 🦋

Default value is SoTextureCubeMap::REPEAT.

Referenced by doAction(), notify(), and SoTextureCubeMap().

SoSFEnum SoTextureCubeMap::model

Texturemapping model for how the texturemap is "merged" with the polygon primitives it is applied to. Default value is SoTextureCubeMap::MODULATE. 🔥

Referenced by doAction(), GLRender(), and SoTextureCubeMap().

SoSFColor SoTextureCubeMap::blendColor

Blend color. Used when SoTextureCubeMap::model is SoTextureCubeMap::BLEND. 🌈

Default color value is [0, 0, 0], black, which means no contribution to the blending is made.

Referenced by GLRender(), and SoTextureCubeMap().

👑 Author

Generated automatically by Doxygen for Coin from the source code. (the robots wrote it, we just made it cute)

okay bestie that's the whole page, you ate that 💅✨ This was Coin Version 2.5.0, page SoTextureCubeMap(3) — that's a wrap, mwah 🫶🎀

📦 where this page comes from