CFx SDK Documentation  2023 SP0
FxHitTestInfo.h
Go to the documentation of this file.
1 //
2 // (C) Copyright 2005-2022 by Graebert GmbH.
3 //
4 // Permission to use, copy, modify, and distribute this software in
5 // object code form for any purpose and without fee is hereby granted,
6 // provided that the above copyright notice appears in all copies and
7 // that both that copyright notice and the limited warranty and
8 // restricted rights notice below appear in all supporting
9 // documentation.
10 //
11 // GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
12 // GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
13 // MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE. GRAEBERT GMBH
14 // DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
15 // UNINTERRUPTED OR ERROR FREE.
16 
17 #pragma once
18 
19 #include "FxPragmaPush.h"
20 
21 #include "DDKERNEL.h"
22 
23 #include <DbObjectId.h>
24 
25 #include <Ge/GePoint2d.h>
26 #include <Gs/GsDefs.h>
27 
28 class CFxString;
29 class CFxDocument;
30 
37 {
38 public:
42  typedef enum _GestureState
43  {
44  NoGesture = 0,
45  GestureStarted = 1,
46  GestureUpdated = 2,
47  GestureFinished = 3,
48  GestureCanceled = 4
49  } GestureState;
50 
52  virtual ~CFxHitTestInfo();
53 
54  //mouse events
58  virtual bool IsMouseEvent() const = 0;
62  virtual bool IsDragEvent() const = 0;
66  virtual bool IsKeyboardEvent() const = 0;
70  virtual bool IsKeyboardPressEvent() const = 0;
74  virtual bool IsKeyboardReleaseEvent() const = 0;
78  virtual bool IsMouseWheel() const = 0;
79 
80  virtual bool IsGesture() const = 0;
81  virtual bool IsGesturePan() const = 0;
82  virtual bool IsGesturePinch() const = 0;
83 
87  virtual GestureState GetGestureState() const = 0;
88 
92  virtual bool IsFxEvent() const = 0;
96  virtual int GetFxEventType() const = 0;
99  virtual const OdGsDCPoint GetMousePosition() const = 0;
103  virtual bool IsLeftMouseButtonPressed() const = 0;
107  virtual bool IsMiddleMouseButtonPressed() const = 0;
111  virtual bool IsRightMouseButtonPressed() const = 0;
115  virtual bool IsShiftPressed() const = 0;
119  virtual bool IsCtrlPressed() const = 0;
123  virtual bool IsAltPressed() const = 0;
127  virtual bool IsMouseMoved() const = 0;
131  virtual bool IsLeftButtonDown() const = 0;
135  virtual bool IsLeftButtonUp() const = 0;
139  virtual bool IsMiddleButtonDown() const = 0;
143  virtual bool IsMiddleButtonUp() const = 0;
147  virtual bool IsRightButtonDown() const = 0;
151  virtual bool IsRightButtonUp() const = 0;
155  virtual bool IsMouseOverActiveViewport() const = 0;
159  virtual int GetWheelDelta() const = 0;
165  virtual int GetWheelOrientation() const = 0;
169  virtual const OdGePoint2d & GetGesturePanOffset() const = 0;
173  virtual double GetGesturePinchScaleFactor() const = 0;
177  virtual const OdGsDCPoint & GetGesturePinchCenterPoint() const = 0;
181  virtual double GetGesturePinchRollAngle() const = 0;
185  virtual double GetGestureSwipeAngle() const = 0;
189  virtual bool IsRightButtonTrippleClick() const = 0;
193  virtual bool IsMiddleButtonTrippleClick() const = 0;
197  virtual bool IsLeftButtonTrippleClick() const = 0;
201  virtual bool IsRightButtonDoubleClick() const = 0;
205  virtual bool IsMiddleButtonDoubleClick() const = 0;
209  virtual bool IsLeftButtonDoubleClick() const = 0;
213  virtual bool IsRightButtonClick() const = 0;
217  virtual bool IsMiddleButtonClick() const = 0;
221  virtual bool IsLeftButtonClick() const = 0;
225  virtual bool IsInsideDragSelectSequence() const = 0;
229  virtual bool IsInsideDragDropSequence() const = 0;
230 
231 //keyboard events
235  virtual bool IsCancelPressed() const = 0;
239  virtual bool IsSpacePressed() const = 0;
243  virtual bool IsArrowUpPressed() const = 0;
247  virtual bool IsArrowDownPressed() const = 0;
251  virtual bool IsContinuousEvent() const = 0;
255  virtual bool IsInsideLISP() const = 0;
259  virtual bool IsInsideCommand() const = 0;
263  virtual bool IsInsideSelect() const = 0;
267  virtual int GetKey() const = 0;
271  virtual const CFxString& GetKeyText() const = 0;
275  virtual const CFxDocument* GetFxDocument() const = 0;
279  virtual void EnableSystemCursorGraphics() = 0;
283  virtual void DisableSystemCursorGraphics() = 0;
287  virtual int SystemCursorDisableCount() const = 0;
288 
293 
297  virtual void SkipKeyboardInput() = 0;
298 
299  virtual const CFxEvent* GetEvent() const = 0;
300 
301 };
302 
303 #include "FxPragmaPop.h"
#define DDKERNEL_API
Definition: DDKERNEL.h:32
#define CFxEvent
virtual bool IsInsideLISP() const =0
virtual int GetFxEventType() const =0
virtual bool IsKeyboardReleaseEvent() const =0
virtual double GetGesturePinchRollAngle() const =0
virtual const CFxString & GetKeyText() const =0
virtual bool IsMiddleButtonDoubleClick() const =0
virtual bool IsMiddleButtonUp() const =0
virtual bool IsMouseEvent() const =0
virtual GestureState GetGestureState() const =0
virtual void EnableSystemCursorGraphics()=0
virtual bool IsAltPressed() const =0
virtual bool IsLeftButtonUp() const =0
virtual bool IsRightButtonClick() const =0
virtual int GetWheelOrientation() const =0
virtual bool IsMiddleButtonTrippleClick() const =0
virtual bool IsGesture() const =0
virtual bool IsKeyboardEvent() const =0
virtual bool IsMouseMoved() const =0
virtual bool IsSpacePressed() const =0
virtual bool IsLeftButtonClick() const =0
virtual bool IsCancelPressed() const =0
virtual bool IsLeftMouseButtonPressed() const =0
virtual bool IsGesturePinch() const =0
virtual double GetGesturePinchScaleFactor() const =0
virtual bool IsRightMouseButtonPressed() const =0
virtual const OdGsDCPoint GetMousePosition() const =0
virtual ~CFxHitTestInfo()
virtual bool IsShiftPressed() const =0
virtual bool IsKeyboardPressEvent() const =0
virtual bool IsLeftButtonDoubleClick() const =0
virtual bool IsRightButtonDoubleClick() const =0
virtual bool IsInsideDragSelectSequence() const =0
virtual bool IsMiddleButtonClick() const =0
virtual void SkipKeyboardInput()=0
virtual void SkipNextRightMouseButtonUpEvent()=0
virtual int GetKey() const =0
virtual bool IsMiddleMouseButtonPressed() const =0
virtual bool IsRightButtonTrippleClick() const =0
virtual bool IsCtrlPressed() const =0
virtual bool IsInsideSelect() const =0
virtual bool IsArrowDownPressed() const =0
virtual const CFxEvent * GetEvent() const =0
virtual bool IsLeftButtonTrippleClick() const =0
virtual bool IsGesturePan() const =0
virtual void DisableSystemCursorGraphics()=0
virtual const CFxDocument * GetFxDocument() const =0
virtual bool IsInsideCommand() const =0
virtual const OdGsDCPoint & GetGesturePinchCenterPoint() const =0
virtual bool IsMouseOverActiveViewport() const =0
virtual bool IsRightButtonDown() const =0
virtual const OdGePoint2d & GetGesturePanOffset() const =0
virtual bool IsFxEvent() const =0
virtual bool IsDragEvent() const =0
virtual bool IsRightButtonUp() const =0
virtual bool IsMiddleButtonDown() const =0
virtual bool IsInsideDragDropSequence() const =0
virtual double GetGestureSwipeAngle() const =0
virtual bool IsMouseWheel() const =0
virtual bool IsArrowUpPressed() const =0
enum CFxHitTestInfo::_GestureState GestureState
virtual int SystemCursorDisableCount() const =0
virtual bool IsContinuousEvent() const =0
virtual bool IsLeftButtonDown() const =0
virtual int GetWheelDelta() const =0