MarkupOperator

class HPS.MarkupOperator : public HPS.Operator 

The MarkupOperator class defines an operator which allows the user to insert mark-up text and geometry. This Operator works for both mouse- and touch-driven devices. The markup created through this operator will be deleted when the operator is popped from the View.

The MarkupOperator allows users to add the following markup types:<itemizedlist><listitem>

Freehand: For mouse driven devices, click and move the mouse to draw freehand markup. For touch driven devices, touch down and move your finger to draw freehand markup

</listitem><listitem>

Text: For mouse driven devices, click where you want to place text. Type with the keyboard and click elsewhere when you are done inserting the note. For touch driven devices, tap where you want to place text. Use the software keyboard to type, and hide the keyboard when you are done inserting the note. When inserting text markup on touch devices, the view will shift while inserting text, to allow you to always see the text you are inserting. The view will reset smoothly once you hide the keyboard.

</listitem><listitem>

Circle: For mouse driven devices, click where you want to place the circle. Move the mouse while holding down the button associated with the operator to change the radius of the circle. For touch driven devices, there are two options available for inserting circle markups: a. tap where you want to place the circle and move your finger to change the circle radius b. tap with two fingers. Move and pinch with the fingers to change the position and radius of the circle

</listitem><listitem>

Rectangle: For mouse driven devices, click where you want to place the top left corner of the rectangle, Move the mouse while holding down the button associated with the operator to change the position of the bottom right corner of the rectangle. For touch driven devices, there are two options available for inserting rectangle markups: a. tap where you want to place the top left corner of the rectangle and move your finger to change the position of the bottom right corner. b. tap with two fingers. Move and pinch with the fingers to change the position and size of the rectangle.

On devices with a keyboard, pressing Escape will delete the markup currently being inserted. An event of type MarkupInsertedEvent in injected after a markup is inserted.

</listitem></itemizedlist>

Public Types

enum MarkupType

Values:

Freehand

Text

Circle

Rectangle

Public Functions

void DeleteMarkups (): Deletes all markups

override void Dispose ()

HPS.RGBColor GetColor ()

Returns the color of the markup which will be inserted.

Return: The color which will be used for the next markup

HPS.LineAttributeKit GetLineAttributes ()

Returns the line attributes of the markup which will be inserted.

Return: The LineAttributeKit which will be used for the next markup

HPS.MarkupOperator.MarkupType GetMarkupType (): Returns the type of markup the operator will insert.

override string GetName (): Returns the name of the operator.

HPS.SegmentKey GetSegmentKey ()

Returns the top markup segment. This segment will not be valid before the operator is attached to the view, and after it is detached from the view.

Return: The segment containing all the markups inserted by this operator

HPS.TextAttributeKit GetTextAttributes ()

Changes the color of the markup which will be inserted.

Return: The TextAttributeKit which will be used for the next markup

bool IsMarkupActive ()

Whether a markup is currently being inserted.

Return: true if a markup is being inserted, false otherwise.

MarkupOperator ()

MarkupOperator (HPS.MarkupOperator in_that)

MarkupOperator (HPS.MouseButtons in_mouse_trigger)

MarkupOperator (HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)

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 when to type markups of type Text from a desktop. To signal that you are done writing a note, press ESC.

Param in_state: A KeyboardState object describing the current keyboard state.
Return: true if the input event was handled, false otherwise.

override bool OnMouseDown (HPS.MouseState in_state)

This function is called whenever HPS receives a MouseEvent that signals a mouse button was pressed. This function starts inserting markup. In the case of text markup, this function determines where the text will be inserted.

Param in_state: A MouseState object describing the current mouse state.
Return: true if the input event was handled, false otherwise.

override bool OnMouseMove (HPS.MouseState in_state)

This function is called whenever HPS receives a MouseEvent that signals the mouse moved When the user is inserting freehand markup, this function continues the markup. When the user is inserting a circle, this function changes the circle’s radius. When the user is inserting a rectangle, this function changes the rectangle’s size.

Param in_state: A MouseState object describing the current mouse state.
Return: true if the input event was handled, false otherwise.

override bool OnMouseUp (HPS.MouseState in_state)

This function is called whenever HPS receives a MouseEvent that signals a mouse button was released.

Param in_state: A MouseState object describing the current mouse state.
Return: true if the input event was handled, false otherwise.

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. This function starts inserting markup. In the case of text markup, this function determines where the text will be inserted.

Param in_state: A TouchState object describing the current touch state.
Return: true if the input event was handled, false otherwise.

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 the user is inserting freehand markup, this function continues the markup. When the user is inserting a circle, this function changes the circle’s radius. When the user is inserting a rectangle, this function changes the rectangle’s size.

Param in_state: A TouchState object describing the current touch state.
Return: true if the input event was handled, false otherwise.

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.

Param in_state: A TouchState object describing the current touch state.
Return: true if the input event was handled, false otherwise.

override void OnViewAttached (HPS.View in_attached_view)

This function is called whenever a view is attached to this operator.

Param in_attached_view: The view attached to this operator.

override void OnViewDetached (HPS.View in_detached_view)

This function is called whenever a view is detached from this operator.

Param in_detached_view: The view detached from this operator.

void SetColor (HPS.RGBColor in_color): Changes the color of the markup which will be inserted.

void SetLineAttribute (HPS.LineAttributeKit in_line_attributes): Changes the color of the markup which will be inserted.

void SetMarkupType (HPS.MarkupOperator.MarkupType in_markup_type): Changes the type of markup the operator will insert.

void SetTextAttribute (HPS.TextAttributeKit in_text_attributes): Returns the text attributes of the markup which will be inserted.

class MarkupInsertedEvent : public HPS.Event 

Public Functions

override HPS.Event Clone ()

Allocates and returns a copy of this MarkupInsertedEvent.

Return: A copy of this MarkupInsertedEvent.

override void Dispose ()

MarkupInsertedEvent (): The default constructor creates an empty MarkupInsertedEvent object.

MarkupInsertedEvent (HPS.Event in_event)

This constructor converts an Event Object to a MarkupInsertedEvent object.

Param in_event: The Event Object to be converted.

MarkupInsertedEvent (HPS.Key in_markup_key, HPS.View in_view)

MarkupInsertedEvent (HPS.MarkupOperator.MarkupInsertedEvent in_that)

Properties

HPS.Key markup_key { get; set; }

HPS.View view { get; set; }