.TH "SoScXMLMiscTarget" 3 "Fri Sep 6 2024 15:32:06" "Version 4.0.3" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoScXMLMiscTarget \- Miscellaneous navigation utility functions\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <Inventor/navigation/SoScXMLMiscTarget\&.h>\fP
.PP
Inherits \fBSoScXMLNavigationTarget\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const"
.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 \fBSoScXMLNavigationTarget\fP

Public Member Functions inherited from \fBScXMLEventTarget\fP
.in +1c
.ti -1c
.RI "virtual void \fBsetEventTargetType\fP (const char *targettype)"
.br
.ti -1c
.RI "const char * \fBgetEventTargetType\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBsetEventTargetName\fP (const char *targetname)"
.br
.ti -1c
.RI "const char * \fBgetEventTargetName\fP (void) const"
.br
.ti -1c
.RI "virtual const \fBScXMLEvent\fP * \fBgetCurrentEvent\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBqueueEvent\fP (const \fBScXMLEvent\fP *event)"
.br
.ti -1c
.RI "virtual void \fBqueueEvent\fP (const \fBSbName\fP &eventid)"
.br
.ti -1c
.RI "virtual SbBool \fBprocessEventQueue\fP (void)"
.br
.ti -1c
.RI "virtual SbBool \fBsendExternalEvent\fP (const \fBScXMLSendElt\fP *sendelt)"
.br
.ti -1c
.RI "virtual SbBool \fBsendInternalEvent\fP (const \fBScXMLEventElt\fP *sendelt)"
.br
.ti -1c
.RI "virtual void \fBqueueInternalEvent\fP (const \fBScXMLEvent\fP *event)"
.br
.ti -1c
.RI "virtual void \fBqueueInternalEvent\fP (const \fBSbName\fP &eventid)"
.br
.in -1c

Public Member Functions inherited from \fBScXMLObject\fP
.in +1c
.ti -1c
.RI "SbBool \fBisOfType\fP (\fBSoType\fP type) const"
.br
.RI "Returns \fRTRUE\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 "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void * \fBcreateInstance\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.ti -1c
.RI "static void \fBcleanClass\fP (void)"
.br
.ti -1c
.RI "static \fBSoScXMLMiscTarget\fP * \fBconstructSingleton\fP (void)"
.br
.ti -1c
.RI "static void \fBdestructSingleton\fP (void)"
.br
.ti -1c
.RI "static \fBSoScXMLMiscTarget\fP * \fBsingleton\fP (void)"
.br
.ti -1c
.RI "static const \fBSbName\fP & \fBVIEW_ALL\fP (void)"
.br
.ti -1c
.RI "static const \fBSbName\fP & \fBREDRAW\fP (void)"
.br
.ti -1c
.RI "static const \fBSbName\fP & \fBPOINT_AT\fP (void)"
.br
.ti -1c
.RI "static const \fBSbName\fP & \fBSET_FOCAL_DISTANCE\fP (void)"
.br
.ti -1c
.RI "static const \fBSbName\fP & \fBSET_CAMERA_POSITION\fP (void)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoScXMLNavigationTarget\fP
.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.ti -1c
.RI "static void \fBcleanClass\fP (void)"
.br
.in -1c

Static Public Member Functions inherited from \fBScXMLEventTarget\fP
.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.ti -1c
.RI "static void \fBcleanClass\fP (void)"
.br
.in -1c

Static Public Member Functions inherited from \fBScXMLObject\fP
.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.RI "This static method returns the \fBSoType\fP object associated with objects of this class\&.    "
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.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 "static void \fBcleanClass\fP (void)"
.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 "virtual SbBool \fBprocessOneEvent\fP (const \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 *constructor)"
.br
.ti -1c
.RI "void \fBfreeSessionData\fP (\fBSbName\fP sessionid)"
.br
.in -1c

Protected Member Functions inherited from \fBScXMLEventTarget\fP
.in +1c
.ti -1c
.RI "virtual void \fBsetCurrentEvent\fP (const \fBScXMLEvent\fP *event)"
.br
.ti -1c
.RI "virtual const \fBScXMLEvent\fP * \fBgetNextEvent\fP (void)"
.br
.ti -1c
.RI "virtual const \fBScXMLEvent\fP * \fBgetNextInternalEvent\fP (void)"
.br
.ti -1c
.RI "virtual const \fBScXMLEvent\fP * \fBgetNextExternalEvent\fP (void)"
.br
.in -1c
.SS "Additional Inherited Members"


Protected Types inherited from \fBSoScXMLNavigationTarget\fP
.in +1c
.ti -1c
.RI "typedef \fBData\fP * \fBNewDataFunc\fP(void)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoScXMLNavigationTarget\fP
.in +1c
.ti -1c
.RI "static \fBSbName\fP \fBgetSessionId\fP (const \fBScXMLEvent\fP *event)"
.br
.ti -1c
.RI "static \fBScXMLStateMachine\fP * \fBgetStateMachine\fP (const \fBScXMLEvent\fP *event, \fBSbName\fP sessionid)"
.br
.ti -1c
.RI "static \fBSoScXMLStateMachine\fP * \fBgetSoStateMachine\fP (const \fBScXMLEvent\fP *event, \fBSbName\fP sessionid)"
.br
.ti -1c
.RI "static \fBSoCamera\fP * \fBgetActiveCamera\fP (const \fBScXMLEvent\fP *event, \fBSbName\fP sessionid)"
.br
.ti -1c
.RI "static SbBool \fBgetEventDouble\fP (const \fBScXMLEvent\fP *event, const char *label, double &dbl_out, SbBool required=TRUE)"
.br
.ti -1c
.RI "static SbBool \fBgetEventString\fP (const \fBScXMLEvent\fP *event, const char *label, \fBSbString\fP &str_out, SbBool required=TRUE)"
.br
.ti -1c
.RI "static SbBool \fBgetEventSbBool\fP (const \fBScXMLEvent\fP *event, const char *label, SbBool &bool_out, SbBool required=TRUE)"
.br
.ti -1c
.RI "static SbBool \fBgetEventSbVec2f\fP (const \fBScXMLEvent\fP *event, const char *label, \fBSbVec2f\fP &vec_out, SbBool required=TRUE)"
.br
.ti -1c
.RI "static SbBool \fBgetEventSbVec3f\fP (const \fBScXMLEvent\fP *event, const char *label, \fBSbVec3f\fP &vec_out, SbBool required=TRUE)"
.br
.ti -1c
.RI "static SbBool \fBgetEventSbRotation\fP (const \fBScXMLEvent\fP *event, const char *label, \fBSbRotation\fP &rot_out, SbBool required=TRUE)"
.br
.in -1c

Static Protected Member Functions inherited from \fBScXMLEventTarget\fP
.in +1c
.ti -1c
.RI "static void \fBregisterEventTarget\fP (\fBScXMLEventTarget\fP *target, const char *sessionid=NULL)"
.br
.ti -1c
.RI "static void \fBunregisterEventTarget\fP (\fBScXMLEventTarget\fP *target, const char *sessionid=NULL)"
.br
.ti -1c
.RI "static \fBScXMLEventTarget\fP * \fBgetEventTarget\fP (const char *targettype, const char *targetname, const char *sessionid=NULL)"
.br
.in -1c

Static Protected Member Functions inherited from \fBScXMLObject\fP
.in +1c
.ti -1c
.RI "static void \fBregisterClassType\fP (const char *xmlns, const char *classname, \fBSoType\fP type)"
.br
.ti -1c
.RI "static void \fBregisterInvokeClassType\fP (const char *xmlns, const char *targettype, const 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 "const \fBScXMLEvent\fP * \fBcurrentevent\fP"
.br
.ti -1c
.RI "SbBool \fBisprocessingqueue\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Miscellaneous navigation utility functions\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoScXMLMiscTarget::getTypeId (void ) const\fR [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 "SbBool SoScXMLMiscTarget::processOneEvent (const \fBScXMLEvent\fP * event)\fR [protected]\fP, \fR [virtual]\fP"
This function processes one event\&. The base class implementation does nothing\&. 
.PP
Reimplemented from \fBScXMLEventTarget\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.