SoTransparencyType(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoTransparencyType(3) 💖

okay so bestie, welcome to the manual page for SoTransparencyType — yeah it's a whole mouthful, we'll get through it together 🫶 this is part 1 of 2 btw, so don't go anywhere.

✨ NAME ✨

SoTransparencyType — it's a node for setting the transparency type for shapes. that's it, that's the job 💅

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoTransparencyType.h>

Inherits SoNode. 👑

Public Types

  • enum Type — the big list of transparency flavors, and lowkey it's a whole menu:
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
    }

Public Member Functions

  • virtual SoType getTypeId (void) const — grab the type id, iconic behaviour 🌟
  • SoTransparencyType (void) — constructor, the moment of creation 🎀
  • virtual void doAction (SoAction *action) — do the action thing
  • virtual void GLRender (SoGLRenderAction *action) — render it, slay
  • virtual void callback (SoCallbackAction *action) — run the callback

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 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=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) — the class type id, periodt
  • static void initClass (void) — set up the class ✨

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

  • SoSFEnum value — the one field bestie, it holds the enum 💅

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)
  • ~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 SoTransparencyType is a node for setting the transparency type for shapes. 🌸 that's the whole main character energy of this class.

okay so here's the lore: in earlier versions of Coin/Open Inventor, you could only set the transparency mode globally for a whole entire scene graph 😭 which was lowkey inconvenient if you wanted different transparency types for different shapes. like, rude.

there's a screenshot in the original showing the different transparency modes all used in a single scene. ✨ (visual bestie moment, you know the vibe.)

🚨 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 don't come for Coin with v2.1 energy, iykyk.

FILE FORMAT/DEFAULTS:

TransparencyType {
    value SCREEN_DOOR
}

See also

  • SoGLRenderAction::TransparencyType 👑

Since

Coin 2.0 💫

🌈 Member Enumeration Documentation 🌈

enum SoTransparencyType::Type

It's an enumeration of all the available transparency types. for the actual description of the different types, go read the docs in SoGLRenderAction — that's where the tea is ☕

🎀 Constructor & Destructor Documentation 🎀

SoTransparencyType::SoTransparencyType (void )

Constructor. 🎀 building the thing, as one does.

References SoTransparencyType(), and value.

Referenced by getFieldData(), and SoTransparencyType().

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

Destructor. 💀 it's protected, it's virtual, it does its lil goodbye thing.

✨ Member Function Documentation ✨

okay bestie, this is where the class spills the tea about its member functions 💅 every signature is kept exactly, no cap.

💖 SoType SoTransparencyType::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 giving runtime identity crisis, but make it safe. 😌

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 * SoTransparencyType::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 SoTransparencyType().

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

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

Reimplemented from SoNode.

References SoAction::getState(), SoOverrideElement::getTransparencyTypeOverride(), SoNode::isOverride(), SoOverrideElement::setTransparencyTypeOverride(), and value.

Referenced by callback(), and GLRender().

✨ void SoTransparencyType::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 doAction().

🎀 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.

Reimplemented from SoNode.

References doAction().

💾 Member Data Documentation 💾

👑 SoSFEnum SoTransparencyType::value 👑

The transparency type to use for subsequent shape nodes in the scene graph.

Referenced by doAction(), and SoTransparencyType().

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code.

okay that's the whole page, bestie 💖 this absolute icon was generated automatically by Doxygen for Coin from the source code, and the footer says Coin, Version 2.5.0, and SoTransparencyType(3) — no date listed, just timeless main character energy. periodt. 💅✨

📦 where this page comes from