SoScXMLZoomTarget Class Reference

SCXML event target service for zoom-behaviour. More...

#include <Inventor/scxml/SoScXMLZoomTarget.h>

Inheritance diagram for SoScXMLZoomTarget:

Public Member Functions
virtual SoType	getTypeId (void) const
	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 *	createInstance (void)
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.
static SoScXMLZoomTarget *	constructSingleton (void)
static void	destructSingleton (void)
static SoScXMLZoomTarget *	singleton (void)
static const SbName &	BEGIN (void)
static const SbName &	UPDATE (void)
static const SbName &	END (void)
static const SbName &	ZOOM (void)
static const SbName &	ZOOM_IN (void)
static const SbName &	ZOOM_OUT (void)
static const SbName &	RESET (void)
static void	zoom (SoCamera *camera, float factor)
static void	reset (SoCamera *camera)

Protected Member Functions
virtual SbBool	processOneEvent (const ScXMLEvent *event)
Protected Member Functions inherited from SoScXMLNavigationTarget
Data *	getSessionData (SbName sessionid, NewDataFunc *constructor)
void	freeSessionData (SbName sessionid)
Protected Member Functions inherited from ScXMLEventTarget
virtual void	setCurrentEvent (const ScXMLEvent *event)
virtual const ScXMLEvent *	getNextEvent (void)
virtual const ScXMLEvent *	getNextInternalEvent (void)
virtual const ScXMLEvent *	getNextExternalEvent (void)

Additional Inherited Members
Protected Types inherited from SoScXMLNavigationTarget
typedef Data *	NewDataFunc (void)
Static Protected Member Functions inherited from SoScXMLNavigationTarget
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)
Protected Attributes inherited from ScXMLEventTarget
char *	targetname
char *	targettype
const ScXMLEvent *	currentevent
SbBool	isprocessingqueue

Detailed Description

SCXML event target service for zoom-behaviour.

Events:

x-coin-navigation.Zoom.*

{ BEGIN _sessionid {string} mouseposition {SbVec2f}

UPDATE _sessionid {string} mouseposition {SbVec2f}

END _sessionid {string} mouseposition {SbVec2f} }

ZOOM _sessionid factor {float}

ZOOM_IN _sessionid {string} [factor] {float=1.2} [count] {float=1}

ZOOM_OUT _sessionid {string} [factor] {float=1.2} [count] {float=1}

RESET _sessionid {string}

Since

2008-02-14

Member Function Documentation

SoType SoScXMLZoomTarget::getClassTypeId ( void  )

static

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

See Also

SoBase::getClassTypeId

Reimplemented from SoScXMLNavigationTarget.

SoType SoScXMLZoomTarget::getTypeId ( void  ) const

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 SoScXMLNavigationTarget.

void SoScXMLZoomTarget::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 SoScXMLNavigationTarget.

void SoScXMLZoomTarget::reset ( SoCamera *  camera )

static

This function resets the zooming attributes of the camera to the default values.

SbBool SoScXMLZoomTarget::processOneEvent ( const ScXMLEvent *  event )

protectedvirtual

This function processes one event. The base class implementation does nothing.

Reimplemented from ScXMLEventTarget.

---

The documentation for this class was generated from the following files:

• SoScXMLZoomTarget.h
• SoScXMLZoomTarget.cpp