man SoScXMLNavigationTarget (3): base class for navigation system SCXML event target services

SYNOPSIS

#include <Inventor/navigation/SoScXMLNavigationTarget.h>

Inherits ScXMLEventTarget.

Inherited by SoScXMLDollyTarget, SoScXMLFlightControlTarget, SoScXMLMiscTarget, SoScXMLMotionTarget, SoScXMLPanTarget, SoScXMLRotateTarget, SoScXMLSeekTarget, SoScXMLSpinTarget, and SoScXMLZoomTarget.

Public Member Functions

virtual SoType getTypeId (void) const =0
Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting.

Static Public Member Functions

static SoType getClassTypeId (void)
This static method returns the SoType object associated with objects of this class.
static void initClass (void)
Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
static void cleanClass (void)
Does the opposite of initClass, deallocates any class specific resources and resets the class to an uninitialized state with respect to the Coin typesystem.

Protected Types

typedef Data * NewDataFunc (void)

Protected Member Functions

Data * getSessionData (SbName sessionid, NewDataFunc *constructor)

void freeSessionData (SbName sessionid)

Static Protected Member Functions

static SbName getSessionId (const ScXMLEvent *event)

static ScXMLStateMachine * getStateMachine (const ScXMLEvent *event, SbName sessionid)

static SoScXMLStateMachine * getSoStateMachine (const ScXMLEvent *event, SbName sessionid)

static SoCamera * getActiveCamera (const ScXMLEvent *event, SbName sessionid)

static SbBool getEventDouble (const ScXMLEvent *event, const char *label, double &dbl_out, SbBool required=TRUE)

static SbBool getEventString (const ScXMLEvent *event, const char *label, SbString &str_out, SbBool required=TRUE)

static SbBool getEventSbBool (const ScXMLEvent *event, const char *label, SbBool &bool_out, SbBool required=TRUE)

static SbBool getEventSbVec2f (const ScXMLEvent *event, const char *label, SbVec2f &vec_out, SbBool required=TRUE)

static SbBool getEventSbVec3f (const ScXMLEvent *event, const char *label, SbVec3f &vec_out, SbBool required=TRUE)

static SbBool getEventSbRotation (const ScXMLEvent *event, const char *label, SbRotation &rot_out, SbBool required=TRUE)

Additional Inherited Members

Detailed Description

base class for navigation system SCXML event target services

This class contains some common, useful, utility functions for implementing navigation system event targets.

Since:

: 2009-02-14

Member Function Documentation

SoType SoScXMLNavigationTarget::getClassTypeId (void) [static]

This static method returns the SoType object associated with objects of this class. See Also:

: SoBase::getClassTypeId

Reimplemented from ScXMLEventTarget.

Reimplemented in SoScXMLDollyTarget, SoScXMLZoomTarget, SoScXMLPanTarget, SoScXMLRotateTarget, SoScXMLSeekTarget, SoScXMLSpinTarget, SoScXMLFlightControlTarget, SoScXMLMiscTarget, and SoScXMLMotionTarget.

virtual SoType SoScXMLNavigationTarget::getTypeId (void) const [pure virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting. See Also:

: SoBase::getTypeId() const

Implements ScXMLEventTarget.

Implemented in SoScXMLDollyTarget, SoScXMLZoomTarget, SoScXMLPanTarget, SoScXMLRotateTarget, SoScXMLSeekTarget, SoScXMLSpinTarget, SoScXMLFlightControlTarget, SoScXMLMiscTarget, and SoScXMLMotionTarget.

void SoScXMLNavigationTarget::initClass (void) [static]

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. See Also:

: SoBase::initClass()

Reimplemented from ScXMLEventTarget.

SoScXMLNavigationTarget::Data * SoScXMLNavigationTarget::getSessionData (SbNamesessionid, NewDataFunc *constructor) [protected]

Returns the Data* base handle for the datastructure that corresponds to the given sessionid. The constructor argument is the function responsible for creating the Data-derived object if the session is new (or have been cleaned up earlier).

void SoScXMLNavigationTarget::freeSessionData (SbNamesessionid) [protected]

Cleans out the data structure that is mapped to the given sessionid.

SbName SoScXMLNavigationTarget::getSessionId (const ScXMLEvent *event) [static], [protected]

Returns the sessionid that is associated with the event. If no session id is found, SbName::empty() is returned.

ScXMLStateMachine * SoScXMLNavigationTarget::getStateMachine (const ScXMLEvent *event, SbNamesessionid) [static], [protected]

Returns the state machine that is associated with the given sessionid, or NULL if there are no state machines registered for the session id.

SoScXMLStateMachine * SoScXMLNavigationTarget::getSoStateMachine (const ScXMLEvent *event, SbNamesessionid) [static], [protected]

Returns the So- state machine that is associated with the given sessionid, or NULL if there are no state machines registered for the session id or if the state machine is not of SoScXMLStateMachine type.

SoCamera * SoScXMLNavigationTarget::getActiveCamera (const ScXMLEvent *event, SbNamesessionid) [static], [protected]

Returns the current active camera, or NULL if there is no active camera set. If NULL is returned, error messages has been posted.

SbBool SoScXMLNavigationTarget::getEventDouble (const ScXMLEvent event, const char label, double &dbl_out, SbBoolrequired = TRUE) [static], [protected]

Returns TRUE if a double was delivered with the event under the label label, and FALSE otherwise. If required is TRUE, then errors will be given, otherwise this function will remain quiet.

SbBool SoScXMLNavigationTarget::getEventString (const ScXMLEvent event, const char label, SbString &str_out, SbBoolrequired = TRUE) [static], [protected]

Returns TRUE if a string was delivered with the event under the label label, and FALSE otherwise. If required is TRUE, then errors will be given, otherwise this function will remain quiet.

SbBool SoScXMLNavigationTarget::getEventSbBool (const ScXMLEvent event, const char label, SbBool &bool_out, SbBoolrequired = TRUE) [static], [protected]

Returns TRUE if a boolean value was delivered with the event under the label label, and FALSE otherwise. If required is TRUE, then errors will be given, otherwise this function will remain quiet.

SbBool SoScXMLNavigationTarget::getEventSbVec2f (const ScXMLEvent event, const char label, SbVec2f &vec_out, SbBoolrequired = TRUE) [static], [protected]

Returns TRUE if an SbVec2f was delivered with the event under the label label, and FALSE otherwise. If required is TRUE, then errors will be given, otherwise this function will remain quiet.

SbBool SoScXMLNavigationTarget::getEventSbVec3f (const ScXMLEvent event, const char label, SbVec3f &vec_out, SbBoolrequired = TRUE) [static], [protected]

Returns TRUE if an SbVec3f was delivered with the event under the label label, and FALSE otherwise. If required is TRUE, then errors will be given, otherwise this function will remain quiet.

SbBool SoScXMLNavigationTarget::getEventSbRotation (const ScXMLEvent event, const char label, SbRotation &rot_out, SbBoolrequired = TRUE) [static], [protected]

Returns TRUE if an SbRotation was delivered with the event under the label label, and FALSE otherwise. If required is TRUE, then errors will be given, otherwise this function will remain quiet.

Author

Generated automatically by Doxygen for Coin from the source code.