
Classes | |
class | AnnotationInsertedEvent |
Public Member Functions | |
AnnotationOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger) | |
AnnotationOperator (HPS.MouseButtons in_mouse_trigger) | |
AnnotationOperator (HPS.AnnotationOperator in_that) | |
override void | Dispose () |
string | GetBackgroundShape () |
override string | GetName () |
override bool | OnKeyDown (HPS.KeyboardState in_state) |
override bool | OnMouseDown (HPS.MouseState in_state) |
override bool | OnMouseMove (HPS.MouseState in_state) |
override bool | OnTextInput (string in_text) |
override bool | OnTouchDown (HPS.TouchState in_state) |
override bool | OnTouchMove (HPS.TouchState in_state) |
override bool | OnTouchUp (HPS.TouchState in_state) |
override void | OnViewAttached (HPS.View in_attached_view) |
override void | OnViewDetached (HPS.View in_detached_view) |
void | SetBackgroundShape (string in_shape) |
![]() | |
virtual void | Assign (HPS.Operator in_that) |
void | DetachView () |
delegate void | DtorDelegate (IntPtr cPtr) |
override bool | Equals (System.Object obj) |
virtual bool | Equals (HPS.Operator in_that) |
HPS.View | GetAttachedView () |
override int | GetHashCode () |
HPS.ModifierKeys | GetModifierTrigger () |
HPS.MouseButtons | GetMouseTrigger () |
virtual bool | IsMouseTriggered (HPS.MouseState in_state) |
override HPS.Type | ObjectType () |
virtual bool | OnKeyUp (HPS.KeyboardState in_state) |
virtual void | OnModelAttached () |
virtual void | OnModelDetached () |
virtual bool | OnMouseEnter (HPS.MouseState in_state) |
virtual bool | OnMouseLeave (HPS.MouseState in_state) |
virtual bool | OnMouseUp (HPS.MouseState in_state) |
virtual bool | OnMouseWheel (HPS.MouseState in_state) |
virtual bool | OnTimerTick (HPS.TimerTickEvent in_event) |
Operator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger) | |
Operator (HPS.MouseButtons in_mouse_trigger) | |
Operator (HPS.Operator in_that) | |
delegate void | RemoveCacheItemDelegate (IntPtr cPtr) |
void | SetModifierTrigger (HPS.ModifierKeys in_modifiers) |
void | SetMouseTrigger (HPS.MouseButtons in_buttons) |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
virtual bool | Empty () |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
bool | HasType (HPS.Type in_mask) |
Object (HPS.Object that) | |
virtual void | Reset () |
virtual HPS.Type | Type () |
Additional Inherited Members | |
![]() | |
enum | Priority { Low = 0, Default = 1, High = 2 } |
![]() | |
static bool | operator!= (HPS.Operator a, HPS.Operator b) |
static bool | operator== (HPS.Operator a, HPS.Operator b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
HandleRef | sptr |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
![]() | |
static Dictionary< IntPtr, Operator > | cachedObjects = new Dictionary<IntPtr, Operator>() |
static Dictionary< IntPtr, WeakReference > | cachedWeakRefs = new Dictionary<IntPtr, WeakReference>() |
static ReaderWriterLockSlim | mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion) |
Detailed Description
The AnnotationOperator class defines an operator which allows the user to insert annotations. Annotations are text geometries with leader lines and a background. This Operator works for both mouse- and touch-driven devices.
To operate this operator on a mouse-driven device: Click on a piece of geometry and drag the mouse to position an annotation. Start typing to change the annotation text. Once an annotation has been inserted it can be repositioned, and its text can be changed after clicking on it.
To operate this operator on a touch-driven device: Tap on a piece of geometry and drag your finger to position an annotation. Start typing to change the annotation text. Once an annotation has been inserted, tap on it to edit the text. Drag a previously inserted annotation around to reposition it.
An event of type AnnotationInsertedEvent is injected when new annotations are added to the scene.
Member Function Documentation
◆ GetBackgroundShape()
|
inline |
This function returns the name of the shape definition currently used to draw the annotation background by this operator.
- Returns
- The name of the shape definition currently used to draw the annotation background
◆ GetName()
|
inlinevirtual |
Returns the name of the operator.
Reimplemented from HPS.Operator.
◆ OnKeyDown()
|
inlinevirtual |
This function is called whenever HPS receives a KeyboardState event that signals a button was pressed. This function is used to edit the text of annotations
- Parameters
-
in_state A KeyboardState object describing the current keyboard state.
- Returns
- true if the input event was handled, false otherwise.
Reimplemented from HPS.Operator.
◆ OnMouseDown()
|
inlinevirtual |
This function is called whenever HPS receives a MouseEvent that signals a mouse button was pressed. If the user clicks on a piece of geometry other than an existing annotation, a new annotation will be inserted. If the user clicks on an already inserted annotation, that annotation will become editable (it can be repositioned, and its text can be changed). The user can click on the background to stop editing an annotation.
- Parameters
-
in_state A MouseState object describing the current mouse state.
- Returns
- true if the input event was handled, false otherwise.
Reimplemented from HPS.Operator.
◆ OnMouseMove()
|
inlinevirtual |
This function is called whenever HPS receives a MouseEvent that signals the mouse moved When users are inserting or editing an annotation, they will be able to reposition it by dragging the mouse while holding down the trigger button specified in the operator constructor (defaults to Left mouse button)
- Parameters
-
in_state A MouseState object describing the current mouse state.
- Returns
- true if the input event was handled, false otherwise.
Reimplemented from HPS.Operator.
◆ OnTouchDown()
|
inlinevirtual |
This function is called whenever HPS receives a TouchEvent that signals the device was touched. If the user taps a piece of geometry other than an existing annotation, a new annotation will be inserted. If the user taps an already inserted annotation, that annotation will become editable (it can be repositioned, and its text can be changed). The user can tap on the background to stop editing an annotation.
- Parameters
-
in_state A TouchState object describing the current touch state.
- Returns
- true if the input event was handled, false otherwise.
Reimplemented from HPS.Operator.
◆ OnTouchMove()
|
inlinevirtual |
This function is called whenever HPS receives a TouchEvent that signals a point of contact has moved. When users are inserting or editing an annotation, they will be able to reposition it by tapping it and dragging their finger
- Parameters
-
in_state A TouchState object describing the current touch state.
- Returns
- true if the input event was handled, false otherwise.
Reimplemented from HPS.Operator.
◆ OnTouchUp()
|
inlinevirtual |
This function is called whenever HPS receives a TouchEvent that signals a point of contact has been released.
- Parameters
-
in_state A TouchState object describing the current touch state.
- Returns
- true if the input event was handled, false otherwise.
Reimplemented from HPS.Operator.
◆ OnViewAttached()
|
inlinevirtual |
This function is called whenever a view is attached to this operator.
- Parameters
-
in_attached_view The view attached to this operator.
Reimplemented from HPS.Operator.
◆ OnViewDetached()
|
inlinevirtual |
This function is called whenever a view is detached from this operator.
- Parameters
-
in_detached_view The view detached from this operator.
Reimplemented from HPS.Operator.
The documentation for this class was generated from the following file:
- internals/hps_sprk_ops/source/cs/HPS.AnnotationOperator.cs