.TH "SoInteractionKit" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoInteractionKit \- The \fBSoInteractionKit\fP class is a base class for draggers\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBSoBaseKit\fP\&. .PP Inherited by \fBSoDragger\fP\&. .SS "Public Types" .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 "\fBvirtual\fP \fBconst\fP \fBSoNodekitCatalog\fP * \fBgetNodekitCatalog\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBSoInteractionKit\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBsetPartAsPath\fP (\fBconst\fP \fBSbName\fP &\fBpartname\fP, \fBSoPath\fP *path)" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBsetPartAsDefault\fP (\fBconst\fP \fBSbName\fP &\fBpartname\fP, \fBSoNode\fP *node, SbBool \fBonlyifdefault\fP=TRUE)" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBsetPartAsDefault\fP (\fBconst\fP \fBSbName\fP &\fBpartname\fP, \fBconst\fP \fBSbName\fP &nodename, SbBool \fBonlyifdefault\fP=TRUE)" .br .ti -1c .RI "SbBool \fBisPathSurrogateInMySubgraph\fP (\fBconst\fP \fBSoPath\fP *path, \fBSoPath\fP *&\fBpathToOwner\fP, \fBSbName\fP &surrogatename, \fBSoPath\fP *&surrogatepath, SbBool \fBfillargs\fP=TRUE)" .br .ti -1c .RI "SbBool \fBisPathSurrogateInMySubgraph\fP (\fBconst\fP \fBSoPath\fP *path)" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBsetPart\fP (\fBconst\fP \fBSbName\fP &\fBpartname\fP, \fBSoNode\fP *from)" .br .in -1c Public Member Functions inherited from \fBSoBaseKit\fP .in +1c .ti -1c .RI "\fBSoBaseKit\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBSoNode\fP * \fBgetPart\fP (\fBconst\fP \fBSbName\fP &\fBpartname\fP, SbBool \fBmakeifneeded\fP)" .br .ti -1c .RI "\fBSbString\fP \fBgetPartString\fP (\fBconst\fP \fBSoBase\fP *part)" .br .ti -1c .RI "\fBvirtual\fP \fBSoNodeKitPath\fP * \fBcreatePathToPart\fP (\fBconst\fP \fBSbName\fP &\fBpartname\fP, SbBool \fBmakeifneeded\fP, \fBconst\fP \fBSoPath\fP *\fBpathtoextend\fP=\fBNULL\fP)" .br .ti -1c .RI "SbBool \fBset\fP (\fBconst\fP char *\fBnamevaluepairliststring\fP)" .br .ti -1c .RI "SbBool \fBset\fP (\fBconst\fP char *\fBpartnamestring\fP, \fBconst\fP char *\fBparameterstring\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBdoAction\fP (\fBSoAction\fP *action)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBcallback\fP (\fBSoCallbackAction\fP *action)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBGLRender\fP (\fBSoGLRenderAction\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 \fBwrite\fP (\fBSoWriteAction\fP *action)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBgetPrimitiveCount\fP (\fBSoGetPrimitiveCountAction\fP *action)" .br .ti -1c .RI "\fBvirtual\fP \fBSoChildList\fP * \fBgetChildren\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBprintDiagram\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvoid\fP \fBprintSubDiagram\fP (\fBconst\fP \fBSbName\fP &\fBrootname\fP, int level)" .br .ti -1c .RI "\fBvoid\fP \fBprintTable\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBaddWriteReference\fP (\fBSoOutput\fP *\fBout\fP, SbBool \fBisfromfield\fP=FALSE)" .br .ti -1c .RI "SbBool \fBforceChildDrivenWriteRefs\fP (\fBSoOutput\fP *\fBout\fP)" .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 SbBool \fBaffectsState\fP (\fBvoid\fP) \fBconst\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 \fBGLRenderOffPath\fP (\fBSoGLRenderAction\fP *action)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBpick\fP (\fBSoPickAction\fP *action)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBaudioRender\fP (\fBSoAudioRenderAction\fP *action)" .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 "\fBvirtual\fP \fBvoid\fP \fBnotify\fP (\fBSoNotList\fP *\fBl\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 \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 \fBconst\fP \fBSoNodekitCatalog\fP * \fBgetClassNodekitCatalog\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 \fBsetSwitchValue\fP (\fBSoNode\fP *node, \fBconst\fP int \fBnewVal\fP)" .br .in -1c Static Public Member Functions inherited from \fBSoBaseKit\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 .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSoNodekitCatalog\fP * \fBgetClassNodekitCatalog\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBisSearchingChildren\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBsetSearchingChildren\fP (\fBconst\fP SbBool \fBnewval\fP)" .br .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 "\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~SoInteractionKit\fP ()" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBcopyContents\fP (\fBconst\fP \fBSoFieldContainer\fP *\fBfromFC\fP, SbBool \fBcopyConnections\fP)" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBsetPart\fP (\fBconst\fP int \fBpartNum\fP, \fBSoNode\fP *node)" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBreadInstance\fP (\fBSoInput\fP *\fBin\fP, \fBunsigned\fP short flags)" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBsetAnyPartAsDefault\fP (\fBconst\fP \fBSbName\fP &\fBpartname\fP, \fBSoNode\fP *node, SbBool \fBanypart\fP=TRUE, SbBool \fBonlyifdefault\fP=TRUE)" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBsetAnyPartAsDefault\fP (\fBconst\fP \fBSbName\fP &\fBpartname\fP, \fBconst\fP \fBSbName\fP &nodename, SbBool \fBanypart\fP=TRUE, SbBool \fBonlyifdefault\fP=TRUE)" .br .ti -1c .RI "SbBool \fBsetAnySurrogatePath\fP (\fBconst\fP \fBSbName\fP &name, \fBSoPath\fP *path, SbBool \fBleafcheck\fP=FALSE, SbBool \fBpubliccheck\fP=FALSE)" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBsetUpConnections\fP (SbBool \fBonoff\fP, SbBool \fBdoitalways\fP=FALSE)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBsetDefaultOnNonWritingFields\fP ()" .br .ti -1c .RI "\fBvoid\fP \fBconnectSeparatorFields\fP (\fBSoSeparator\fP *\fBdest\fP, SbBool \fBonOff\fP)" .br .in -1c Protected Member Functions inherited from \fBSoBaseKit\fP .in +1c .ti -1c .RI "\fBvirtual\fP \fB~SoBaseKit\fP ()" .br .ti -1c .RI "\fBvirtual\fP \fBSoNode\fP * \fBaddToCopyDict\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBSoGroup\fP * \fBgetContainerNode\fP (\fBconst\fP \fBSbName\fP &\fBlistname\fP, SbBool \fBmakeifneeded\fP=TRUE)" .br .ti -1c .RI "\fBvirtual\fP \fBSoNode\fP * \fBgetAnyPart\fP (\fBconst\fP \fBSbName\fP &\fBpartname\fP, SbBool \fBmakeifneeded\fP, SbBool \fBleafcheck\fP=FALSE, SbBool \fBpubliccheck\fP=FALSE)" .br .ti -1c .RI "\fBvirtual\fP \fBSoNodeKitPath\fP * \fBcreatePathToAnyPart\fP (\fBconst\fP \fBSbName\fP &\fBpartname\fP, SbBool \fBmakeifneeded\fP, SbBool \fBleafcheck\fP=FALSE, SbBool \fBpubliccheck\fP=FALSE, \fBconst\fP \fBSoPath\fP *\fBpathtoextend\fP=\fBNULL\fP)" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBsetAnyPart\fP (\fBconst\fP \fBSbName\fP &\fBpartname\fP, \fBSoNode\fP *from, SbBool \fBanypart\fP=TRUE)" .br .ti -1c .RI "\fBvoid\fP \fBcreateNodekitPartsList\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvoid\fP \fBcreateFieldList\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBcreateDefaultParts\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBconst\fP \fBSoNodekitParts\fP * \fBgetNodekitPartsList\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBconst\fP \fBSbList\fP< \fBSoSFNode\fP * > & \fBgetCatalogInstances\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvoid\fP \fBcatalogError\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvoid\fP \fBcountMyFields\fP (\fBSoOutput\fP *\fBout\fP)" .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 .ti -1c .RI "\fBvirtual\fP \fBSoNotRec\fP \fBcreateNotRec\fP (\fBvoid\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 .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSoNodekitCatalog\fP ** \fBgetClassNodekitCatalogPtr\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBreadDefaultParts\fP (\fBconst\fP char *\fBfileName\fP, \fBconst\fP char \fBdefaultBuffer\fP[], int \fBdefBufSize\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBfieldSensorCB\fP (\fBvoid\fP *, \fBSoSensor\fP *)" .br .in -1c Static Protected Member Functions inherited from \fBSoBaseKit\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSoNodekitCatalog\fP ** \fBgetClassNodekitCatalogPtr\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 "Protected Attributes" .in +1c .ti -1c .RI "\fBSoSFNode\fP \fBgeomSeparator\fP" .br .ti -1c .RI "\fBSoSFNode\fP \fBtopSeparator\fP" .br .ti -1c .RI "\fBSoFieldSensor\fP * \fBfieldSensor\fP" .br .ti -1c .RI "\fBSoSeparator\fP * \fBoldTopSep\fP" .br .in -1c Protected Attributes inherited from \fBSoBaseKit\fP .in +1c .ti -1c .RI "\fBSoSFNode\fP \fBcallbackList\fP" .br .ti -1c .RI "\fBSoChildList\fP * \fBchildren\fP" .br .ti -1c .RI "SbBool \fBconnectionsSetUp\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 .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 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 \fBSoInteractionKit\fP class is a base class for draggers\&. This nodekit class makes it possible to set surrogate paths for parts\&. Instead of creating new geometry for the dragger, it is possible to specify an existing path in your scene to be used for interaction\&. All picks on this path will be handled by the dragger\&. .PP The \fBSoInteractionKit\fP is primarily an internal class used as a superclass for the dragger classes, and it is unlikely that it should be of interest to application programmers, unless you have very special needs in your application\&. .PP Nodekit structure (new entries versus parent class marked with arrow prefix): .PP .PP .nf CLASS SoInteractionKit -->'this' 'callbackList' --> 'topSeparator' --> 'geomSeparator' .fi .PP .PP (See \fBSoBaseKit::printDiagram()\fP for information about the output formatting\&.) .PP Detailed information on catalog parts: .PP .PP .nf CLASS SoInteractionKit PVT 'this', SoInteractionKit --- 'callbackList', SoNodeKitListPart [ SoCallback, SoEventCallback ] PVT 'topSeparator', SoSeparator --- PVT 'geomSeparator', SoSeparator --- .fi .PP .PP (See \fBSoBaseKit::printTable()\fP for information about the output formatting\&.) .SH "Member Enumeration Documentation" .PP .SS "\fBenum\fP \fBSoInteractionKit::CacheEnabled\fP" Enumeration of valid values for the cache control fields \fBSoInteractionKit::renderCaching\fP, \fBSoInteractionKit::boundingBoxCaching\fP, \fBSoInteractionKit::renderCulling\fP and \fBSoInteractionKit::pickCulling\fP\&. .PP The same values with the same semantics are present in this enum as for \fBSoSeparator::CacheEnabled\fP, so see that documentation\&. .SH "Constructor & Destructor Documentation" .PP .SS "SoInteractionKit::SoInteractionKit (\fBvoid\fP)" Constructor\&. .SS "SoInteractionKit::~SoInteractionKit ()\fC [protected]\fP, \fC [virtual]\fP" Destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoInteractionKit::getClassTypeId (\fBvoid\fP)\fC [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .br .SS "\fBSoType\fP SoInteractionKit::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 \fBSoBaseKit\fP\&. .PP Reimplemented in \fBSoCenterballDragger\fP, \fBSoDirectionalLightDragger\fP, \fBSoDragger\fP, \fBSoDragPointDragger\fP, \fBSoHandleBoxDragger\fP, \fBSoJackDragger\fP, \fBSoPointLightDragger\fP, \fBSoRotateCylindricalDragger\fP, \fBSoRotateDiscDragger\fP, \fBSoRotateSphericalDragger\fP, \fBSoScale1Dragger\fP, \fBSoScale2Dragger\fP, \fBSoScale2UniformDragger\fP, \fBSoScaleUniformDragger\fP, \fBSoSpotLightDragger\fP, \fBSoTabBoxDragger\fP, \fBSoTabPlaneDragger\fP, \fBSoTrackballDragger\fP, \fBSoTransformBoxDragger\fP, \fBSoTransformerDragger\fP, \fBSoTranslate1Dragger\fP, and \fBSoTranslate2Dragger\fP\&. .SS "\fBconst\fP \fBSoFieldData\fP ** SoInteractionKit::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 * SoInteractionKit::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 \fBSoBaseKit\fP\&. .PP Reimplemented in \fBSoCenterballDragger\fP, \fBSoDirectionalLightDragger\fP, \fBSoDragger\fP, \fBSoDragPointDragger\fP, \fBSoHandleBoxDragger\fP, \fBSoJackDragger\fP, \fBSoPointLightDragger\fP, \fBSoRotateCylindricalDragger\fP, \fBSoRotateDiscDragger\fP, \fBSoRotateSphericalDragger\fP, \fBSoScale1Dragger\fP, \fBSoScale2Dragger\fP, \fBSoScale2UniformDragger\fP, \fBSoScaleUniformDragger\fP, \fBSoSpotLightDragger\fP, \fBSoTabBoxDragger\fP, \fBSoTabPlaneDragger\fP, \fBSoTrackballDragger\fP, \fBSoTransformBoxDragger\fP, \fBSoTransformerDragger\fP, \fBSoTranslate1Dragger\fP, and \fBSoTranslate2Dragger\fP\&. .SS "\fBconst\fP \fBSoNodekitCatalog\fP * SoInteractionKit::getClassNodekitCatalog (\fBvoid\fP)\fC [static]\fP" Returns the nodekit catalog which defines the layout of this class' kit\&. .br .SS "\fBconst\fP \fBSoNodekitCatalog\fP * SoInteractionKit::getNodekitCatalog (\fBvoid\fP) const\fC [virtual]\fP" Returns the nodekit catalog which defines the layout of this class' kit\&. .br .PP Reimplemented from \fBSoBaseKit\fP\&. .PP Reimplemented in \fBSoCenterballDragger\fP, \fBSoDirectionalLightDragger\fP, \fBSoDragger\fP, \fBSoDragPointDragger\fP, \fBSoHandleBoxDragger\fP, \fBSoJackDragger\fP, \fBSoPointLightDragger\fP, \fBSoRotateCylindricalDragger\fP, \fBSoRotateDiscDragger\fP, \fBSoRotateSphericalDragger\fP, \fBSoScale1Dragger\fP, \fBSoScale2Dragger\fP, \fBSoScale2UniformDragger\fP, \fBSoScaleUniformDragger\fP, \fBSoSpotLightDragger\fP, \fBSoTabBoxDragger\fP, \fBSoTabPlaneDragger\fP, \fBSoTrackballDragger\fP, \fBSoTransformBoxDragger\fP, \fBSoTransformerDragger\fP, \fBSoTranslate1Dragger\fP, and \fBSoTranslate2Dragger\fP\&. .SS "\fBconst\fP \fBSoNodekitCatalog\fP ** SoInteractionKit::getClassNodekitCatalogPtr (\fBvoid\fP)\fC [static]\fP, \fC [protected]\fP" Returns the pointer to the pointer of the nodekit catalog for this class\&. .br .SS "SbBool SoInteractionKit::setPartAsPath (\fBconst\fP \fBSbName\fP & partname, \fBSoPath\fP * path)\fC [virtual]\fP" Sets a part in the kit as a surrogate path\&. The \fIpartname\fP part is set to \fCNULL\fP, and the surrogate path is remembered\&. Following picks on the surrogate path will be regarded as a pick on \fIpartname\fP\&. .SS "SbBool SoInteractionKit::setPartAsDefault (\fBconst\fP \fBSbName\fP & partname, \fBSoNode\fP * node, SbBool onlyifdefault = \fCTRUE\fP)\fC [virtual]\fP" Sets the value of \fIpartname\fP to \fInode\fP, and sets the part's field to default (i\&.e\&. node will not be written on scene graph export)\&. .PP If \fIonlyifdefault\fP is \fCTRUE\fP, \fIpartname\fP is only set if it is already in the default state\&. .PP The reason for this method is to make it possible for dragger subclasses to avoid having their default parts written out on export\&. .SS "SbBool SoInteractionKit::setPartAsDefault (\fBconst\fP \fBSbName\fP & partname, \fBconst\fP \fBSbName\fP & nodename, SbBool onlyifdefault = \fCTRUE\fP)\fC [virtual]\fP" Find node in the global dictionary, and set as default\&. .PP \fBSee also\fP .RS 4 \fBsetPartAsDefault()\fP .RE .PP .SS "SbBool SoInteractionKit::isPathSurrogateInMySubgraph (\fBconst\fP \fBSoPath\fP * path, \fBSoPath\fP *& pathToOwner, \fBSbName\fP & surrogatename, \fBSoPath\fP *& surrogatepath, SbBool fillargs = \fCTRUE\fP)" Checks if \fIpath\fP is contained within any of the surrogate paths in any interaction kits from this node down\&. Returns information about the owner and the surrogate path if found, and \fIfillargs\fP is \fITRUE\fP\&. The returned path (\fIpathToOwner\fP) is not ref'ed, It's the callers responsibility to ref and unref this path\&. .SS "SbBool SoInteractionKit::isPathSurrogateInMySubgraph (\fBconst\fP \fBSoPath\fP * path)" This is an overloaded member function, provided for convenience\&. It differs from the above function only in what argument(s) it accepts\&. .SS "\fBvoid\fP SoInteractionKit::setSwitchValue (\fBSoNode\fP * node, \fBconst\fP int newVal)\fC [static]\fP" Convenience method that sets the switch value for a switch node\&. Checks if node != 0, and only sets the switch value if value has changed\&. .SS "SbBool SoInteractionKit::setPart (\fBconst\fP \fBSbName\fP & partname, \fBSoNode\fP * from)\fC [virtual]\fP" Sets the catalog part given by \fIpartname\fP to the \fIfrom\fP node pointer\&. .PP Reimplemented from \fBSoBaseKit\fP\&. .SS "\fBvoid\fP SoInteractionKit::copyContents (\fBconst\fP \fBSoFieldContainer\fP * from, SbBool copyconnections)\fC [protected]\fP, \fC [virtual]\fP" Makes a deep copy of all data of \fIfrom\fP into this instance, \fIexcept\fP external scene graph references if \fIcopyconnections\fP is \fCFALSE\fP\&. .PP This is the method that should be overridden by extension node / engine / dragger / whatever subclasses which need to account for internal data that are not handled automatically\&. .PP For copying nodes from application code, you should not invoke this function directly, but rather call the \fBSoNode::copy()\fP function: .PP .PP .nf SoNode * mynewnode = templatenode\->copy(); .fi .PP .PP The same also goes for engines\&. .PP Make sure that when you override the \fBcopyContents()\fP method in your extension class that you also make it call upwards to its parent superclass in the inheritance hierarchy, as \fBcopyContents()\fP in for instance \fBSoNode\fP and \fBSoFieldContainer\fP does important work\&. It should go something like this: .PP .PP .nf void MyCoinExtensionNode::copyContents(const SoFieldContainer * from, SbBool copyconnections) { // let parent superclasses do their thing (copy fields, copy // instance name, etc\&.) SoNode::copyContents(from, copyconnections); // [\&.\&.then copy internal data\&.\&.] } .fi .PP .PP Reimplemented from \fBSoBaseKit\fP\&. .PP Reimplemented in \fBSoRotateCylindricalDragger\fP, and \fBSoRotateSphericalDragger\fP\&. .SS "SbBool SoInteractionKit::setPart (\fBconst\fP int partnum, \fBSoNode\fP * node)\fC [protected]\fP, \fC [virtual]\fP" Sets parts, updates nodekit scene graph, and makes sure graph is valid with respect to right siblings and parent\&. This method is virtual to enable subclasses to detect when a part changes value\&. .PP This method is not part of the original SGI Open Inventor API, but is an extension specific to Coin\&. .PP Reimplemented from \fBSoBaseKit\fP\&. .SS "SbBool SoInteractionKit::readInstance (\fBSoInput\fP * in, \fBunsigned\fP short flags)\fC [protected]\fP, \fC [virtual]\fP" This method is mainly intended for internal use during file import operations\&. .PP It reads a definition of an instance from the input stream \fIin\fP\&. The input stream state points to the start of a serialized / persistent representation of an instance of this class type\&. .PP \fCTRUE\fP or \fCFALSE\fP is returned, depending on if the instantiation and configuration of the new object of this class type went OK or not\&. The import process should be robust and handle corrupted input streams by returning \fCFALSE\fP\&. .PP \fIflags\fP is used internally during binary import when reading user extension nodes, group nodes or engines\&. .PP Reimplemented from \fBSoBaseKit\fP\&. .SS "\fBvoid\fP SoInteractionKit::readDefaultParts (\fBconst\fP char * fileName, \fBconst\fP char defaultBuffer[], int defBufSize)\fC [static]\fP, \fC [protected]\fP" Reads default parts for a dragger\&. .PP This method is called from dragger constructors to set up a dragger's nodekit catalog of interaction and feedback geometry\&. .PP \fIfileName\fP is the user-changeable resource file in the Inventor file format, while \fIdefaultBuffer\fP and \fIdefBufSize\fP can point to the statically compiled default parts\&. .PP The environment variable \fCSO_DRAGGER_DIR\fP must be set to a valid directory prefix for \fIfileName\fP, or no resource file will be loaded (and \fIdefaultBuffer\fP will be used instead)\&. .PP If both a \fIfileName\fP and a \fIdefaultBuffer\fP are provided, the file will be attempted found and loaded first, if that fails, the geometry will be attempted read from the buffer\&. .SS "SbBool SoInteractionKit::setAnyPartAsDefault (\fBconst\fP \fBSbName\fP & partname, \fBSoNode\fP * node, SbBool anypart = \fCTRUE\fP, SbBool onlyifdefault = \fCTRUE\fP)\fC [protected]\fP, \fC [virtual]\fP" Protected version of \fBsetPartAsDefault()\fP, to make it possible to set non-leaf and private parts (if \fIanypart\fP is \fCTRUE\fP)\&. .PP \fBSee also\fP .RS 4 \fBsetPartAsDefault()\fP .RE .PP .SS "SbBool SoInteractionKit::setAnyPartAsDefault (\fBconst\fP \fBSbName\fP & partname, \fBconst\fP \fBSbName\fP & nodename, SbBool anypart = \fCTRUE\fP, SbBool onlyifdefault = \fCTRUE\fP)\fC [protected]\fP, \fC [virtual]\fP" Protected version of \fBsetPartAsDefault()\fP, to make it possible to set non-leaf and private parts (if anypart is \fCTRUE\fP)\&. .PP \fBSee also\fP .RS 4 \fBsetPartAsDefault()\fP .RE .PP .SS "SbBool SoInteractionKit::setAnySurrogatePath (\fBconst\fP \fBSbName\fP & partname, \fBSoPath\fP * path, SbBool leafcheck = \fCFALSE\fP, SbBool publiccheck = \fCFALSE\fP)\fC [protected]\fP" Protected version of \fBsetPartAsPath()\fP, to make it possible to set non-leaf and private parts\&. .PP ('The nice thing about C++ is that only your friends can handle your private parts\&.') .PP \fBSee also\fP .RS 4 \fBsetPartAsPath()\fP .RE .PP .SS "SbBool SoInteractionKit::setUpConnections (SbBool onoff, SbBool doitalways = \fCFALSE\fP)\fC [protected]\fP, \fC [virtual]\fP" Sets up all internal connections for instances of this class\&. .PP (This method will usually not be of interest to the application programmer, unless you want to extend the library with new custom nodekits or dragger classes\&. If so, see the \fBSoBaseKit\fP class documentation\&.) .PP Reimplemented from \fBSoBaseKit\fP\&. .PP Reimplemented in \fBSoCenterballDragger\fP, \fBSoDirectionalLightDragger\fP, \fBSoDragPointDragger\fP, \fBSoHandleBoxDragger\fP, \fBSoJackDragger\fP, \fBSoPointLightDragger\fP, \fBSoRotateCylindricalDragger\fP, \fBSoRotateDiscDragger\fP, \fBSoRotateSphericalDragger\fP, \fBSoScale1Dragger\fP, \fBSoScale2Dragger\fP, \fBSoScale2UniformDragger\fP, \fBSoScaleUniformDragger\fP, \fBSoSpotLightDragger\fP, \fBSoTabBoxDragger\fP, \fBSoTabPlaneDragger\fP, \fBSoTrackballDragger\fP, \fBSoTransformBoxDragger\fP, \fBSoTransformerDragger\fP, \fBSoTranslate1Dragger\fP, and \fBSoTranslate2Dragger\fP\&. .SS "\fBvoid\fP SoInteractionKit::setDefaultOnNonWritingFields (\fBvoid\fP)\fC [protected]\fP, \fC [virtual]\fP" (Be aware that this method is unlikely to be of interest to the application programmer who does not want to extend the library with new custom nodekits or draggers\&. If you indeed \fIare\fP writing extensions, see the information in the \fBSoBaseKit\fP class documentation\&.) .PP This is a virtual method, and the code in it should call \fBSoField::setDefault()\fP with argument \fCTRUE\fP on part fields that should not be written upon scene graph export operations\&. .PP This is typically done when: .PP .PD 0 .IP "1." 4 field value is \fCNULL\fP and part is \fCNULL\fP by default .PP .IP "2." 4 it is a leaf \fBSoGroup\fP or \fBSoSeparator\fP node with no children .PP .IP "3." 4 it is a leaf listpart with no children and an \fBSoGroup\fP or \fBSoSeparator\fP container .PP .IP "4." 4 it is a non-leaf part and it is of \fBSoGroup\fP type and all fields are at their default values .PP .PP .PP Subclasses should usually override this to do additional settings for new member fields\&. From the subclass, do remember to call 'upwards' to your superclass' \fBsetDefaultOnNonWritingFields()\fP method\&. .PP Reimplemented from \fBSoBaseKit\fP\&. .PP Reimplemented in \fBSoCenterballDragger\fP, \fBSoDirectionalLightDragger\fP, \fBSoDragger\fP, \fBSoDragPointDragger\fP, \fBSoHandleBoxDragger\fP, \fBSoJackDragger\fP, \fBSoPointLightDragger\fP, \fBSoSpotLightDragger\fP, \fBSoTabBoxDragger\fP, \fBSoTabPlaneDragger\fP, \fBSoTrackballDragger\fP, \fBSoTransformBoxDragger\fP, and \fBSoTransformerDragger\fP\&. .SS "\fBvoid\fP SoInteractionKit::fieldSensorCB (\fBvoid\fP * d, \fBSoSensor\fP * s)\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 .SS "\fBvoid\fP SoInteractionKit::connectSeparatorFields (\fBSoSeparator\fP * dest, SbBool onOff)\fC [protected]\fP" Obsoleted in Coin\&. .SH "Member Data Documentation" .PP .SS "\fBSoSFEnum\fP SoInteractionKit::renderCaching" Controls the value of the \fBSoSeparator::renderCaching\fP field in the \fBSoInteractionKit\fP catalog's topSeparator instance\&. .PP See documentation of \fBSoSeparator::renderCaching\fP\&. .SS "\fBSoSFEnum\fP SoInteractionKit::boundingBoxCaching" Controls the value of the \fBSoSeparator::boundingBoxCaching\fP field in the \fBSoInteractionKit\fP catalog's topSeparator instance\&. .PP See documentation of \fBSoSeparator::boundingBoxCaching\fP\&. .SS "\fBSoSFEnum\fP SoInteractionKit::renderCulling" Controls the value of the \fBSoSeparator::renderCulling\fP field in the \fBSoInteractionKit\fP catalog's topSeparator instance\&. .PP See documentation of \fBSoSeparator::renderCulling\fP\&. .SS "\fBSoSFEnum\fP SoInteractionKit::pickCulling" Controls the value of the \fBSoSeparator::pickCulling\fP field in the \fBSoInteractionKit\fP catalog's topSeparator instance\&. .PP See documentation of \fBSoSeparator::pickCulling\fP\&. .SS "\fBSoFieldSensor\fP * SoInteractionKit::fieldSensor\fC [protected]\fP" Obsoleted in Coin\&. .SS "\fBSoFieldSensor\fP * SoInteractionKit::oldTopSep\fC [protected]\fP" Obsoleted in Coin\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.