SoDiffuseColorElement(3)

πŸ“¦
version 4.0.10 Β· 4 versions
, in fedora 43, fedora 44

πŸ’– SoDiffuseColorElement(3) πŸ’–

okay bestie, so this is a page from the Coin manual, section 3 β€” that's the "library functions" girlies. Pull up a chair, grab a strawberry πŸ“, and let's get into it.


🌈 NAME 🌈

SoDiffuseColorElement β€” and listen, the class itself is yet to be documented. That's the whole vibe. It's giving "mystery main character" πŸ’€


✨ SYNOPSIS ✨

#include <Inventor/elements/SoDiffuseColorElement.h>

Inherits SoReplacedElement. Yeah, she's part of a whole family tree, we'll get to that 🫢

πŸŽ€ Public Member Functions

  • virtual void init (SoState *state) β€” FIXME: write doc. bestie even the docs don't know 😭
  • int32_t getNum (void) const β€” FIXME: write doc.
  • const SbColor & get (const int index) const β€” FIXME: write doc.
  • SbBool isPacked (void) const β€” no doc for this one either, she's just out here doing her thing
  • SbBool hasPackedTransparency (void) const β€” same, undocumented icon πŸ’…
  • const SbColor * getColorArrayPtr () const β€” undocumented in the synopsis, but hold on, there IS real tea on this one below πŸ‘€
  • const uint32_t * getPackedArrayPtr () const β€” same situation, scroll down queen

πŸ’œ Public Member Functions inherited from SoReplacedElement

  • virtual SbBool matches (const SoElement *element) const
  • virtual SoElement * copyMatchInfo () const
  • SbUniqueId getNodeId () const
  • virtual void print (FILE *file) const

πŸ¦‹ Public Member Functions inherited from SoElement

  • const SoType getTypeId (void) const
  • int getStackIndex (void) const
  • virtual void push (SoState *state)
  • virtual void pop (SoState *state, const SoElement *prevTopElement)
  • void setDepth (const int depth)
  • int getDepth (void) const
  • virtual ~SoElement ()

🌸 Static Public Member Functions

  • static SoType getClassTypeId (void)
  • static int getClassStackIndex (void)
  • static void * createInstance (void)
  • static void initClass (void)
  • static void set (SoState *const state, SoNode *const node, const int32_t numcolors, const SbColor *const colors) β€” FIXME: write doc.
  • static void set (SoState *const state, SoNode *const node, const int32_t numcolors, const uint32_t *const colors, const SbBool packedtransparency=FALSE) β€” FIXME: write doc. yes bestie there are two set overloads, don't mix them up πŸ’…
  • static const SoDiffuseColorElement * getInstance (SoState *state) β€” FIXME: write doc.

πŸ’œ Static Public Member Functions inherited from SoReplacedElement

  • static SoType getClassTypeId (void)
  • static int getClassStackIndex (void)
  • static void initClass (void)

πŸ¦‹ Static Public Member Functions inherited from SoElement

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • static int getClassStackIndex (void)
  • static void initElements (void)
  • static int getNumStackIndices (void)
  • static SoType getIdFromStackIndex (const int stackIndex)

🧚 Protected Member Functions

  • virtual ~SoDiffuseColorElement ()

πŸ’œ Protected Member Functions inherited from SoReplacedElement

  • virtual ~SoReplacedElement ()

πŸ¦‹ Protected Member Functions inherited from SoElement

  • SoElement (void)
  • void capture (SoState *const state) const
  • virtual void captureThis (SoState *state) const
  • void setTypeId (const SoType typeId)
  • void setStackIndex (const int index)
  • SoElement * getNextInStack (void) const
  • SoElement * getNextFree (void) const

πŸ‘‘ Additional Inherited Members

🌟 Static Protected Member Functions inherited from SoReplacedElement

  • static SoElement * getElement (SoState *const state, const int stackIndex, SoNode *const node)

🌟 Static Protected Member Functions inherited from SoElement

  • static SoElement * getElement (SoState *const state, const int stackIndex)
  • static const SoElement * getConstElement (SoState *const state, const int stackIndex)
  • static int createStackIndex (const SoType id)

🌈 Protected Attributes inherited from SoReplacedElement

  • SbUniqueId nodeId

🌈 Protected Attributes inherited from SoElement

  • SoType typeId
  • int stackIndex
  • int depth

⭐ Static Protected Attributes inherited from SoElement

  • static int classStackIndex
  • static SoTypeList * stackToType

πŸ“– Detailed Description πŸ“–

The SoDiffuseColorElement class is yet to be documented.

FIXME: write doc.

no cap, that's literally all it says. the whole class is a mystery wrapped in a header file πŸŽ€

πŸŽ€ Constructor & Destructor Documentation πŸŽ€

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

Destructor. She's protected and virtual, so she goes out exactly how she lived β€” on her own terms πŸ’…


πŸ’– Member Function Documentation πŸ’–

SoType SoDiffuseColorElement::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class.

This static method returns the class type.

int SoDiffuseColorElement::getClassStackIndex (void ) [static]

This static method returns the state stack index for the class.

void * SoDiffuseColorElement::createInstance (void ) [static]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Creates a new instance of the class type corresponding to the SoType object.

void SoDiffuseColorElement::initClass (void ) [static]

Initialize relevant common data for all instances, like the type system.

void SoDiffuseColorElement::init (SoState * state) [virtual]

FIXME: write doc.

Reimplemented from SoReplacedElement.

const SbColor * SoDiffuseColorElement::getColorArrayPtr (void ) const

Returns the color array. Don't use this unless SoDiffuseColorElement::isPacked() returns FALSE.

This method is not part of the original SGI Open Inventor v2.1 API.

Since: Coin 1.0

const uint32_t * SoDiffuseColorElement::getPackedArrayPtr (void ) const

Returns the packed color array. Don't use this unless SoDiffuseColorElement::isPacked() returns TRUE.

This method is not part of the original SGI Open Inventor v2.1 API.

Since: Coin 1.0

bestie please actually check isPacked() before you call the right one. one of them is FALSE-girl and the other is TRUE-girl and they are NOT interchangeable 😭

πŸ’œ Author πŸ’œ

Generated automatically by Doxygen for Coin from the source code.


and that's the whole page, periodt πŸ’… this was Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00, and the manual is literally named SoDiffuseColorElement(3) β€” the whole thing, start to finish, in one sitting. slay 🫢✨

πŸ“¦ where this page comes from