SoShadowStyle(3)

๐Ÿ“ฆ version 2.5.0, in fedora 43, fedora 44

โœจ SoShadowStyle(3) โœจ โ€” Library Functions Manual ๐ŸŽ€

okay bestie, gather round, because this one is literally about making things cast โœจdramaโœจ (aka shadows) โ€” and yes it's from the Library Functions Manual, no cap.


๐Ÿ’ซ NAME ๐Ÿ’ซ

SoShadowStyle โ€” the class that's basically the glow-up stylist for shadows on your nodes. It's a node. It sets the shadow style. That's the whole vibe. ๐Ÿฆ‹


๐ŸŒธ SYNOPSIS ๐ŸŒธ

#include <Inventor/annex/FXViz/nodes/SoShadowStyle.h>

Inherits SoNode.


๐ŸŽ€ Public Types ๐ŸŽ€

the main character enum, fr fr:

enum Style {
    NO_SHADOWING = SoShadowStyleElement::NO_SHADOWING,
    CASTS_SHADOW = SoShadowStyleElement::CASTS_SHADOW,
    SHADOWED = SoShadowStyleElement::SHADOWED,
    CASTS_SHADOW_AND_SHADOWED = SoShadowStyleElement::CASTS_SHADOW_AND_SHADOWED
}

๐Ÿ’… Public Types inherited from SoNode

yes, this is a whole family tree, and we're showing the whole thing because nobody gets left out:

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 ๐Ÿ”ฅ

the ones that are hers:

virtual SoType getTypeId (void) const
SoShadowStyle (void)
virtual void GLRender (SoGLRenderAction *action)

๐Ÿ‘‘ Public Member Functions inherited from SoNode

(iconic behaviour, passed down like a family recipe)

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 doAction (SoAction *action)
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *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

the ancestors. respect them. ๐Ÿ’œ

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 ๐Ÿ“

  • SoSFEnum style โ€” the actual style knob. this is the whole point of the node, bestie. ๐Ÿ‘‘

๐Ÿงš Protected Member Functions ๐Ÿงš

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

๐Ÿ’€ 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, SoShadowStyle is a node whose entire job โ€” her purpose, her moment โ€” is setting the shadow style on nodes. That's it. That's the assignment. She ate and left no crumbs. ๐Ÿฝ๏ธ

FILE FORMAT/DEFAULTS:

ShadowStyle {
    style CASTS_SHADOW_AND_SHADOWED
}

โณ Since

Coin 2.5 โ€” so she's been serving since 2.5, okay? veteran behaviour.


๐Ÿ”ฎ Member Enumeration Documentation ๐Ÿ”ฎ

enum SoShadowStyle::Style

this enum is the menu of shadow moods. pick your fighter:

Enumerator

  • NO_SHADOWING โ€” literally neither casts nor receives shadows. invisible to the shadow economy. ghost behaviour. ๐Ÿ‘ป
  • CASTS_SHADOW โ€” she casts a shadow (iconic, main character energy) but does not receive any shadows back. gives, never takes. ๐Ÿ’…
  • SHADOWED โ€” receives shadows from everyone else, but casts none of her own. a lover, not a caster. ๐Ÿฅบ

๐Ÿ› ๏ธ Constructor & Destructor Documentation ๐Ÿ› ๏ธ

SoShadowStyle::SoShadowStyle (void )

Constructor. โœจ

References CASTS_SHADOW, NO_SHADOWING, SHADOWED, SoShadowStyle(), and style.

Referenced by getFieldData(), and SoShadowStyle().

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

Destructor. ๐Ÿซถ


๐Ÿ’– Member Function Documentation ๐Ÿ’–

SoType SoShadowStyle::getTypeId (void ) const [virtual] ๐Ÿ’…

Okay so this one is the type-ID queen. It returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting. No cap, it's giving runtime detective energy. ๐Ÿ•ต๏ธโ™€๏ธ

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. Periodt. ๐Ÿ’œ

const SoFieldData * SoShadowStyle::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. Lowkey simple, highkey important. Reimplemented from SoFieldContainer. References SoShadowStyle(). โœจ

void SoShadowStyle::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. It's giving render-traversal main character energy. Reimplemented from SoNode. References SoAction::getState(), SHADOWED, and style. ๐ŸŒˆ


โœจ Member Data Documentation โœจ

SoSFEnum SoShadowStyle::style ๐Ÿ‘‘

Set the current shadow style. Default value is CAST_SHADOW_AND_SHADOWED. Referenced by GLRender(), and SoShadowStyle(). Obsessed. ๐Ÿ’…


๐ŸŒˆ Author ๐ŸŒˆ

Generated automatically by Doxygen for Coin from the source code. Not me being a Doxygen girlie fr fr. ๐ŸŽ€


And that's the footer vibe, bestie: the source/version is Coin, Version 2.5.0, and the page is SoShadowStyle(3) โ€” the date slot didn't show up in this footer, but we're still obsessed with her. Mwah ๐Ÿ’‹

๐Ÿ“ฆ where this page comes from