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 runtime type checking and "downward" casting.
Public Member Functions inherited from ScXMLEventTarget
virtual const ScXMLEvent *	getCurrentEvent (void) const
const char *	getEventTargetName (void) const
const char *	getEventTargetType (void) const
virtual SbBool	processEventQueue (void)
virtual void	queueEvent (const SbName &eventid)
virtual void	queueEvent (const ScXMLEvent *event)
virtual void	queueInternalEvent (const SbName &eventid)
virtual void	queueInternalEvent (const ScXMLEvent *event)
virtual SbBool	sendExternalEvent (const ScXMLSendElt *sendelt)
virtual SbBool	sendInternalEvent (const ScXMLEventElt *sendelt)
virtual void	setEventTargetName (const char *targetname)
virtual void	setEventTargetType (const char *targettype)
Public Member Functions inherited from ScXMLObject
SbBool	isOfType (SoType type) const
	Returns TRUE if the type of this object is either of the same type or inherited from type.

Static Public Member Functions
static const SbName &	BEGIN (void)
static void	cleanClass (void)
static SoScXMLZoomTarget *	constructSingleton (void)
static void *	createInstance (void)
static void	destructSingleton (void)
static const SbName &	END (void)
static SoType	getClassTypeId (void)
static void	initClass (void)
static void	reset (SoCamera *camera)
static const SbName &	RESET (void)
static SoScXMLZoomTarget *	singleton (void)
static const SbName &	UPDATE (void)
static void	zoom (SoCamera *camera, float factor)
static const SbName &	ZOOM (void)
static const SbName &	ZOOM_IN (void)
static const SbName &	ZOOM_OUT (void)
Static Public Member Functions inherited from SoScXMLNavigationTarget
static void	cleanClass (void)
static SoType	getClassTypeId (void)
static void	initClass (void)
Static Public Member Functions inherited from ScXMLEventTarget
static void	cleanClass (void)
static SoType	getClassTypeId (void)
static void	initClass (void)
Static Public Member Functions inherited from ScXMLObject
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 type system.
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.

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

Additional Inherited Members
Protected Types inherited from SoScXMLNavigationTarget
typedef Data *	NewDataFunc(void)
Static Protected Member Functions inherited from SoScXMLNavigationTarget
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	getEventSbBool (const ScXMLEvent *event, const char *label, SbBool &bool_out, SbBool required=TRUE)
static SbBool	getEventSbRotation (const ScXMLEvent *event, const char *label, SbRotation &rot_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	getEventString (const ScXMLEvent *event, const char *label, SbString &str_out, SbBool required=TRUE)
static SbName	getSessionId (const ScXMLEvent *event)
static SoScXMLStateMachine *	getSoStateMachine (const ScXMLEvent *event, SbName sessionid)
static ScXMLStateMachine *	getStateMachine (const ScXMLEvent *event, SbName sessionid)
Static Protected Member Functions inherited from ScXMLEventTarget
static ScXMLEventTarget *	getEventTarget (const char *targettype, const char *targetname, const char *sessionid=NULL)
static void	registerEventTarget (ScXMLEventTarget *target, const char *sessionid=NULL)
static void	unregisterEventTarget (ScXMLEventTarget *target, const char *sessionid=NULL)
Static Protected Member Functions inherited from ScXMLObject
static void	registerClassType (const char *xmlns, const char *classname, SoType type)
static void	registerInvokeClassType (const char *xmlns, const char *targettype, const char *source, SoType type)
Protected Attributes inherited from ScXMLEventTarget
const ScXMLEvent *	currentevent
SbBool	isprocessingqueue
char *	targetname
char *	targettype

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

Coin 3.1

Member Function Documentation

getTypeId()

SoType SoScXMLZoomTarget::getTypeId ( void ) const

virtual

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

See also

SoBase::getTypeId() const

Implements SoScXMLNavigationTarget.

processOneEvent()

SbBool SoScXMLZoomTarget::processOneEvent ( const ScXMLEvent * event )

protectedvirtual

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

Reimplemented from ScXMLEventTarget.

reset()

void SoScXMLZoomTarget::reset ( SoCamera * camera )

static

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

---

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

• SoScXMLZoomTarget.h
• SoScXMLZoomTarget.cpp