1SoEvent(3IV)()                                                  SoEvent(3IV)()
2
3
4

NAME

6       SoEvent — base class for all events
7

INHERITS FROM

9       SoEvent
10

SYNOPSIS

12       #include <Inventor/events/SoEvent.h>
13
14          Methods from class SoEvent:
15
16                         SoEvent()
17     virtual             ~SoEvent()
18     virtual SoType      getTypeId() const
19     static SoType       getClassTypeId()
20     SbBool              isOfType(SoType type) const
21     void                setTime(SbTime t)
22     SbTime              getTime() const
23     void                setPosition(const SbVec2s &p)
24     const SbVec2s &     getPosition() const
25     const SbVec2s &     getPosition(const SbViewportRegion &vpRgn) const
26     const  SbVec2f &     getNormalizedPosition(const SbViewportRegion &vpRgn)
27                              const
28     void                setShiftDown(SbBool isDown)
29     void                setCtrlDown(SbBool isDown)
30     void                setAltDown(SbBool isDown)
31     SbBool              wasShiftDown() const
32     SbBool              wasCtrlDown() const
33     SbBool              wasAltDown() const
34
35

DESCRIPTION

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

METHODS

45                         SoEvent()
46     virtual             ~SoEvent()
47          Constructor and destructor.
48
49     virtual SoType      getTypeId() const
50          Return the type id for this event instance.
51
52     static SoType       getClassTypeId()
53          Return the type id for the SoEvent class.
54
55     SbBool              isOfType(SoType type) const
56          This  returns TRUE if the event is an instance of or derived from an
57          event of the passed type.
58
59     void                setTime(SbTime t)
60     SbTime              getTime() const
61          Set and get the time at which the event occurred.
62
63     void                setPosition(const SbVec2s &p)
64     const SbVec2s &     getPosition() const
65          Set the window pixel location of the cursor when the event occurred.
66          The  position  is relative to the lower left corner of the window in
67          which the event occurred.
68
69     const SbVec2s &     getPosition(const SbViewportRegion &vpRgn) const
70          Get the viewport  pixel  location  of  the  cursor  when  the  event
71          occurred, relative to the specified viewport region.
72
73     const  SbVec2f &     getNormalizedPosition(const SbViewportRegion &vpRgn)
74                              const
75          Get the normalized location of the cursor when the  event  occurred,
76          relative  to  the specified viewport region. The returned value will
77          lie between 0.0 and 1.0.
78
79     void                setShiftDown(SbBool isDown)
80     void                setCtrlDown(SbBool isDown)
81     void                setAltDown(SbBool isDown)
82          Set whether the modifier keys were down when the event occurred.
83
84     SbBool              wasShiftDown() const
85     SbBool              wasCtrlDown() const
86     SbBool              wasAltDown() const
87          Get whether the modifier keys were down when the event occurred.
88
89

SEE ALSO

91       SoButtonEvent,   SoKeyboardEvent,   SoLocation2Event,   SoMotion3Event,
92       SoMouseButtonEvent,     SoSpaceballButtonEvent,    SoHandleEventAction,
93       SoEventCallback, SoSelection, SoInteraction, SoXtDevice, SoXtRenderArea
94
95
96
97
98                                                                SoEvent(3IV)()
Impressum