man SoEvent () - base class for all events

NAME

SoEvent - base class for all events

INHERITS FROM

SoEvent

SYNOPSIS

#include <Inventor/events/SoEvent.h> Methods from class SoEvent: c } c } SoEvent()

c } c } ~SoEvent()

c } c } getTypeId() const

c } c } getClassTypeId()

c } c } isOfType(SoType type) const

c } c } setTime(SbTime t)

c } c } getTime() const

c } c } setPosition(const SbVec2s &p)

c } c } getPosition() const

c } c } getPosition(const SbViewportRegion &vpRgn) const

c } c } getNormalizedPosition(const SbViewportRegion &vpRgn) const

c } c } setShiftDown(SbBool isDown)

c } c } setCtrlDown(SbBool isDown)

c } c } setAltDown(SbBool isDown)

c } c } wasShiftDown() const

c } c } wasCtrlDown() const

c } c } wasAltDown() const

DESCRIPTION

SoEvent is the base class for events in the Inventor event model. An event typically represents a user action, such as a mouse button being pressed or a keyboard key being released. SoEvent contains general information found in all Inventor events, including the time the event occurred, the position of the locater when the event occurred, and the state of the modifier keys when the event occurred.

METHODS

c } c } SoEvent()

c } c } ~SoEvent()

Constructor and destructor. c } c } getTypeId() const

Return the type id for this event instance. c } c } getClassTypeId()

Return the type id for the SoEvent class. c } c } isOfType(SoType type) const

This returns TRUE if the event is an instance of or derived from an event of the passed type. c } c } setTime(SbTime t)

c } c } getTime() const

Set and get the time at which the event occurred. c } c } setPosition(const SbVec2s &p)

c } c } getPosition() const

Set the window pixel location of the cursor when the event occurred. The position is relative to the lower left corner of the window in which the event occurred. c } c } getPosition(const SbViewportRegion &vpRgn) const

Get the viewport pixel location of the cursor when the event occurred, relative to the specified viewport region. c } c } getNormalizedPosition(const SbViewportRegion &vpRgn) const

Get the normalized location of the cursor when the event occurred, relative to the specified viewport region. The returned value will lie between 0.0 and 1.0. c } c } setShiftDown(SbBool isDown)

c } c } setCtrlDown(SbBool isDown)

c } c } setAltDown(SbBool isDown)

Set whether the modifier keys were down when the event occurred. c } c } wasShiftDown() const

c } c } wasCtrlDown() const

c } c } wasAltDown() const

Get whether the modifier keys were down when the event occurred.

SEE ALSO

SoButtonEvent, SoKeyboardEvent, SoLocation2Event, SoMotion3Event, SoMouseButtonEvent, SoSpaceballButtonEvent, SoHandleEventAction, SoEventCallback, SoSelection, SoInteraction, SoXtDevice, SoXtRenderArea