SoScXMLEvent(3) Coin SoScXMLEvent(3)NAME
SoScXMLEvent -
Adds an SoEvent holder to the ScXMLEvent base.
SYNOPSIS
#include <Inventor/scxml/SoScXMLEvent.h>
Inherits ScXMLEvent.
Public Member Functions
virtual SoType getTypeId (void) const
virtual void setSoEvent (const SoEvent *soevent)
virtual const SoEvent * getSoEvent (void) const
virtual void setUpIdentifier (void)
Static Public Member Functions
static SoType getClassTypeId (void)
static void * createInstance (void)
static void initClass (void)
Additional Inherited Members
Detailed Description
Adds an SoEvent holder to the ScXMLEvent base.
This class is part of integrating the Coin types with the SCXML subsystem. SoScXMLEvent objects are ScXMLEvents that wraps/passes an
SoEvent to the SCXML state machine.
Since:
Coin 3.0
Member Function Documentation
void SoScXMLEvent::setSoEvent (const SoEvent *soevent) [virtual]
This function stores a pointer to the originator SoEvent that caused the given event, if any.
There is no resource management with regards to this pointer - it has to be kept alive on the outside for as long as this event may live,
and be deallocated on the outside as well.
See also:
setUpIdentifiers
const SoEvent * SoScXMLEvent::getSoEvent (void) const [virtual]
Returns the pointer stored by setSoEvent() or NULL if no pointer has been stored yet.
See also:
setSoEvent
void SoScXMLEvent::setUpIdentifier (void) [virtual]
This method updates the ScXMLEvent event class and event identifier strings based on the set SoEvent object.
The identifiers will be cleared if no SoEvent object has been stored.
See also:
setSoEvent
Author
Generated automatically by Doxygen for Coin from the source code.
Version 3.1.3 Wed May 23 2012 SoScXMLEvent(3)
Check Out this Related Man Page
SoSpaceballButtonEvent(3) Coin SoSpaceballButtonEvent(3)NAME
SoSpaceballButtonEvent -
The SoSpaceballButtonEvent class contains information about spaceball button interaction.
When the user presses any buttons on a spaceball device, these will be translated from a system specific event into a Coin event and sent
to the scenegraph by using instances of this class.
SYNOPSIS
#include <Inventor/events/SoSpaceballButtonEvent.h>
Inherits SoButtonEvent.
Public Types
enum Button { ANY, BUTTON1, BUTTON2, BUTTON3, BUTTON4, BUTTON5, BUTTON6, BUTTON7, BUTTON8, PICK }
Public Member Functions
virtual SoType getTypeId (void) const
SoSpaceballButtonEvent (void)
virtual ~SoSpaceballButtonEvent ()
void setButton (Button button)
Button getButton (void) const
Static Public Member Functions
static SoType getClassTypeId (void)
static void initClass (void)
static SbBool isButtonPressEvent (const SoEvent *e, Button whichButton)
static SbBool isButtonReleaseEvent (const SoEvent *e, Button whichButton)
static SbBool enumToString (Button enumval, SbString &stringrep)
Detailed Description
The SoSpaceballButtonEvent class contains information about spaceball button interaction.
When the user presses any buttons on a spaceball device, these will be translated from a system specific event into a Coin event and sent
to the scenegraph by using instances of this class.
See also:
SoEvent, SoButtonEvent, SoMouseButtonEvent, SoKeyboardEvent
SoEventCallback, SoHandleEventAction
Member Enumeration Documentation
enum SoSpaceballButtonEvent::Button
This enum contains all spaceball buttons detected by Coin.
Constructor &; Destructor Documentation
SoSpaceballButtonEvent::SoSpaceballButtonEvent (void)
Constructor.
SoSpaceballButtonEvent::~SoSpaceballButtonEvent () [virtual]
Destructor.
Member Function Documentation
SoType SoSpaceballButtonEvent::getClassTypeId (void) [static]
This static method returns the SoType object associated with objects of this class.
Reimplemented from SoButtonEvent.
SoType SoSpaceballButtonEvent::getTypeId (void) const [virtual]
Returns the actual type id of an instantiated object.
Reimplemented from SoButtonEvent.
void SoSpaceballButtonEvent::initClass (void) [static]
Initialize the type information data.
Reimplemented from SoButtonEvent.
void SoSpaceballButtonEvent::setButton (SoSpaceballButtonEvent::Buttonbuttonarg)
Set the value of the button which the user interacted with.
This method is used from the window specific device classes when translating events to the generic Coin library.
See also:
getButton()
SoSpaceballButtonEvent::Button SoSpaceballButtonEvent::getButton (void) const
Returns the value of the button which was pressed or released.
See also:
getState()
wasShiftDown(), wasCtrlDown(), wasAltDown(), getPosition(), getTime()
SbBool SoSpaceballButtonEvent::isButtonPressEvent (const SoEvent *e, SoSpaceballButtonEvent::ButtonwhichButton) [static]
Convenience method for quickly checking if the given event is a press on the given button, whichButton.
See also:
isButtonReleaseEvent(), isOfType(), getButton(), getState()
SbBool SoSpaceballButtonEvent::isButtonReleaseEvent (const SoEvent *e, SoSpaceballButtonEvent::ButtonwhichButton) [static]
Convenience method for quickly checking if the given event is a release of the given button, whichButton.
See also:
isButtonPressEvent(), isOfType(), getButton(), getState()
SbBool SoSpaceballButtonEvent::enumToString (Buttonenumval, SbString &stringrep) [static]
Converts from an enum value of type SoMouseButtonEvent::Button to a string containing the enum symbol.
This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.
Since:
Coin 3.0
Author
Generated automatically by Doxygen for Coin from the source code.
Version 3.1.3 Wed May 23 2012 SoSpaceballButtonEvent(3)