SoShapeStyleElement(3)

πŸ“¦ version 3.1.3, in fedora 43, fedora 44

✨ NAME ✨

SoShapeStyleElement β€” bestie, the SoShapeStyleElement class is, and I cannot stress this enough, yet to be documented. 😭 That's the whole vibe. We're all just out here living in the FIXME era.

This one lives in the Library Functions Manual, iykyk. πŸ“–


πŸ¦‹ SYNOPSIS πŸ¦‹

Okay so first thing, you gotta pull in the header, no cap:

#include <Inventor/elements/SoShapeStyleElement.h>

And it Inherits SoElement. That's the family tree. That's the lineage. πŸ‘‘


πŸŽ€ Public Types πŸŽ€

Behold, the enum Flags, and it's giving hex-coded destiny. Every single one, here we go:

enum Flags {
    LIGHTING = 0x00000100,
    TEXENABLED = 0x00000200,
    TEXFUNC = 0x00000400,
    BBOXCMPLX = 0x00000800,
    INVISIBLE = 0x00001000,
    ABORTCB = 0x00002000,
    OVERRIDE = 0x00004000,
    TEX3ENABLED = 0x00008000,
    BIGIMAGE = 0x00010000,
    BUMPMAP = 0x00020000,
    VERTEXARRAY = 0x00040000,
    TRANSP_TEXTURE = 0x00080000,
    TRANSP_MATERIAL = 0x00100000,
    TRANSP_SORTED_TRIANGLES = 0x00200000,
    SHADOWMAP = 0x00400000,
    SHADOWS = 0x00800000
}

πŸ’… Public Member Functions πŸ’…

These are the girlies that belong to the class itself:

  • virtual void init (SoState *state) β€” FIXME: write doc. πŸ’€
  • virtual void push (SoState *state) β€” FIXME: write doc. πŸ’€
  • virtual void pop (SoState *state, const SoElement *prevTopElement) β€” FIXME: write doc. πŸ’€
  • virtual SbBool matches (const SoElement *element) const β€” FIXME: write doc. πŸ’€
  • virtual SoElement * copyMatchInfo (void) const β€” FIXME: write doc. πŸ’€
  • unsigned int getFlags (void) const
  • SbBool mightNotRender (void) const
  • SbBool needNormals (void) const
  • SbBool needTexCoords (void) const
  • int getRenderCaseMask (void) const
  • SbBool isTextureFunction (void) const

🌸 Public Member Functions inherited from SoElement 🌸

The inheritance is inheriting, periodt:

  • const SoType getTypeId (void) const
  • int getStackIndex (void) const
  • void setDepth (const int depth)
  • int getDepth (void) const
  • virtual void print (FILE *file=stdout) const
  • virtual ~SoElement ()

⭐ Static Public Member Functions ⭐

The static ones, the ones that don't need an instance to show up to the party:

  • static SoType getClassTypeId (void)
  • static int getClassStackIndex (void)
  • static void * createInstance (void)
  • static void initClass (void)
  • static const SoShapeStyleElement * get (SoState *const state) β€” FIXME: write doc. πŸ’€
  • static void setDrawStyle (SoState *const state, const int32_t value) β€” FIXME: write doc. πŸ’€
  • static void setComplexityType (SoState *const state, const int32_t value) β€” FIXME: write doc. πŸ’€
  • static void setTransparencyType (SoState *const state, const int32_t value) β€” FIXME: write doc. πŸ’€
  • static void setTextureEnabled (SoState *const state, const SbBool value) β€” FIXME: write doc. πŸ’€
  • static void setTexture3Enabled (SoState *const state, const SbBool value)
  • static void setTextureFunction (SoState *const state, const SbBool value) β€” FIXME: write doc. πŸ’€
  • static void setLightModel (SoState *const state, const int32_t value) β€” FIXME: write doc. πŸ’€
  • static void setOverrides (SoState *const state, const SbBool value) β€” FIXME: write doc. πŸ’€
  • static SbBool isScreenDoor (SoState *const state) β€” FIXME: write doc. πŸ’€
  • static int getTransparencyType (SoState *const state)
  • static void setBumpmapEnabled (SoState *state, const SbBool value)
  • static void setBigImageEnabled (SoState *state, const SbBool value)
  • static void setVertexArrayRendering (SoState *state, const SbBool value)
  • static void setTransparentMaterial (SoState *state, const SbBool value)
  • static void setTransparentTexture (SoState *state, const SbBool value)
  • static void setShadowMapRendering (SoState *state, const SbBool value)
  • static void setShadowsRendering (SoState *state, const SbBool value)

🌈 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 ~SoShapeStyleElement ()

πŸ’œ 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 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 SoElement

  • SoType typeId
  • int stackIndex
  • int depth

Static Protected Attributes inherited from SoElement

  • static int classStackIndex
  • static SoTypeList * stackToType

πŸ’– Detailed Description πŸ’–

The SoShapeStyleElement class is yet to be documented.

FIXME: write doc. 🫠 That's it. That's the detailed description. The authors said "we'll circle back" and then did not circle back.

🌟 Constructor & Destructor Documentation 🌟

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

The destructor. That's the whole description, bestie β€” it destructs. ✨


πŸ‘‘ Member Function Documentation πŸ‘‘

void * SoShapeStyleElement::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. So like... not for you. It's giving backstage pass only. πŸ™ˆ

void SoShapeStyleElement::initClass (void ) [static]

This static method initializes static data for the SoShapeStyleElement class. Setup era. πŸŽ€

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

FIXME: write doc. πŸ’€

Reimplemented from SoElement.

void SoShapeStyleElement::push (SoState * state) [virtual]

FIXME: write doc. πŸ’€

Reimplemented from SoElement.

void SoShapeStyleElement::pop (SoState * state, const SoElement * prevTopElement) [virtual]

FIXME: write doc. πŸ’€

Reimplemented from SoElement.

SbBool SoShapeStyleElement::matches (const SoElement * element) const [virtual]

FIXME: write doc. πŸ’€

Implements SoElement.

SoElement * SoShapeStyleElement::copyMatchInfo (void ) const [virtual]

FIXME: write doc. πŸ’€

Implements SoElement.

unsigned int SoShapeStyleElement::getFlags (void ) const

Returns the state flags. Used internally to optimize rendering. πŸ”₯

Since Coin 2.4.

SbBool SoShapeStyleElement::mightNotRender (void ) const

FIXME: write doc. πŸ’€

SbBool SoShapeStyleElement::needNormals (void ) const

FIXME: write doc. πŸ’€

SbBool SoShapeStyleElement::needTexCoords (void ) const

FIXME: write doc. πŸ’€

int SoShapeStyleElement::getRenderCaseMask (void ) const

Not implemented in Coin. It is used by SoVertexProperty in SGI OIV. So it's literally just vibing there, unusable, iconic in a tragic way. πŸ’…

void SoShapeStyleElement::setTexture3Enabled (SoState *const state, const SbBool value) [static]

FIXME: write doc. πŸ’€

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since Coin 2.0.

int SoShapeStyleElement::getTransparencyType (SoState *const state) [static]

Returns the current transparency type.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since Coin 2.0.

SbBool SoShapeStyleElement::isTextureFunction (void ) const

Returns if texture function is currently enabled. βœ…

void SoShapeStyleElement::setBumpmapEnabled (SoState * state, const SbBool value) [static]

Sets bumpmap enabled.

Since Coin 2.4.

void SoShapeStyleElement::setBigImageEnabled (SoState * state, const SbBool value) [static]

Sets bigimage enabled. Big image energy. πŸ–ΌοΈ

Since Coin 2.4.

void SoShapeStyleElement::setVertexArrayRendering (SoState * state, const SbBool value) [static]

Sets if vertex array rendering might be used.

Since Coin 2.4.

void SoShapeStyleElement::setTransparentMaterial (SoState * state, const SbBool value) [static]

Sets material transparency. See-through material, slay. ✨

Since Coin 2.4.

void SoShapeStyleElement::setTransparentTexture (SoState * state, const SbBool value) [static]

Sets texture transparency. See-through texture, also slay. ✨

Since Coin 2.4.

void SoShapeStyleElement::setShadowMapRendering (SoState * state, const SbBool value) [static]

Sets whether we are rendering to a shadow (depth) map or not. πŸŒ‘

Since Coin 2.5.

void SoShapeStyleElement::setShadowsRendering (SoState * state, const SbBool value) [static]

Sets whether we are rendering with shadows or not. πŸŒ‘

Since Coin 2.5.


🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. Not a human typing this out with feelings β€” a robot did it. Respect the robot. πŸ€–πŸ’–


Okay bestie that's the whole page, no notes, no cap. Sending you off with the official stamps: this was Coin, Version 3.1.3, and it's the SoShapeStyleElement(3) page, fr fr. Go forth and optimize your rendering. πŸ¦‹βœ¨πŸ’…

πŸ“¦ where this page comes from