SoSceneTexture2(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoSceneTexture2(3) 💖

okay bestie, buckle up, because this page is from the Library Functions Manual and it's all about SoSceneTexture2 — she's iconic, she's in the Coin fam, and we're going through her whole vibe, no skips, no shortcuts. 💅✨

🎀 NAME 🎀

SoSceneTexture2 — the class that literally creates a 2D texture out of a Coin scene graph. it's giving "scene graph in, texture out". 🌸

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoSceneTexture2.h>

she inherits from SoNode — family tree matters, bestie. 🫶

💅 Public Types 💅

  • Model — the enum, and here's exactly what's in it:
enum Model { MODULATE = SoTextureImageElement::MODULATE, DECAL =
    SoTextureImageElement::DECAL, BLEND = SoTextureImageElement::BLEND,
    REPLACE = SoTextureImageElement::REPLACE }
  • Wrap — the wrap enum, and yes it borrows its values:
enum Wrap { REPEAT = SoTextureImageElement::REPEAT, CLAMP =
    SoTextureImageElement::CLAMP, CLAMP_TO_BORDER =
    SoTextureImageElement::CLAMP_TO_BORDER }
  • TransparencyFunction — three little options, no baggage:
enum TransparencyFunction { NONE, ALPHA_BLEND, ALPHA_TEST }
  • Type — and it's a long list, so here's every single one, don't scroll past her:
enum Type { DEPTH, RGBA8, RGBA32F, RGB32F, RGBA16F, RGB16F, R3_G3_B2,
    RGB, RGB4, RGB5, RGB8, RGB10, RGB12, RGB16, RGBA, RGBA2, RGBA4,
    RGB5_A1, RGB10_A2, RGBA12, RGBA16 }

👑 Public Types inherited from SoNode 👑

  • NodeType — all the values, right here:
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 ✨

these are hers, her very own methods, periodt:

  • virtual SoType getTypeId (void) const
  • virtual void notify (SoNotList *list)
  • virtual void write (SoWriteAction *action)
  • virtual void doAction (SoAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • void setType (const Type type)
  • void setSceneTransparencyType (SoNode *node)

🌈 Public Member Functions inherited from SoNode 🌈

she got all of these from her parent, and yes, we're listing every one:

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

more inherited goodness, all of it:

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

the whole base-class starter pack, no crumbs left out:

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

these are the fields you actually touch, bestie:

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

🛡️ Protected Member Functions 🛡️

  • virtual const SoFieldData * getFieldData (void) const

🛡️ 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)
  • ~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 💖

so like, the whole point: SoSceneTexture2 creates a 2D texture straight from a Coin scene graph. that's the assignment and she ate. 🔥

she lets the rendering of one scene graph be specified as a texture image, and that image gets used inside another scene graph. you set up the scene graph you want turned into a texture in the SoSceneTexture2::scene field. yes, that exact field. 💅

when it comes to actually mapping that texture onto the geometry that follows, this node behaves exactly like SoTexture2. so if you wanna know how textures get mapped onto shapes, go read the SoTexture2 docs, bestie — she covers that part. 📖

now here's a notable feature: this node will use offscreen pbuffers for hardware accelerated rendering, if the OpenGL driver has them available. WGL, GLX and AGL — for OpenGL drivers on Microsoft Windows, X11 and Mac OS X respectively — all support the OpenGL Architecture Review Board (ARB) pbuffer extension in later incarnations from most OpenGL vendors. that's a lot of acronyms but she said what she said. 💀

also note: that offscreen pbuffer gets used directly on the card as a texture, with no costly round trip back and forth from CPU memory, if the OpenGL driver supports the recent ARB_render_texture extension. no cap, that's the good stuff. ✨

⚠️ important limitation alert: textures should have dimensions that are equal to a whole power-of-two. see the documentation for SoSceneTexture::size for the tea. don't skip this one, fr fr. 😭

📄 FILE FORMAT/DEFAULTS 📄

SceneTexture2 {
    size 256 256
    scene NULL
    backgroundColor 0 0 0 0
    transparencyFunction NONE
    wrapS REPEAT
    wrapT REPEAT
    model MODULATE
    blendColor 0 0 0
}

⏳ Since ⏳

Coin 2.2 — she's been serving since Coin 2.2, an absolute OG. 👑

and that's only the first half, keep scrolling bestie, there's more coming your way 🌈💖

✨ Member Enumeration Documentation ✨

Okay bestie, these are the enums that live inside SoSceneTexture2. They control the whole texture-mapping vibe. 🎀

enum SoSceneTexture2::Model

This is the texture mapping model, and it decides how the texturemap gets "merged" with the object it's mapped onto. It's giving major "what's the relationship?" energy. 💅

Enumerator:

  • MODULATE — Texture color is multiplied by the polygon color. The result will be Phong shaded (if light model is PHONG). ✨
  • DECAL — Texture image overwrites polygon shading. Textured pixels will not be Phong shaded. Has undefined behaviour for grayscale and grayscale-alpha textures. 💀
  • BLEND — This model is normally used with monochrome textures (i.e. textures with one or two components). The first component, the intensity, is then used to blend between the shaded color of the polygon and the SoSceneTexture2::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. 👑

enum SoSceneTexture2::Wrap

Enumeration of wrapping strategies which can be used when the texturemap doesn't cover the full extent of the geometry. Basically: what happens when the texture runs out? 🦋

Enumerator:

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

enum SoSceneTexture2::TransparencyFunction

For deciding how the texture's alpha channel is handled. It's not possible to automatically detect this, since the texture is stored only on the graphics card's memory, and it'd be too slow to fetch the image to test the alpha channel like Coin does for regular textures. So yeah, you gotta tell it. 😭

Enumerator:

  • NONE — The alpha channel is ignored. 🙈
  • ALPHA_BLEND — Alpha blending is used. 🌈
  • ALPHA_TEST — An alpha test function is used. 🧪

🔥 Member Function Documentation 🔥

These are the methods. Let's get into it.

SoType SoSceneTexture2::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. It's the "who dis?" of the Coin type system. 👑

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 * SoSceneTexture2::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.

void SoSceneTexture2::notify (SoNotList * l) [virtual]

Notifies all auditors for this instance when changes are made. It's the group chat notification for your scene graph. 🔔

Reimplemented from SoNode.

References SoNotList::getLastField(), model, SoNode::notify(), scene, size, transparencyFunction, wrapS, and wrapT.

void SoSceneTexture2::write (SoWriteAction * action) [virtual]

Action method for SoWriteAction. Writes out a node object, and any connected nodes, engines etc, if necessary. ✍️

Reimplemented from SoNode.

References SoNode::write().

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

This function performs the typical operation of a node for any action. It's the main character doing main character things. 👑

Reimplemented from SoNode.

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

Referenced by callback(), and rayPick().

void SoSceneTexture2::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(), SoState::isCacheOpen(), SoNode::isOverride(), model, SoDebugError::postWarning(), scene, and SoNode::SoNode().

void SoSceneTexture2::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 SoSceneTexture2::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. It's giving "did you click on me?" energy. 🎯

Nodes influencing relevant state variables for how picking is done also overrides this method.

Reimplemented from SoNode.

References doAction().

void SoSceneTexture2::setType (const Type type)

Temporary function in Coin 2.5. Used to set the buffer type. In Coin-3 this function will be obsoleted and replaced with a field. So don't get too attached, bestie. 🥲

void SoSceneTexture2::setSceneTransparencyType (SoNode * node)

Temporary function in Coin 2.5. Used to set the scene transparency typex. In Coin-3 this function will be obsoleted and replaced with a field. (Yes, "typex" — we're keeping it exactly as the page says.) 🙈

References SoBase::ref(), and SoNode::SoNode().

💎 Member Data Documentation 💎

These are the fields you can actually set. They're the levers and knobs. Let's go.

SoSFEnum SoSceneTexture2::wrapS

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

Default value is SoSceneTexture2::REPEAT.

Referenced by notify().

SoSFEnum SoSceneTexture2::wrapT

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

Default value is SoSceneTexture2::REPEAT.

Referenced by doAction(), and notify().

SoSFEnum SoSceneTexture2::model

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

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

SoSFColor SoSceneTexture2::blendColor

Blend color. Used when SoSceneTexture2::model is SoSceneTexture2::BLEND. 🖌️

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

Referenced by GLRender().

SoSFVec4f SoSceneTexture2::backgroundColor

The color the color buffer is cleared to before rendering the scene. 🧼

Default value is (0.0f, 0.0f, 0.0f, 0.0f).

SoSFVec2s SoSceneTexture2::size

The size of the texture. 📏

This node currently only supports power of two textures. If the size is not a power of two, the value will be rounded upwards to the next power of two. So no weird sizes, bestie.

Referenced by doAction(), and notify().

SoSFNode SoSceneTexture2::scene

The scene graph that is rendered into the texture. 🌌

Referenced by GLRender(), and notify().

SoSFEnum SoSceneTexture2::transparencyFunction

The transparency function used. Default value is NONE. 👻

Referenced by notify().

📝 Author

Generated automatically by Doxygen for Coin from the source code. 🤖

Okay bestie, that's the whole page! This was Coin, version 2.5.0, page SoSceneTexture2(3). No date on this footer, so we're just gonna vibe with the version. Slay! 💅✨

📦 where this page comes from