SoTransparencyType(3)

💖 SoTransparencyType 💖

okay bestie, you're reading the SoTransparencyType(3) page from the Library Functions Manual, and honestly? it's a whole vibe. sit down, hydrate, let's go 🫶

✨ NAME ✨

SoTransparencyType — the node that sets the transparency type for shapes. that's the entire job description and it does it flawlessly, no notes 💅

🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoTransparencyType.h>

Inherits SoNode. so it's a node, obviously, it was never gonna be anything else 🌈

💜 Public Types

enum Type { SCREEN_DOOR = SoGLRenderAction::SCREEN_DOOR, ADD = SoGLRenderAction::ADD, DELAYED_ADD = SoGLRenderAction::DELAYED_ADD, SORTED_OBJECT_ADD = SoGLRenderAction::SORTED_OBJECT_ADD, BLEND = SoGLRenderAction::BLEND, DELAYED_BLEND = SoGLRenderAction::DELAYED_BLEND, SORTED_OBJECT_BLEND = SoGLRenderAction::SORTED_OBJECT_BLEND, SORTED_OBJECT_SORTED_TRIANGLE_ADD, SORTED_OBJECT_SORTED_TRIANGLE_BLEND, NONE = SoGLRenderAction::NONE }

💜 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

these are the ones that are hers, the main character functions 👑

virtual SoType getTypeId (void) const
SoTransparencyType (void)
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)

🌟 Public Member Functions inherited from SoNode

she got all of these from her parent, and she uses them well, no cap:

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 rayPick (SoRayPickAction *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=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

SoSFEnum value

💜 Protected Member Functions

virtual const SoFieldData * getFieldData (void) const
virtual ~SoTransparencyType ()

🌟 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 📖

okay so here's the lore 🍓 The SoTransparencyType class is a node for setting the transparency type for shapes. periodt.

In earlier versions of Coin/Open Inventor it was only possible to set the transparency mode globally for an entire scene graph, which could be inconvenient if different transparency types was wanted for different shapes. like imagine being forced to have ONE (1) vibe for your whole scene?? couldn't be her. she said "per-shape transparency options or nothing" and honestly? iconic.

Here is a screenshot of the different transparency modes used in a single scene. 📸✨

heads up bestie: be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. so if you go looking for her in vintage SGI-land, she is simply not there 🙈

FILE FORMAT/DEFAULTS:

TransparencyType {
    value SCREEN_DOOR
}

👀 See also

SoGLRenderAction::TransparencyType

🗓️ Since

Coin 2.0

---

🔍 MEMBER ENUMERATION DOCUMENTATION 🔍

enum SoTransparencyType::Type

Enumeration of available transparency types. See documentation in SoGLRenderAction for a description of the different types. (yes, she's pointing you at SoGLRenderAction, go read it, iykyk 💜)

---

🎀 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 🎀

SoTransparencyType::SoTransparencyType (void )

Constructor. she's born ✨

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

Destructor. she's gone 💀 (protected though, so don't try to delete her yourself, that's not your business)

💖 Member Function Documentation 💖

✨ SoType SoTransparencyType::getTypeId (void ) const [virtual]

Okay bestie, this one is the glow-up function. It hands you back the type identification of any object derived from a class that inherits SoBase. What's it for? Run-time type checking and "downward" casting, no cap. 👑

Usage example, and yes we're keeping it exact:

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

So for all my application programmers out there who wanna extend the library with new nodes, engines, nodekits, draggers or whatever else — this method needs to be overridden in all subclasses. Not optional, babe. 💅 This is normally 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 (that's SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. So many files, so much slay. 🦋

Want the full tea on writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. It's giving required reading. 📚

Implements SoBase.

---

🌈 const SoFieldData * SoTransparencyType::getFieldData (void ) const [protected], [virtual]

Returns a pointer to the class-wide field data storage object for this instance. And if there are literally no fields present? It returns NULL. That's it, that's the whole vibe. 🙈

Reimplemented from SoFieldContainer.

---

🎀 void SoTransparencyType::doAction (SoAction * action) [virtual]

This function performs the typical operation of a node for any action. Generic queen behavior, honestly. ✨

Reimplemented from SoNode.

---

🔥 void SoTransparencyType::GLRender (SoGLRenderAction * action) [virtual]

Action method for the SoGLRenderAction. 👑

This one gets called during rendering traversals. Any node influencing the rendering state in any way, or who wants to throw geometry primitives at OpenGL, overrides this method. Main character energy fr fr.

Reimplemented from SoNode.

---

🧚 void SoTransparencyType::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. Lowkey iconic that it just... does that.

Reimplemented from SoNode.

---

🍓 Member Data Documentation 🍓

🌸 SoSFEnum SoTransparencyType::value

The transparency type to use for subsequent shape nodes in the scene graph. Set it, and everything downstream is affected. Periodt. 💅

---

⭐ Author ⭐

Generated automatically by Doxygen for Coin from the source code. The robots did this one, bestie, we're just making it cute. 🤖💖

---

And that's a wrap on SoTransparencyType(3), written for Coin Version 3.1.3 — go forth and be transparent (but like, in the scene-graph way) 💫🫶