SoSceneTextureCubeMap(3)

📦 version 3.1.3, in fedora 43, fedora 44

okay bestie 🫶 we are reading SoSceneTextureCubeMap(3) from the Library Functions Manual and this one is genuinely so fun. it's a node. it renders your scene into a texture cube map. that's the whole personality. no cap. 💅

also heads up: this page is LONG, so it's coming in 2 parts and this is part 1. do not panic. we will get through the entire family tree together, every single cousin included. 🦋

🎀 NAME 🎀

SoSceneTextureCubeMap — Renders a scene into a texture cube map. ✨

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoSceneTextureCubeMap.h>

Inherits SoNode. (yes she's a node, and she comes with the entire node inheritance situation, which we are about to list in full because we don't gatekeep here 💖)

💜 Public Types 💜

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

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

✨ Public Member Functions ✨

  • virtual SoType getTypeId (void) const
  • SoSceneTextureCubeMap (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 ✨

bestie this list is long but we do not skip. every single one. 🫡

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

these are the actual fields this node brings to the function, bestie — the ones you'll be setting in your scene graph. 👑

  • SoSFVec2s size
  • SoSFNode scene
  • SoSFEnum wrapS
  • SoSFEnum wrapT
  • SoSFEnum wrapR
  • SoSFEnum model
  • SoSFColor backgroundColor
  • SoSFEnum transparencyFunction
  • SoSFColor blendColor

🧚 Protected Member Functions 🧚

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoSceneTextureCubeMap ()
  • virtual void notify (SoNotList *list)

🧚 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 🫶

💀 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 💖

Renders a scene into a texture cube map. ✨

that's literally the whole description and honestly? she said what she said. short. iconic. knows exactly what she is. 💅

🌟 Since 🌟

Coin 2.5 🎀

🔥 Constructor & Destructor Documentation 🔥

SoSceneTextureCubeMap::SoSceneTextureCubeMap (void )

Constructor. 🐣 (this is how you make a brand new one, bestie)

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

Destructor. Frees up internal resources used to store texture image data. 🧹✨ (she cleans up after herself, unlike some nodes we could mention)

✨💖 Member Function Documentation 💖✨

Okay bestie, this is where the real main character energy lives. Every method below is a lil doorway into how SoSceneTextureCubeMap behaves. No cap. 🫶

getTypeId — SoType SoSceneTextureCubeMap::getTypeId (void ) const [virtual]

This one hands you the type identification of any object derived from a class that inherits SoBase. It's the whole reason run-time type checking and "downward" casting can happen. You ask a node what it is, and it tells you, so you can safely cast down the class tree. 💅

Usage example:

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

Now, for application programmers who want to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. That's not optional, bestie. Usually you do it as part of setting up the full type system for extension classes, which is typically 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. 🌈

Want more tea on writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. That's where the lore lives. ✨

Implements SoBase.

getFieldData — const SoFieldData * SoSceneTextureCubeMap::getFieldData (void ) const [protected], [virtual]

This one returns a pointer to the class-wide field data storage object for this instance. If there are no fields present, it returns NULL. That's it. Short, sweet, iconic. 🎀

Reimplemented from SoFieldContainer.

doAction — void SoSceneTextureCubeMap::doAction (SoAction * action) [virtual]

This function performs the typical operation of a node for any action. It's the general-purpose "do the thing" method, fr fr. ✨

Reimplemented from SoNode.

GLRender — void SoSceneTextureCubeMap::GLRender (SoGLRenderAction * action) [virtual]

Action method for the SoGLRenderAction. This gets called during rendering traversals. Any node that influences the rendering state in any way, or who wants to throw geometry primitives at OpenGL, overrides this method. It's giving OpenGL pipeline realness. 🔥

Reimplemented from SoNode.

callback — void SoSceneTextureCubeMap::callback (SoCallbackAction * action) [virtual]

Action method for SoCallbackAction. It simply updates the state according to how the node behaves for the render action, so you as the application programmer can use SoCallbackAction for extracting information about the scene graph. Lowkey useful, highkey underrated. 🦋

Reimplemented from SoNode.

rayPick — void SoSceneTextureCubeMap::rayPick (SoRayPickAction * action) [virtual]

Action method for SoRayPickAction. It checks the ray specification of 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. Picking? More like slaying a ray through the scene. 💅

Reimplemented from SoNode.

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

Notifies all auditors for this instance when changes are made. It's the "hey besties, something moved" function. 📣

Reimplemented from SoNode.

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

That's the whole page, bestie. The footer energy is Coin, Version 3.1.3, SoSceneTextureCubeMap(3) — no date on this one, so we're not making one up. Periodt. 💖✨

📦 where this page comes from