Coin: SoEvent.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SoEvent.h
1#ifndef COIN_SOEVENT_H
2#define COIN_SOEVENT_H
3
4/**************************************************************************\
5 * Copyright (c) Kongsberg Oil & Gas Technologies AS
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * Neither the name of the copyright holder nor the names of its
20 * contributors may be used to endorse or promote products derived from
21 * this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34\**************************************************************************/
35
36#include <Inventor/SoType.h>
37#include <Inventor/SbVec2s.h>
38#include <Inventor/SbVec2f.h>
39#include <Inventor/SbTime.h>
40#include <Inventor/events/SoSubEvent.h>
41
42class SbViewportRegion;
43class SbVec2f;
44
45 class COIN_DLL_API SoEvent {
46 SO_EVENT_ABSTRACT_HEADER();
47public:
48 static void initClass(void);
49
50 SoEvent(void);
51 virtual ~SoEvent();
52
53 SbBool isOfType(SoType type) const;
54
55 void setTime(const SbTime t);
56 SbTime getTime(void) const;
57
58 void setPosition(const SbVec2s & p);
59 const SbVec2s & getPosition(void) const;
60 const SbVec2s & getPosition(const SbViewportRegion & vpRgn) const;
61 const SbVec2f & getNormalizedPosition(const SbViewportRegion & vpRgn) const;
62
63 void setShiftDown(SbBool isDown);
64 SbBool wasShiftDown(void) const;
65 void setCtrlDown(SbBool isDown);
66 SbBool wasCtrlDown(void) const;
67 void setAltDown(SbBool isDown);
68 SbBool wasAltDown(void) const;
69
70private:
71 SbTime timeofevent;
72 SbVec2s positionofevent;
73 mutable SbVec2s positionVP;
74 mutable SbVec2f positionVPNorm;
75
76 static void initEvents(void);
77
78 struct {
79 unsigned int shiftdown : 1;
80 unsigned int ctrldown : 1;
81 unsigned int altdown : 1;
82 } modifiers;
83};
84
85#endif // !COIN_SOEVENT_H
SbTime
The SbTime class instances represents time values.
Definition SbTime.h:50
SbVec2f
The SbVec2f class is a 2 dimensional vector with floating point coordinates.
Definition SbVec2f.h:49
SbVec2s
The SbVec2s class is a 2 dimensional vector with short integer coordinates.
Definition SbVec2s.h:51
SbViewportRegion
The SbViewportRegion class is a viewport within a full window.
Definition SbViewportRegion.h:40
SoEvent::wasShiftDown
SbBool wasShiftDown(void) const
Definition SoEvent.cpp:260
SoEvent::setAltDown
void setAltDown(SbBool isDown)
Definition SoEvent.cpp:295
SoEvent::setCtrlDown
void setCtrlDown(SbBool isDown)
Definition SoEvent.cpp:272
SoEvent::setPosition
void setPosition(const SbVec2s &p)
Definition SoEvent.cpp:184
SoEvent::setTime
void setTime(const SbTime t)
Definition SoEvent.cpp:161
SoEvent::wasCtrlDown
SbBool wasCtrlDown(void) const
Definition SoEvent.cpp:283
SoEvent::setShiftDown
void setShiftDown(SbBool isDown)
Definition SoEvent.cpp:249
SoEvent::wasAltDown
SbBool wasAltDown(void) const
Definition SoEvent.cpp:306
SoEvent::isOfType
SbBool isOfType(SoType type) const
Definition SoEvent.cpp:147
SoEvent::initClass
static void initClass(void)
Definition SoEvent.cpp:98
SoEvent::getPosition
const SbVec2s & getPosition(void) const
Definition SoEvent.cpp:201
SoEvent::getTime
SbTime getTime(void) const
Definition SoEvent.cpp:172
SoEvent::getNormalizedPosition
const SbVec2f & getNormalizedPosition(const SbViewportRegion &vpRgn) const
Definition SoEvent.cpp:229
SoEvent::SoEvent
SoEvent(void)
Definition SoEvent.cpp:128
SoType
The SoType class is the basis for the runtime type system in Coin.
Definition SoType.h:59