.TH "SoScXMLDollyTarget" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoScXMLDollyTarget \- SCXML event target service for zoom behaviour\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBSoScXMLNavigationTarget\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBvirtual\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP" .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 * \fBcreateInstance\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 .ti -1c .RI "\fBstatic\fP \fBSoScXMLDollyTarget\fP * \fBconstructSingleton\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBdestructSingleton\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBSoScXMLDollyTarget\fP * \fBsingleton\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSbName\fP & \fBBEGIN\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSbName\fP & \fBUPDATE\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSbName\fP & \fBEND\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSbName\fP & \fBJUMP\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSbName\fP & \fBSTEP_IN\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBconst\fP \fBSbName\fP & \fBSTEP_OUT\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBdolly\fP (\fBSoCamera\fP *camera, float \fBdiff\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBjump\fP (\fBSoCamera\fP *camera, float \fBfocaldistance\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBstep\fP (\fBSoCamera\fP *camera, SbBool \fBexponential\fP, float \fBdiff\fP, float min=0\&.0f, float max=0\&.0f)" .br .in -1c Static Public Member Functions inherited from \fBSoScXMLNavigationTarget\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 \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 Member Functions" .in +1c .ti -1c .RI "\fBSoScXMLDollyTarget\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBprocessOneEvent\fP (\fBconst\fP \fBScXMLEvent\fP *event)" .br .in -1c Protected Member Functions inherited from \fBSoScXMLNavigationTarget\fP .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 .in -1c .SS "Additional Inherited Members" Protected Types inherited from \fBSoScXMLNavigationTarget\fP .in +1c .ti -1c .RI "\fBtypedef\fP \fBData\fP * \fBNewDataFunc\fP(\fBvoid\fP)" .br .in -1c Static Protected Member Functions inherited from \fBSoScXMLNavigationTarget\fP .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 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 SCXML event target service for zoom behaviour\&. Events: .PP \fBx-coin-navigation\&.Dolly\fP\&.* .PP BEGIN _sessionid {string} mouseposition {\fBSbVec2f\fP} [absminfocaldistance] {float} [absmaxfocaldistance] {float} [setfocaldistance] {float} [motiontype] {string:exponential,linear} .PP UPDATE _sessionid {string} mouseposition {\fBSbVec2f\fP} .PP END _sessionid {string} mouseposition {\fBSbVec2f\fP} .PP JUMP _sessionid {string} focaldistance {float} .PP STEP_IN _sessionid [count=1] {float} [absminfocaldistance] {float} [motiontype] {string:exponential,linear} .PP STEP_OUT _sessionid [count=1] {float} [absmaxfocaldistance] {float} [motiontype] {string:exponential,linear} .PP \fBSince\fP .RS 4 Coin \fB3\&.1\fP .RE .PP .SH "Constructor & Destructor Documentation" .PP .SS "SoScXMLDollyTarget::SoScXMLDollyTarget (\fBvoid\fP)\fC [protected]\fP" The constructor registers the singleton with the proper name and target type\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoScXMLDollyTarget::getTypeId (\fBvoid\fP) const\fC [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 \fBSoScXMLNavigationTarget\fP\&. .SS "\fBconst\fP \fBSbName\fP & SoScXMLDollyTarget::BEGIN (\fBvoid\fP)\fC [static]\fP" Returns the full name for the dolly BEGIN SCXML event\&. .SS "\fBconst\fP \fBSbName\fP & SoScXMLDollyTarget::UPDATE (\fBvoid\fP)\fC [static]\fP" Returns the full name for the dolly UPDATE SCXML event\&. .SS "\fBconst\fP \fBSbName\fP & SoScXMLDollyTarget::END (\fBvoid\fP)\fC [static]\fP" Returns the full name for the dolly END SCXML event\&. .SS "\fBconst\fP \fBSbName\fP & SoScXMLDollyTarget::JUMP (\fBvoid\fP)\fC [static]\fP" Returns the full name for the dolly JUMP SCXML event\&. .SS "\fBconst\fP \fBSbName\fP & SoScXMLDollyTarget::STEP_IN (\fBvoid\fP)\fC [static]\fP" Returns the full name for the dolly STEP_IN SCXML event\&. .SS "\fBconst\fP \fBSbName\fP & SoScXMLDollyTarget::STEP_OUT (\fBvoid\fP)\fC [static]\fP" Returns the full name for the dolly STEP_OUT SCXML event\&. .SS "\fBvoid\fP SoScXMLDollyTarget::jump (\fBSoCamera\fP * camera, float focaldistance)\fC [static]\fP" Jumps the camera to \fIfocaldistance\fP distance from the current focal point of the camera\&. This function only changes the \fBSoCamera::position\fP field\&. .PP This function is more or less useless to use on an \fBSoOrthographicCamera\fP\&. .SS "\fBvoid\fP SoScXMLDollyTarget::step (\fBSoCamera\fP * camera, SbBool exponential, float diff, float mindistance = \fC0\&.0f\fP, float maxdistance = \fC0\&.0f\fP)\fC [static]\fP" Steps the camera relative to its orientation and focal point by \fIdiff\fP\&. .PP If \fIexponential\fP is FALSE, then the \fIdiff\fP value is treated as an absolute distance value\&. .PP If \fImindistance\fP and/or \fImaxdistance\fP is anything but \fB0\&.0\fP, they are checked against the focal distance, and the focal distance will be clamped inside the range\&. Both are not needed, if only one is specified, only that part of the range will be used to limit the dollying\&. .PP If exponential is TRUE\&.\&.\&.FIXME .SS "SbBool SoScXMLDollyTarget::processOneEvent (\fBconst\fP \fBScXMLEvent\fP * event)\fC [protected]\fP, \fC [virtual]\fP" Dispatches incoming SCXML events to the corresponding functionality\&. .PP Reimplemented from \fBScXMLEventTarget\fP\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.