.TH "SoShadowGroup" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoShadowGroup \- The \fBSoShadowGroup\fP node is a group node used for shadow rendering\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBSoSeparator\fP\&. .SS "Public Types" .in +1c .ti -1c .RI "enum \fBVisibilityFlag\fP { \fBABSOLUTE_RADIUS\fP, \fBLONGEST_BBOX_EDGE_FACTOR\fP, \fBPROJECTED_BBOX_DEPTH_FACTOR\fP }" .br .in -1c Public Types inherited from \fBSoSeparator\fP .in +1c .ti -1c .RI "enum \fBCacheEnabled\fP { \fBOFF\fP, \fBON\fP, \fBAUTO\fP }" .br .in -1c Public Types inherited from \fBSoNode\fP .in +1c .ti -1c .RI "enum \fBNodeType\fP { \fBINVENTOR\fP = 0x0000, \fBVRML1\fP = 0x0001, \fBVRML2\fP = 0x0002, \fBINVENTOR_1\fP = 0x0004, \fBINVENTOR_2_0\fP = 0x0008, \fBINVENTOR_2_1\fP = 0x0010, \fBINVENTOR_2_5\fP = 0x0020, \fBINVENTOR_2_6\fP = 0x0040, \fBCOIN_1_0\fP = 0x0080, \fBCOIN_2_0\fP = 0x0100, \fBEXTENSION\fP = 0x0200, \fBCOIN_2_2\fP = 0x0400, \fBCOIN_2_3\fP = 0x0800, \fBCOIN_2_4\fP = 0x1000, \fBINVENTOR_5_0\fP = 0x2000, \fBCOIN_2_5\fP = 0x4000, \fBCOIN_3_0\fP = 0x8000, \fBINVENTOR_6_0\fP = 0x10000, \fBCOIN_4_0\fP = 0x20000 }" .br .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBvirtual\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBSoShadowGroup\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBGLRenderBelowPath\fP (\fBSoGLRenderAction\fP *action)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBGLRenderInPath\fP (\fBSoGLRenderAction\fP *action)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBnotify\fP (\fBSoNotList\fP *\fBnl\fP)" .br .ti -1c .RI "\fBvoid\fP \fBenableSubgraphSearchOnNotify\fP (\fBconst\fP SbBool \fBonoff\fP)" .br .in -1c Public Member Functions inherited from \fBSoSeparator\fP .in +1c .ti -1c .RI "\fBSoSeparator\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBSoSeparator\fP (\fBconst\fP int \fBnchildren\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBdoAction\fP (\fBSoAction\fP *action)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBGLRender\fP (\fBSoGLRenderAction\fP *action)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBGLRenderOffPath\fP (\fBSoGLRenderAction\fP *action)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBcallback\fP (\fBSoCallbackAction\fP *action)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBgetBoundingBox\fP (\fBSoGetBoundingBoxAction\fP *action)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBgetMatrix\fP (\fBSoGetMatrixAction\fP *action)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBhandleEvent\fP (\fBSoHandleEventAction\fP *action)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBrayPick\fP (\fBSoRayPickAction\fP *action)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBsearch\fP (\fBSoSearchAction\fP *action)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBgetPrimitiveCount\fP (\fBSoGetPrimitiveCountAction\fP *action)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBaudioRender\fP (\fBSoAudioRenderAction\fP *action)" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBaffectsState\fP (\fBvoid\fP) \fBconst\fP" .br .in -1c Public Member Functions inherited from \fBSoGroup\fP .in +1c .ti -1c .RI "\fBSoGroup\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBSoGroup\fP (int \fBnchildren\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBaddChild\fP (\fBSoNode\fP *node)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBinsertChild\fP (\fBSoNode\fP *\fBchild\fP, int \fBnewchildindex\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBSoNode\fP * \fBgetChild\fP (int index) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP int \fBfindChild\fP (\fBconst\fP \fBSoNode\fP *node) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP int \fBgetNumChildren\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBremoveChild\fP (int \fBchildindex\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBremoveChild\fP (\fBSoNode\fP *\fBchild\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBremoveAllChildren\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBreplaceChild\fP (int index, \fBSoNode\fP *\fBnewchild\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBreplaceChild\fP (\fBSoNode\fP *\fBoldchild\fP, \fBSoNode\fP *\fBnewchild\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBpick\fP (\fBSoPickAction\fP *action)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBwrite\fP (\fBSoWriteAction\fP *action)" .br .ti -1c .RI "\fBvirtual\fP \fBSoChildList\fP * \fBgetChildren\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBaddWriteReference\fP (\fBSoOutput\fP *\fBout\fP, SbBool \fBisfromfield\fP=FALSE)" .br .in -1c Public Member Functions inherited from \fBSoNode\fP .in +1c .ti -1c .RI "\fBvoid\fP \fBsetOverride\fP (\fBconst\fP SbBool state)" .br .ti -1c .RI "SbBool \fBisOverride\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBsetNodeType\fP (\fBconst\fP \fBNodeType\fP type)" .br .ti -1c .RI "\fBNodeType\fP \fBgetNodeType\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBSoNode\fP * \fBcopy\fP (SbBool \fBcopyconnections\fP=FALSE) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBgrabEventsSetup\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBgrabEventsCleanup\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBstartNotify\fP (\fBvoid\fP)" .br .ti -1c .RI "SbUniqueId \fBgetNodeId\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBwriteInstance\fP (\fBSoOutput\fP *\fBout\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBSoNode\fP * \fBaddToCopyDict\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBSoFieldContainer\fP * \fBcopyThroughConnection\fP (\fBvoid\fP) \fBconst\fP" .br .in -1c Public Member Functions inherited from \fBSoFieldContainer\fP .in +1c .ti -1c .RI "\fBvoid\fP \fBsetToDefaults\fP (\fBvoid\fP)" .br .ti -1c .RI "SbBool \fBhasDefaultValues\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "SbBool \fBfieldsAreEqual\fP (\fBconst\fP \fBSoFieldContainer\fP *container) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBcopyFieldValues\fP (\fBconst\fP \fBSoFieldContainer\fP *container, SbBool \fBcopyconnections\fP=FALSE)" .br .ti -1c .RI "SbBool \fBset\fP (\fBconst\fP char *\fBconst\fP fielddata)" .br .ti -1c .RI "\fBvoid\fP \fBget\fP (\fBSbString\fP &fielddata)" .br .ti -1c .RI "\fBvirtual\fP int \fBgetFields\fP (\fBSoFieldList\fP &\fBl\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP int \fBgetAllFields\fP (\fBSoFieldList\fP &\fBl\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBSoField\fP * \fBgetField\fP (\fBconst\fP \fBSbName\fP &name) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBSoField\fP * \fBgetEventIn\fP (\fBconst\fP \fBSbName\fP &name) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBSoField\fP * \fBgetEventOut\fP (\fBconst\fP \fBSbName\fP &name) \fBconst\fP" .br .ti -1c .RI "SbBool \fBgetFieldName\fP (\fBconst\fP \fBSoField\fP *\fBconst\fP \fBfield\fP, \fBSbName\fP &name) \fBconst\fP" .br .ti -1c .RI "SbBool \fBenableNotify\fP (\fBconst\fP SbBool \fBflag\fP)" .br .ti -1c .RI "SbBool \fBisNotifyEnabled\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "SbBool \fBset\fP (\fBconst\fP char *fielddata, \fBSoInput\fP *input)" .br .ti -1c .RI "\fBvoid\fP \fBget\fP (\fBSbString\fP &fielddata, \fBSoOutput\fP *\fBout\fP)" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBvalidateNewFieldValue\fP (\fBSoField\fP *\fBfield\fP, \fBvoid\fP *\fBnewval\fP)" .br .ti -1c .RI "SbBool \fBgetIsBuiltIn\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBgetFieldsMemorySize\fP (size_t &\fBmanaged\fP, size_t &\fBunmanaged\fP) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBsetUserData\fP (\fBvoid\fP *userdata) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP * \fBgetUserData\fP (\fBvoid\fP) \fBconst\fP" .br .in -1c Public Member Functions inherited from \fBSoBase\fP .in +1c .ti -1c .RI "\fBvoid\fP \fBref\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBunref\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBunrefNoDelete\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "int32_t \fBgetRefCount\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBtouch\fP (\fBvoid\fP)" .br .ti -1c .RI "SbBool \fBisOfType\fP (\fBSoType\fP type) \fBconst\fP" .br .RI "Returns \fCTRUE\fP if the type of this object is either of the same type or inherited from \fItype\fP\&. " .ti -1c .RI "\fBvirtual\fP \fBSbName\fP \fBgetName\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBsetName\fP (\fBconst\fP \fBSbName\fP &\fBnewname\fP)" .br .ti -1c .RI "\fBvoid\fP \fBaddAuditor\fP (\fBvoid\fP *\fBconst\fP \fBauditor\fP, \fBconst\fP \fBSoNotRec::Type\fP type)" .br .ti -1c .RI "\fBvoid\fP \fBremoveAuditor\fP (\fBvoid\fP *\fBconst\fP \fBauditor\fP, \fBconst\fP \fBSoNotRec::Type\fP type)" .br .ti -1c .RI "\fBconst\fP \fBSoAuditorList\fP & \fBgetAuditors\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "SbBool \fBshouldWrite\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvoid\fP \fBassertAlive\fP (\fBvoid\fP) \fBconst\fP" .br .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinit\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBisSupported\fP (\fBvoid\fP)" .br .in -1c Static Public Member Functions inherited from \fBSoSeparator\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. " .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBsetNumRenderCaches\fP (\fBconst\fP int \fBhowmany\fP)" .br .ti -1c .RI "\fBstatic\fP int \fBgetNumRenderCaches\fP (\fBvoid\fP)" .br .in -1c Static Public Member Functions inherited from \fBSoGroup\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. " .in -1c Static Public Member Functions inherited from \fBSoNode\fP .in +1c .ti -1c .RI "\fBstatic\fP uint32_t \fBgetCompatibilityTypes\fP (\fBconst\fP \fBSoType\fP &nodetype)" .br .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBSoNode\fP * \fBgetByName\fP (\fBconst\fP \fBSbName\fP &name)" .br .ti -1c .RI "\fBstatic\fP int \fBgetByName\fP (\fBconst\fP \fBSbName\fP &name, \fBSoNodeList\fP &\fBl\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. " .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClasses\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP SbUniqueId \fBgetNextNodeId\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP int \fBgetActionMethodIndex\fP (\fBconst\fP \fBSoType\fP type)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBgetBoundingBoxS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBGLRenderS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBcallbackS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBgetMatrixS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBhandleEventS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBpickS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBrayPickS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBsearchS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBwriteS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBaudioRenderS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBgetPrimitiveCountS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)" .br .in -1c Static Public Member Functions inherited from \fBSoFieldContainer\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. " .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .RI "This static method returns the \fBSoType\fP object associated with objects of this class\&. " .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBcleanupClass\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitCopyDict\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBaddCopy\fP (\fBconst\fP \fBSoFieldContainer\fP *\fBorig\fP, \fBconst\fP \fBSoFieldContainer\fP *copy)" .br .ti -1c .RI "\fBstatic\fP \fBSoFieldContainer\fP * \fBcheckCopy\fP (\fBconst\fP \fBSoFieldContainer\fP *\fBorig\fP)" .br .ti -1c .RI "\fBstatic\fP \fBSoFieldContainer\fP * \fBfindCopy\fP (\fBconst\fP \fBSoFieldContainer\fP *\fBorig\fP, \fBconst\fP SbBool \fBcopyconnections\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBcopyDone\fP (\fBvoid\fP)" .br .in -1c Static Public Member Functions inherited from \fBSoBase\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. " .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .RI "This static method returns the \fBSoType\fP object associated with objects of this class\&. " .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBaddName\fP (\fBSoBase\fP *\fBconst\fP base, \fBconst\fP char *\fBconst\fP name)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBremoveName\fP (\fBSoBase\fP *\fBconst\fP base, \fBconst\fP char *\fBconst\fP name)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBincrementCurrentWriteCounter\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBdecrementCurrentWriteCounter\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBSoBase\fP * \fBgetNamedBase\fP (\fBconst\fP \fBSbName\fP &name, \fBSoType\fP type)" .br .ti -1c .RI "\fBstatic\fP int \fBgetNamedBases\fP (\fBconst\fP \fBSbName\fP &name, \fBSoBaseList\fP &\fBbaselist\fP, \fBSoType\fP type)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBread\fP (\fBSoInput\fP *input, \fBSoBase\fP *&base, \fBSoType\fP \fBexpectedtype\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBsetInstancePrefix\fP (\fBconst\fP \fBSbString\fP &c)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBsetTraceRefs\fP (SbBool \fBtrace\fP)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBgetTraceRefs\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBconnectRoute\fP (\fBSoInput\fP *input, \fBconst\fP \fBSbName\fP &\fBfromnodename\fP, \fBconst\fP \fBSbName\fP &\fBfromfieldname\fP, \fBconst\fP \fBSbName\fP &\fBtonodename\fP, \fBconst\fP \fBSbName\fP &\fBtofieldname\fP)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBreadRoute\fP (\fBSoInput\fP *input)" .br .in -1c .SS "Public Attributes" .in +1c .ti -1c .RI "\fBSoSFBool\fP \fBisActive\fP" .br .ti -1c .RI "\fBSoSFFloat\fP \fBintensity\fP" .br .ti -1c .RI "\fBSoSFFloat\fP \fBprecision\fP" .br .ti -1c .RI "\fBSoSFFloat\fP \fBquality\fP" .br .ti -1c .RI "\fBSoSFFloat\fP \fBsmoothBorder\fP" .br .ti -1c .RI "\fBSoSFBool\fP \fBshadowCachingEnabled\fP" .br .ti -1c .RI "\fBSoSFFloat\fP \fBvisibilityNearRadius\fP" .br .ti -1c .RI "\fBSoSFFloat\fP \fBvisibilityRadius\fP" .br .ti -1c .RI "\fBSoSFEnum\fP \fBvisibilityFlag\fP" .br .ti -1c .RI "\fBSoSFFloat\fP \fBepsilon\fP" .br .ti -1c .RI "\fBSoSFFloat\fP \fBthreshold\fP" .br .in -1c Public Attributes inherited from \fBSoSeparator\fP .in +1c .ti -1c .RI "\fBSoSFEnum\fP \fBrenderCaching\fP" .br .ti -1c .RI "\fBSoSFEnum\fP \fBboundingBoxCaching\fP" .br .ti -1c .RI "\fBSoSFEnum\fP \fBrenderCulling\fP" .br .ti -1c .RI "\fBSoSFEnum\fP \fBpickCulling\fP" .br .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "\fBvirtual\fP \fBconst\fP \fBSoFieldData\fP * \fBgetFieldData\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fB~SoShadowGroup\fP ()" .br .in -1c Protected Member Functions inherited from \fBSoSeparator\fP .in +1c .ti -1c .RI "\fBvirtual\fP \fB~SoSeparator\fP ()" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBcullTest\fP (\fBSoState\fP *state)" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBcullTest\fP (\fBSoGLRenderAction\fP *action, int &\fBcullresults\fP)" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBreadInstance\fP (\fBSoInput\fP *\fBin\fP, \fBunsigned\fP short flags)" .br .in -1c Protected Member Functions inherited from \fBSoGroup\fP .in +1c .ti -1c .RI "\fBvirtual\fP \fB~SoGroup\fP ()" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBreadChildren\fP (\fBSoInput\fP *\fBin\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBcopyContents\fP (\fBconst\fP \fBSoFieldContainer\fP *from, SbBool \fBcopyconnections\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBSoNotRec\fP \fBcreateNotRec\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvoid\fP \fBsetOperation\fP (\fBconst\fP \fBSoNotRec::OperationType\fP \fBopType\fP=SoNotRec::UNSPECIFIED, \fBconst\fP \fBSoNode\fP *\fBcc\fP=\fBNULL\fP, \fBconst\fP \fBSoNode\fP *\fBpc\fP=\fBNULL\fP, \fBconst\fP int \fBci\fP=\-1)" .br .in -1c Protected Member Functions inherited from \fBSoNode\fP .in +1c .ti -1c .RI "\fBSoNode\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvirtual\fP \fB~SoNode\fP ()" .br .in -1c Protected Member Functions inherited from \fBSoFieldContainer\fP .in +1c .ti -1c .RI "\fBSoFieldContainer\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvirtual\fP \fB~SoFieldContainer\fP ()" .br .in -1c Protected Member Functions inherited from \fBSoBase\fP .in +1c .ti -1c .RI "\fBSoBase\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvirtual\fP \fB~SoBase\fP ()" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBdestroy\fP (\fBvoid\fP)" .br .ti -1c .RI "SbBool \fBhasMultipleWriteRefs\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "SbBool \fBwriteHeader\fP (\fBSoOutput\fP *\fBout\fP, SbBool \fBisgroup\fP, SbBool \fBisengine\fP) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBwriteFooter\fP (\fBSoOutput\fP *\fBout\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBconst\fP char * \fBgetFileFormatName\fP (\fBvoid\fP) \fBconst\fP" .br .in -1c .SS "Static Protected Member Functions" .in +1c .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (\fBvoid\fP)" .br .in -1c Static Protected Member Functions inherited from \fBSoSeparator\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (\fBvoid\fP)" .br .in -1c Static Protected Member Functions inherited from \fBSoGroup\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (\fBvoid\fP)" .br .in -1c Static Protected Member Functions inherited from \fBSoNode\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBsetNextActionMethodIndex\fP (int index)" .br .ti -1c .RI "\fBstatic\fP int \fBgetNextActionMethodIndex\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBincNextActionMethodIndex\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBsetCompatibilityTypes\fP (\fBconst\fP \fBSoType\fP &nodetype, \fBconst\fP uint32_t \fBbitmask\fP)" .br .in -1c Static Protected Member Functions inherited from \fBSoBase\fP .in +1c .ti -1c .RI "\fBstatic\fP uint32_t \fBgetCurrentWriteCounter\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBstaticDataLock\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBstaticDataUnlock\fP (\fBvoid\fP)" .br .in -1c .SS "Additional Inherited Members" Protected Types inherited from \fBSoBase\fP .in +1c .ti -1c .RI "enum \fBBaseFlags\fP { \fBIS_ENGINE\fP = 0x01, \fBIS_GROUP\fP = 0x02 }" .br .in -1c Protected Attributes inherited from \fBSoGroup\fP .in +1c .ti -1c .RI "\fBSoChildList\fP * \fBchildren\fP" .br .in -1c Protected Attributes inherited from \fBSoNode\fP .in +1c .ti -1c .RI "SbUniqueId \fBuniqueId\fP" .br .in -1c Protected Attributes inherited from \fBSoFieldContainer\fP .in +1c .ti -1c .RI "SbBool \fBisBuiltIn\fP" .br .in -1c Static Protected Attributes inherited from \fBSoNode\fP .in +1c .ti -1c .RI "\fBstatic\fP SbUniqueId \fBnextUniqueId\fP = 1" .br .ti -1c .RI "\fBstatic\fP int \fBnextActionMethodIndex\fP = 0" .br .in -1c .SH "Detailed Description" .PP The \fBSoShadowGroup\fP node is a group node used for shadow rendering\&. Children of this node can receive shadows, and cast shadows on other children\&. Use the \fBSoShadowStyle\fP node to control shadow casters and shadow receivers\&. .PP Please note that all shadow casters will be rendered twice\&. Once to create the shadow map, and once for normal rendering\&. If you're having performance issues, you should consider reducing the number of shadow casters\&. .PP The algorithm used to render the shadows is Variance Shadow Maps (http://www.punkuser.net/vsm/)\&. As an extra bonus, all geometry rendered with shadows can also be rendered with per fragment Phong lighting\&. .PP This node will search its subgraph and calculate shadows for all \fBSoSpotLight\fP nodes\&. The node will use one texture unit for each spot light, so for this node to work 100%, you need to have num-spotlights free texture units while rendering the subgraph\&. .PP Currently, we only support scenes with maximum two texture units active while doing shadow rendering (unit 0 and unit 1)\&. This is due to the fact that we emulate the OpenGL shading model in a shader program, and we're still working on creating a solution that updates the shader program during the scene graph traversal\&. Right now a shader program is created when entering the \fBSoShadowGroup\fP node, and this is used for the entire subgraph\&. .PP \fBFILE FORMAT/DEFAULTS:\fP .PP .nf SoShadowGroup { isActive TRUE intensity 0\&.5 precision 0\&.5 quality 0\&.5 shadowCachingEnabled TRUE visibilityRadius \-1\&.0 visibilityFlag LONGEST_BBOX_EDGE_FACTOR epsilon 0\&.00001 threshold 0\&.1 smoothBorder 0\&.0 } .fi .PP .PP Example scene graph: .PP .nf #Inventor V2\&.1 ascii # to get some lighting when headlight is turned off in the viewer DirectionalLight { direction 0 0 \-1 intensity 0\&.2 } ShadowGroup { quality 1 # to get per pixel lighting ShadowStyle { style NO_SHADOWING } SpotLight { location \-8 \-8 8\&.0 direction 1 1 \-1 cutOffAngle 0\&.35 dropOffRate 0\&.7 } ShadowStyle { style CASTS_SHADOW_AND_SHADOWED } Separator { Complexity { value 1\&.0 } Material { diffuseColor 1 1 0 specularColor 1 1 1 shininess 0\&.9 } Shuttle { translation0 \-3 1 0 translation1 3 \-5 0 speed 0\&.25 on TRUE } Translation { translation \-5 0 2 } Sphere { radius 2\&.0 } } Separator { Material { diffuseColor 1 0 0 specularColor 1 1 1 shininess 0\&.9 } Shuttle { translation0 0 \-5 0 translation1 0 5 0 speed 0\&.15 on TRUE } Translation { translation 0 0 \-3 } Cube { depth 1\&.8 } } Separator { Material { diffuseColor 0 1 0 specularColor 1 1 1 shininess 0\&.9 } Shuttle { translation0 \-5 0 0 translation1 5 0 0 speed 0\&.3 on TRUE } Translation { translation 0 0 \-3 } Cube { } } ShadowStyle { style SHADOWED } Coordinate3 { point [ \-10 \-10 \-3, 10 \-10 \-3, 10 10 \-3, \-10 10 \-3 ] } Material { specularColor 1 1 1 shininess 0\&.9 } Complexity { textureQuality 0\&.1 } Texture2 { image 2 2 3 0xffffff 0x225588 0x225588 0xffffff } Texture2Transform { scaleFactor 4 4 } FaceSet { numVertices 4 } } .fi .PP .PP \fBSince\fP .RS 4 Coin \fB2\&.5\fP .RE .PP .SH "Constructor & Destructor Documentation" .PP .SS "SoShadowGroup::SoShadowGroup (\fBvoid\fP)" Default constructor\&. .SS "SoShadowGroup::~SoShadowGroup ()\fC [protected]\fP, \fC [virtual]\fP" Destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoShadowGroup::getClassTypeId (\fBvoid\fP)\fC [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .br .SS "\fBSoType\fP SoShadowGroup::getTypeId (\fBvoid\fP) const\fC [virtual]\fP" Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for runtime type checking and 'downward' casting\&. .br .PP Reimplemented from \fBSoSeparator\fP\&. .SS "\fBconst\fP \fBSoFieldData\fP ** SoShadowGroup::getFieldDataPtr (\fBvoid\fP)\fC [static]\fP, \fC [protected]\fP" \fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP .br .br Returns the \fBSoFieldData\fP class which holds information about fields in this node\&. .br .SS "\fBconst\fP \fBSoFieldData\fP * SoShadowGroup::getFieldData (\fBvoid\fP) const\fC [protected]\fP, \fC [virtual]\fP" Returns a pointer to the class-wide field data storage object for this instance\&. If no fields are present, returns \fCNULL\fP\&. .PP Reimplemented from \fBSoSeparator\fP\&. .SS "\fBvoid\fP SoShadowGroup::initClass (\fBvoid\fP)\fC [static]\fP" .SS "SbBool SoShadowGroup::isSupported (\fBvoid\fP)\fC [static]\fP" Reports whether or not the shadow nodes can be used successfully on the current system\&. .PP The result will depend on the specific qualities of the graphics card and OpenGL driver on the system\&. .PP An important note about this function: .PP The API design of this function has a serious shortcoming, as features of OpenGL should be tested within an OpenGL context, and this function does not provide any means of specifying the context\&. It is implemented in this manner to match the function signature in TGS Inventor, for compatibility reasons\&. .PP (A temporary offscreen OpenGL context is set up for the feature tests\&. This should usually be sufficient to decide whether or not the graphics driver / card supports the features needed for rendering shadows\&.) .PP \fBSince\fP .RS 4 Coin \fB3\&.1\fP .RE .PP .SS "\fBvoid\fP SoShadowGroup::GLRenderBelowPath (\fBSoGLRenderAction\fP * action)\fC [virtual]\fP" SGI Open Inventor \fBv2\&.1\fP obsoleted support for \fBSoGLRenderAction::addMethod()\fP\&. Instead, \fBGLRender()\fP might be called directly, and to optimize traversal, the \fBSoSeparator\fP node calls GLRenderBelowPath whenever the path code is BELOW_PATH or NO_PATH (path code is guaranteed not to change)\&. To be compatible with SGI's Inventor (and thereby also TGS') we have chosen to follow their implementation in this respect\&. .PP \fBSoSeparator::GLRenderBelowPath()\fP does not traverse its children using \fBSoChildList::traverse()\fP, but calls \fBGLRenderBelowPath()\fP directly for all its children\&. .PP Reimplemented from \fBSoSeparator\fP\&. .SS "\fBvoid\fP SoShadowGroup::GLRenderInPath (\fBSoGLRenderAction\fP * action)\fC [virtual]\fP" Implements the SoAction::IN_PATH traversal method for the rendering action\&. .PP Reimplemented from \fBSoSeparator\fP\&. .SS "\fBvoid\fP SoShadowGroup::notify (\fBSoNotList\fP * l)\fC [virtual]\fP" Notifies all auditors for this instance when changes are made\&. .PP Reimplemented from \fBSoSeparator\fP\&. .SS "\fBvoid\fP SoShadowGroup::enableSubgraphSearchOnNotify (\fBconst\fP SbBool onoff)" By default, the \fBSoShadowGroup\fP node will search its subgraph for new spot lights whenever a group node under it is touched\&. However, this might lead to bad performance in some cases so it is possible to disable this feature using this method\&. If you do disable this feature, make sure you enable it again before inserting a new spot light, or insert all spot lights in the scene graph before you render the scene once, and just set 'on' to FALSE if you want to toggle spot lights on/off on the fly\&. .PP \fBSince\fP .RS 4 Coin \fB2\&.6\fP .RE .PP .SH "Member Data Documentation" .PP .SS "\fBSoSFBool\fP SoShadowGroup::isActive" Use this field to turn shadow rendering for the subgraph on/off\&. Default value is TRUE\&. .SS "\fBSoSFFloat\fP SoShadowGroup::intensity" Not used yet\&. Provided for TGS Inventor compatibility\&. .SS "\fBSoSFFloat\fP SoShadowGroup::precision" Use to calculate the size of the shadow map\&. A precision of \fB1\&.0\fP means the maximum shadow buffer size will be used (typically 2048x2048 on current graphics cards)\&. Default value is \fB0\&.5\fP\&. .SS "\fBSoSFFloat\fP SoShadowGroup::quality" Can be used to tune the shader program complexity\&. A higher value will mean that more calculations are done per fragment instead of per vertex\&. Default value is \fB0\&.5\fP\&. .SS "\fBSoSFInt32\fP SoShadowGroup::smoothBorder" SoShadowGroup::VisibilityFlag SoShadowGroup::ABSOLUTE_RADIUS .PP The absolute values of visibilityNearRadius and visibilityRadius will be used\&. .PP SoShadowGroup::VisibilityFlag SoShadowGroup::LONGEST_BBOX_EDGE_FACTOR .PP The longest bounding box edge will be used to determine near and far clipping planes\&. .PP SoShadowGroup::VisibilityFlag SoShadowGroup::PROJECTED_BBOX_DEPTH_FACTOR .PP The bounding box depth (projected to face the camera) will be used to calculate the clipping planes\&. .PP We have some problems with this feature so it's not supported at the moment\&. .PP Used to add shadow border smoothing\&. This is currently done as a post processing step on the shadow map\&. The algorithm used is Gauss Smoothing, but in the future we'll probably change this, and use a summed area sampling method instead\&. The value should be a number between 0 (no smoothing), and 1 (max smoothing)\&. .PP If you want to enable smoothing, choosing a low value (~0\&.1) works best in the current implementation\&. .PP Default value is \fB0\&.0\fP\&. .SS "\fBSoSFBool\fP SoShadowGroup::shadowCachingEnabled" Not used yet\&. Provided for TGS Inventor compatibility\&. .SS "\fBSoSFFloat\fP SoShadowGroup::visibilityNearRadius" Can be used to manually set the near clipping plane of the shadow maps\&. If a negative value is provided, the group will calculate a near plane based on the bounding box of the children\&. Default value is \fB-1\&.0\fP\&. .PP \fBSee also\fP .RS 4 \fBvisibilityFlag\fP .RE .PP .SS "\fBSoSFFloat\fP SoShadowGroup::visibilityRadius" Can be used to manually set the far clipping plane of the shadow maps\&. If a negative value is provided, the group will calculate a near plane based on the bounding box of the children\&. Default value is \fB-1\&.0\fP\&. .PP \fBSee also\fP .RS 4 \fBvisibilityFlag\fP .RE .PP .SS "\fBSoSFEnum\fP SoShadowGroup::visibilityFlag" Determines how visibilityRadius and visibilitNearRadius are used to calculate near and far clipping planes for the shadow volume\&. .SS "\fBSoSFFloat\fP SoShadowGroup::epsilon" Epsilon is used to offset the shadow map depth from the model depth\&. Should be set to as low a number as possible without causing flickering in the shadows or on non-shadowed objects\&. Default value is \fB0\&.00001\fP\&. .SS "\fBSoSFFloat\fP SoShadowGroup::threshold" Can be used to avoid light bleeding in merged shadows cast from different objects\&. .PP A threshold to completely eliminate all light bleeding can be computed from the ratio of overlapping occluder distances from the light's perspective\&. See http://forum.beyond3d.com/showthread.php?t=38165 for a discussion about this problem\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.