
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) | |
delegate int | AnnotationOperatorDelegate_0 (IntPtr cPtr, int ret_maxsize, IntPtr ret_str) |
delegate void | AnnotationOperatorDelegate_1 (IntPtr cPtr, IntPtr in_attached_view) |
delegate HPS.Type | AnnotationOperatorDelegate_10 (IntPtr cPtr) |
delegate void | AnnotationOperatorDelegate_11 (IntPtr cPtr, IntPtr in_that) |
delegate bool | AnnotationOperatorDelegate_12 (IntPtr cPtr, IntPtr in_that) |
delegate bool | AnnotationOperatorDelegate_13 (IntPtr cPtr, IntPtr in_state) |
delegate bool | AnnotationOperatorDelegate_14 (IntPtr cPtr, IntPtr in_state) |
delegate bool | AnnotationOperatorDelegate_15 (IntPtr cPtr, IntPtr in_state) |
delegate bool | AnnotationOperatorDelegate_16 (IntPtr cPtr, IntPtr in_state) |
delegate bool | AnnotationOperatorDelegate_17 (IntPtr cPtr, IntPtr in_state) |
delegate bool | AnnotationOperatorDelegate_18 (IntPtr cPtr, IntPtr in_event) |
delegate void | AnnotationOperatorDelegate_19 (IntPtr cPtr) |
delegate void | AnnotationOperatorDelegate_2 (IntPtr cPtr, IntPtr in_detached_view) |
delegate void | AnnotationOperatorDelegate_20 (IntPtr cPtr) |
delegate bool | AnnotationOperatorDelegate_21 (IntPtr cPtr, IntPtr in_state) |
delegate HPS.Type | AnnotationOperatorDelegate_22 (IntPtr cPtr) |
delegate bool | AnnotationOperatorDelegate_23 (IntPtr cPtr) |
delegate void | AnnotationOperatorDelegate_24 (IntPtr cPtr) |
delegate bool | AnnotationOperatorDelegate_3 (IntPtr cPtr, IntPtr in_state) |
delegate bool | AnnotationOperatorDelegate_4 (IntPtr cPtr, IntPtr in_state) |
delegate bool | AnnotationOperatorDelegate_5 (IntPtr cPtr, IntPtr in_state) |
delegate bool | AnnotationOperatorDelegate_6 (IntPtr cPtr, IntPtr in_state) |
delegate bool | AnnotationOperatorDelegate_7 (IntPtr cPtr, IntPtr in_state) |
delegate bool | AnnotationOperatorDelegate_8 (IntPtr cPtr, IntPtr in_state) |
delegate bool | AnnotationOperatorDelegate_9 (IntPtr cPtr, string in_text) |
override void | Dispose () |
string | GetBackgroundShape () |
This function returns the name of the shape definition currently used to draw the annotation background by this operator. More... | |
override string | GetName () |
Returns the name of the operator. More... | |
override bool | OnKeyDown (HPS.KeyboardState in_state) |
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 More... | |
override bool | OnMouseDown (HPS.MouseState in_state) |
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. More... | |
override bool | OnMouseMove (HPS.MouseState in_state) |
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) More... | |
override bool | OnTextInput (string in_text) |
override bool | OnTouchDown (HPS.TouchState in_state) |
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. More... | |
override bool | OnTouchMove (HPS.TouchState in_state) |
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 More... | |
override bool | OnTouchUp (HPS.TouchState in_state) |
This function is called whenever HPS receives a TouchEvent that signals a point of contact has been released. More... | |
override void | OnViewAttached (HPS.View in_attached_view) |
This function is called whenever a view is attached to this operator. More... | |
override void | OnViewDetached (HPS.View in_detached_view) |
This function is called whenever a view is detached from this operator. More... | |
void | SetBackgroundShape (string in_shape) |
![]() | |
virtual void | Assign (HPS.Operator in_that) |
Assigns the parameter in_that to this operator, resulting in a clone. More... | |
void | DetachView () |
Detaches the Operator from the View it was previously attached to. More... | |
delegate void | DtorDelegate (IntPtr cPtr) |
override bool | Equals (System.Object obj) |
virtual bool | Equals (HPS.Operator in_that) |
Tests this operator for equality against the parameter in_that. Same as Operator.operator== More... | |
HPS.View | GetAttachedView () |
Returns the View the Operator is currently attached to. More... | |
override int | GetHashCode () |
HPS.ModifierKeys | GetModifierTrigger () |
Gets the modifier trigger associated with this operator. More... | |
HPS.MouseButtons | GetMouseTrigger () |
Gets the mouse trigger associated with this operator. More... | |
virtual bool | IsMouseTriggered (HPS.MouseState in_state) |
Returns true if the MouseButtons and ModifierKeys are active. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object). More... | |
virtual bool | OnKeyUp (HPS.KeyboardState in_state) |
This function is called whenever HPS receives a KeyboardEvent that signals a key was released. More... | |
virtual void | OnModelAttached () |
This function is called whenever a model is attached to the view that is attached to this operator. If no view is attached to this operator, this function will not be called. More... | |
virtual void | OnModelDetached () |
This function is called whenever a model is detached from the view that is attached to this operator. If no view is attached to this operator, this function will not be called. More... | |
virtual bool | OnMouseEnter (HPS.MouseState in_state) |
This function is called whenever HPS receives a MouseEvent that signals the mouse entered the window. More... | |
virtual bool | OnMouseLeave (HPS.MouseState in_state) |
This function is called whenever HPS receives a MouseEvent that signals the mouse left the window. More... | |
virtual bool | OnMouseUp (HPS.MouseState in_state) |
This function is called whenever HPS receives a MouseEvent that signals a mouse button was released. More... | |
virtual bool | OnMouseWheel (HPS.MouseState in_state) |
This function is called whenever HPS receives a MouseEvent that signals the mouse wheel was scrolled. More... | |
virtual bool | OnTimerTick (HPS.TimerTickEvent in_event) |
This function is called whenever HPS receives a TimerTickEvent. More... | |
Operator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger) | |
Operator (HPS.MouseButtons in_mouse_trigger) | |
Operator (HPS.Operator in_that) | |
delegate HPS.Type | OperatorDelegate_0 (IntPtr cPtr) |
delegate void | OperatorDelegate_1 (IntPtr cPtr, IntPtr in_that) |
delegate bool | OperatorDelegate_10 (IntPtr cPtr, IntPtr in_state) |
delegate bool | OperatorDelegate_11 (IntPtr cPtr, IntPtr in_state) |
delegate bool | OperatorDelegate_12 (IntPtr cPtr, IntPtr in_state) |
delegate bool | OperatorDelegate_13 (IntPtr cPtr, IntPtr in_state) |
delegate bool | OperatorDelegate_14 (IntPtr cPtr, IntPtr in_state) |
delegate bool | OperatorDelegate_15 (IntPtr cPtr, string in_text) |
delegate bool | OperatorDelegate_16 (IntPtr cPtr, IntPtr in_event) |
delegate void | OperatorDelegate_17 (IntPtr cPtr, IntPtr in_attached_view) |
delegate void | OperatorDelegate_18 (IntPtr cPtr, IntPtr in_detached_view) |
delegate void | OperatorDelegate_19 (IntPtr cPtr) |
delegate bool | OperatorDelegate_2 (IntPtr cPtr, IntPtr in_that) |
delegate void | OperatorDelegate_20 (IntPtr cPtr) |
delegate bool | OperatorDelegate_21 (IntPtr cPtr, IntPtr in_state) |
delegate HPS.Type | OperatorDelegate_22 (IntPtr cPtr) |
delegate bool | OperatorDelegate_23 (IntPtr cPtr) |
delegate void | OperatorDelegate_24 (IntPtr cPtr) |
delegate int | OperatorDelegate_3 (IntPtr cPtr, int ret_maxsize, IntPtr ret_str) |
delegate bool | OperatorDelegate_4 (IntPtr cPtr, IntPtr in_state) |
delegate bool | OperatorDelegate_5 (IntPtr cPtr, IntPtr in_state) |
delegate bool | OperatorDelegate_6 (IntPtr cPtr, IntPtr in_state) |
delegate bool | OperatorDelegate_7 (IntPtr cPtr, IntPtr in_state) |
delegate bool | OperatorDelegate_8 (IntPtr cPtr, IntPtr in_state) |
delegate bool | OperatorDelegate_9 (IntPtr cPtr, IntPtr in_state) |
delegate void | RemoveCacheItemDelegate (IntPtr cPtr) |
void | SetModifierTrigger (HPS.ModifierKeys in_modifiers) |
Sets the modifier trigger associated with this operator. More... | |
void | SetMouseTrigger (HPS.MouseButtons in_buttons) |
Sets the mouse trigger for this operator More... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
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