.TH "SoScXMLNavigationTarget" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoScXMLNavigationTarget \- base class for navigation system SCXML event target services .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBScXMLEventTarget\fP\&. .PP Inherited by \fBSoScXMLDollyTarget\fP, \fBSoScXMLFlightControlTarget\fP, \fBSoScXMLMiscTarget\fP, \fBSoScXMLMotionTarget\fP, \fBSoScXMLPanTarget\fP, \fBSoScXMLRotateTarget\fP, \fBSoScXMLSeekTarget\fP, \fBSoScXMLSpinTarget\fP, and \fBSoScXMLZoomTarget\fP\&. .SS "Classes" .in +1c .ti -1c .RI "class \fBData\fP" .br .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBvirtual\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP =0" .br .RI "Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for runtime type checking and 'downward' casting\&. " .in -1c Public Member Functions inherited from \fBScXMLEventTarget\fP .in +1c .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBsetEventTargetType\fP (\fBconst\fP char *targettype)" .br .ti -1c .RI "\fBconst\fP char * \fBgetEventTargetType\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBsetEventTargetName\fP (\fBconst\fP char *targetname)" .br .ti -1c .RI "\fBconst\fP char * \fBgetEventTargetName\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBconst\fP \fBScXMLEvent\fP * \fBgetCurrentEvent\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBqueueEvent\fP (\fBconst\fP \fBScXMLEvent\fP *event)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBqueueEvent\fP (\fBconst\fP \fBSbName\fP &\fBeventid\fP)" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBprocessEventQueue\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBsendExternalEvent\fP (\fBconst\fP \fBScXMLSendElt\fP *\fBsendelt\fP)" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBsendInternalEvent\fP (\fBconst\fP \fBScXMLEventElt\fP *\fBsendelt\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBqueueInternalEvent\fP (\fBconst\fP \fBScXMLEvent\fP *event)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBqueueInternalEvent\fP (\fBconst\fP \fBSbName\fP &\fBeventid\fP)" .br .in -1c Public Member Functions inherited from \fBScXMLObject\fP .in +1c .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\&. " .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 \fBcleanClass\fP (\fBvoid\fP)" .br .in -1c Static Public Member Functions inherited from \fBScXMLEventTarget\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 \fBvoid\fP \fBcleanClass\fP (\fBvoid\fP)" .br .in -1c Static Public Member Functions inherited from \fBScXMLObject\fP .in +1c .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 \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 \fBcleanClass\fP (\fBvoid\fP)" .br .RI "Does the opposite of initClass, deallocates any class specific resources and resets the class to an uninitialized state with respect to the Coin type system\&. " .in -1c .SS "Protected Types" .in +1c .ti -1c .RI "\fBtypedef\fP \fBData\fP * \fBNewDataFunc\fP(\fBvoid\fP)" .br .in -1c .SS "Protected Member Functions" .in +1c .ti -1c .RI "\fBData\fP * \fBgetSessionData\fP (\fBSbName\fP sessionid, NewDataFunc *\fBconstructor\fP)" .br .ti -1c .RI "\fBvoid\fP \fBfreeSessionData\fP (\fBSbName\fP sessionid)" .br .in -1c Protected Member Functions inherited from \fBScXMLEventTarget\fP .in +1c .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBsetCurrentEvent\fP (\fBconst\fP \fBScXMLEvent\fP *event)" .br .ti -1c .RI "\fBvirtual\fP \fBconst\fP \fBScXMLEvent\fP * \fBgetNextEvent\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBconst\fP \fBScXMLEvent\fP * \fBgetNextInternalEvent\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBconst\fP \fBScXMLEvent\fP * \fBgetNextExternalEvent\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBprocessOneEvent\fP (\fBconst\fP \fBScXMLEvent\fP *event)" .br .in -1c .SS "Static Protected Member Functions" .in +1c .ti -1c .RI "\fBstatic\fP \fBSbName\fP \fBgetSessionId\fP (\fBconst\fP \fBScXMLEvent\fP *event)" .br .ti -1c .RI "\fBstatic\fP \fBScXMLStateMachine\fP * \fBgetStateMachine\fP (\fBconst\fP \fBScXMLEvent\fP *event, \fBSbName\fP sessionid)" .br .ti -1c .RI "\fBstatic\fP \fBSoScXMLStateMachine\fP * \fBgetSoStateMachine\fP (\fBconst\fP \fBScXMLEvent\fP *event, \fBSbName\fP sessionid)" .br .ti -1c .RI "\fBstatic\fP \fBSoCamera\fP * \fBgetActiveCamera\fP (\fBconst\fP \fBScXMLEvent\fP *event, \fBSbName\fP sessionid)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBgetEventDouble\fP (\fBconst\fP \fBScXMLEvent\fP *event, \fBconst\fP char *label, double &\fBdbl_out\fP, SbBool \fBrequired\fP=TRUE)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBgetEventString\fP (\fBconst\fP \fBScXMLEvent\fP *event, \fBconst\fP char *label, \fBSbString\fP &\fBstr_out\fP, SbBool \fBrequired\fP=TRUE)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBgetEventSbBool\fP (\fBconst\fP \fBScXMLEvent\fP *event, \fBconst\fP char *label, SbBool &\fBbool_out\fP, SbBool \fBrequired\fP=TRUE)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBgetEventSbVec2f\fP (\fBconst\fP \fBScXMLEvent\fP *event, \fBconst\fP char *label, \fBSbVec2f\fP &\fBvec_out\fP, SbBool \fBrequired\fP=TRUE)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBgetEventSbVec3f\fP (\fBconst\fP \fBScXMLEvent\fP *event, \fBconst\fP char *label, \fBSbVec3f\fP &\fBvec_out\fP, SbBool \fBrequired\fP=TRUE)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBgetEventSbRotation\fP (\fBconst\fP \fBScXMLEvent\fP *event, \fBconst\fP char *label, \fBSbRotation\fP &\fBrot_out\fP, SbBool \fBrequired\fP=TRUE)" .br .in -1c Static Protected Member Functions inherited from \fBScXMLEventTarget\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBregisterEventTarget\fP (\fBScXMLEventTarget\fP *target, \fBconst\fP char *sessionid=\fBNULL\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBunregisterEventTarget\fP (\fBScXMLEventTarget\fP *target, \fBconst\fP char *sessionid=\fBNULL\fP)" .br .ti -1c .RI "\fBstatic\fP \fBScXMLEventTarget\fP * \fBgetEventTarget\fP (\fBconst\fP char *targettype, \fBconst\fP char *targetname, \fBconst\fP char *sessionid=\fBNULL\fP)" .br .in -1c Static Protected Member Functions inherited from \fBScXMLObject\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBregisterClassType\fP (\fBconst\fP char *xmlns, \fBconst\fP char *\fBclassname\fP, \fBSoType\fP type)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBregisterInvokeClassType\fP (\fBconst\fP char *xmlns, \fBconst\fP char *targettype, \fBconst\fP char *source, \fBSoType\fP type)" .br .in -1c .SS "Additional Inherited Members" Protected Attributes inherited from \fBScXMLEventTarget\fP .in +1c .ti -1c .RI "char * \fBtargetname\fP" .br .ti -1c .RI "char * \fBtargettype\fP" .br .ti -1c .RI "\fBconst\fP \fBScXMLEvent\fP * \fBcurrentevent\fP" .br .ti -1c .RI "SbBool \fBisprocessingqueue\fP" .br .in -1c .SH "Detailed Description" .PP base class for navigation system SCXML event target services This class contains some common, useful, utility functions for implementing navigation system event targets\&. .PP \fBSince\fP .RS 4 Coin \fB3\&.1\fP .RE .PP .SH "Member Function Documentation" .PP .SS "\fBvirtual\fP \fBSoType\fP SoScXMLNavigationTarget::getTypeId (\fBvoid\fP) const\fC [pure virtual]\fP" .PP Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for runtime type checking and 'downward' casting\&. .PP \fBSee also\fP .RS 4 \fBSoBase::getTypeId() const\fP .RE .PP .PP Implements \fBScXMLEventTarget\fP\&. .PP Implemented in \fBSoScXMLDollyTarget\fP, \fBSoScXMLFlightControlTarget\fP, \fBSoScXMLMiscTarget\fP, \fBSoScXMLMotionTarget\fP, \fBSoScXMLPanTarget\fP, \fBSoScXMLRotateTarget\fP, \fBSoScXMLSeekTarget\fP, \fBSoScXMLSpinTarget\fP, and \fBSoScXMLZoomTarget\fP\&. .SS "\fBSoScXMLNavigationTarget::Data\fP * SoScXMLNavigationTarget::getSessionData (\fBSbName\fP sessionid, NewDataFunc * constructor)\fC [protected]\fP" Returns the Data* base handle for the data structure that corresponds to the given \fIsessionid\fP\&. The \fIconstructor\fP argument is the function responsible for creating the Data-derived object if the session is new (or have been cleaned up earlier)\&. .SS "\fBvoid\fP SoScXMLNavigationTarget::freeSessionData (\fBSbName\fP sessionid)\fC [protected]\fP" Cleans out the data structure that is mapped to the given \fIsessionid\fP\&. .SS "\fBSbName\fP SoScXMLNavigationTarget::getSessionId (\fBconst\fP \fBScXMLEvent\fP * event)\fC [static]\fP, \fC [protected]\fP" Returns the session id that is associated with the \fIevent\fP\&. If no session id is found, \fBSbName::empty()\fP is returned\&. .SS "\fBScXMLStateMachine\fP * SoScXMLNavigationTarget::getStateMachine (\fBconst\fP \fBScXMLEvent\fP * event, \fBSbName\fP sessionid)\fC [static]\fP, \fC [protected]\fP" Returns the state machine that is associated with the given \fIsessionid\fP, or NULL if there are no state machines registered for the session id\&. .SS "\fBSoScXMLStateMachine\fP * SoScXMLNavigationTarget::getSoStateMachine (\fBconst\fP \fBScXMLEvent\fP * event, \fBSbName\fP sessionid)\fC [static]\fP, \fC [protected]\fP" Returns the So- state machine that is associated with the given \fIsessionid\fP, or NULL if there are no state machines registered for the session id or if the state machine is not of \fBSoScXMLStateMachine\fP type\&. .SS "\fBSoCamera\fP * SoScXMLNavigationTarget::getActiveCamera (\fBconst\fP \fBScXMLEvent\fP * event, \fBSbName\fP sessionid)\fC [static]\fP, \fC [protected]\fP" Returns the current active camera, or NULL if there is no active camera set\&. If NULL is returned, error messages have been posted\&. .SS "SbBool SoScXMLNavigationTarget::getEventDouble (\fBconst\fP \fBScXMLEvent\fP * event, \fBconst\fP char * label, double & dbl_out, SbBool required = \fCTRUE\fP)\fC [static]\fP, \fC [protected]\fP" Returns TRUE if a double was delivered with the event under the label \fIlabel\fP, and FALSE otherwise\&. If \fIrequired\fP is TRUE, then errors will be given, otherwise this function will remain quiet\&. .SS "SbBool SoScXMLNavigationTarget::getEventString (\fBconst\fP \fBScXMLEvent\fP * event, \fBconst\fP char * label, \fBSbString\fP & str_out, SbBool required = \fCTRUE\fP)\fC [static]\fP, \fC [protected]\fP" Returns TRUE if a string was delivered with the event under the label \fIlabel\fP, and FALSE otherwise\&. If \fIrequired\fP is TRUE, then errors will be given, otherwise this function will remain quiet\&. .SS "SbBool SoScXMLNavigationTarget::getEventSbBool (\fBconst\fP \fBScXMLEvent\fP * event, \fBconst\fP char * label, SbBool & bool_out, SbBool required = \fCTRUE\fP)\fC [static]\fP, \fC [protected]\fP" Returns TRUE if a boolean value was delivered with the event under the label \fIlabel\fP, and FALSE otherwise\&. If \fIrequired\fP is TRUE, then errors will be given, otherwise this function will remain quiet\&. .SS "SbBool SoScXMLNavigationTarget::getEventSbVec2f (\fBconst\fP \fBScXMLEvent\fP * event, \fBconst\fP char * label, \fBSbVec2f\fP & vec_out, SbBool required = \fCTRUE\fP)\fC [static]\fP, \fC [protected]\fP" Returns TRUE if an \fBSbVec2f\fP was delivered with the event under the label \fIlabel\fP, and FALSE otherwise\&. If \fIrequired\fP is TRUE, then errors will be given, otherwise this function will remain quiet\&. .SS "SbBool SoScXMLNavigationTarget::getEventSbVec3f (\fBconst\fP \fBScXMLEvent\fP * event, \fBconst\fP char * label, \fBSbVec3f\fP & vec_out, SbBool required = \fCTRUE\fP)\fC [static]\fP, \fC [protected]\fP" Returns TRUE if an \fBSbVec3f\fP was delivered with the event under the label \fIlabel\fP, and FALSE otherwise\&. If \fIrequired\fP is TRUE, then errors will be given, otherwise this function will remain quiet\&. .SS "SbBool SoScXMLNavigationTarget::getEventSbRotation (\fBconst\fP \fBScXMLEvent\fP * event, \fBconst\fP char * label, \fBSbRotation\fP & rot_out, SbBool required = \fCTRUE\fP)\fC [static]\fP, \fC [protected]\fP" Returns TRUE if an \fBSbRotation\fP was delivered with the event under the label \fIlabel\fP, and FALSE otherwise\&. If \fIrequired\fP is TRUE, then errors will be given, otherwise this function will remain quiet\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.