SoScXMLZoomTarget.3coin4 - Man Page

SCXML event target service for zoom-behaviour.

Synopsis

#include <Inventor/scxml/SoScXMLZoomTarget.h>

Inherits SoScXMLNavigationTarget.

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

Public Member Functions inherited from ScXMLEventTarget
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.  
virtual void setEventTargetType (const char *targettype)
const char * getEventTargetType (void) const
virtual void setEventTargetName (const char *targetname)
const char * getEventTargetName (void) const
virtual const ScXMLEvent * getCurrentEvent (void) const
virtual void queueEvent (const ScXMLEvent *event)
virtual void queueEvent (const SbName &eventid)
virtual SbBool processEventQueue (void)
virtual SbBool sendExternalEvent (const ScXMLSendElt *sendelt)
virtual SbBool sendInternalEvent (const ScXMLEventElt *sendelt)
virtual void queueInternalEvent (const ScXMLEvent *event)
virtual void queueInternalEvent (const SbName &eventid)

Public Member Functions inherited from ScXMLObject
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.  
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 SoType getClassTypeId (void)
static void * createInstance (void)
static void initClass (void)
static void cleanClass (void)
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)

Static Public Member Functions inherited from SoScXMLNavigationTarget
static SoType getClassTypeId (void)
static void initClass (void)
static void cleanClass (void)

Static Public Member Functions inherited from ScXMLEventTarget
static SoType getClassTypeId (void)
static void initClass (void)
static void cleanClass (void)

Static Public Member Functions inherited from ScXMLObject
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 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)
virtual SbBool processOneEvent (const ScXMLEvent *event)

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)

Static Protected Member Functions inherited from ScXMLEventTarget
static void registerEventTarget (ScXMLEventTarget *target, const char *sessionid=NULL)
static void unregisterEventTarget (ScXMLEventTarget *target, const char *sessionid=NULL)
static ScXMLEventTarget * getEventTarget (const char *targettype, const char *targetname, 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
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

Coin 3.1

Member Function Documentation

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::reset (SoCamera * camera) [static]

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

SbBool SoScXMLZoomTarget::processOneEvent (const ScXMLEvent * event) [protected], [virtual]

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

Reimplemented from ScXMLEventTarget.

Author

Generated automatically by Doxygen for Coin from the source code.

Info

Wed Jan 18 2023 Version 4.0.0 Coin