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:

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
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.
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
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.

Public Types

enum MarkupType

Values:

enumerator Freehand

enumerator Text

enumerator Circle

enumerator Rectangle

Public Functions

void DeleteMarkups(): Deletes all markups

inline RGBColor GetColor()

Returns the color of the markup which will be inserted.

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

inline LineAttributeKit GetLineAttributes()

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

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

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

inline virtual HPS::UTF8 GetName() const override: Returns the name of the operator.

inline 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.

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

inline TextAttributeKit GetTextAttributes()

Changes the color of the markup which will be inserted.

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

inline bool IsMarkupActive()

Whether a markup is currently being inserted.

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

MarkupOperator(MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys())

virtual bool OnKeyDown(KeyboardState const &in_state) override

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.

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

virtual bool OnMouseDown(MouseState const &in_state) override

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.

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

virtual bool OnMouseMove(MouseState const &in_state) override

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.

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

virtual bool OnMouseUp(MouseState const &in_state) override

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

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

virtual bool OnTextInput(HPS::UTF8 const &in_text) override

This function is called whenever HPS receives a TextInput event that signals a text string was received. This function is used when to type markups of type Text from a mobile device. To signal that you are done writing a note, inject a HideKeyboardEvent.

Parameters: in_text – The text string received.
Returns: true if the input event was handled, false otherwise.

virtual bool OnTouchDown(TouchState const &in_state) override

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.

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

virtual bool OnTouchMove(TouchState const &in_state) override

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.

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

virtual bool OnTouchUp(TouchState const &in_state) override

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.

virtual void OnViewAttached(HPS::View const &in_attached_view) override

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

Parameters: in_attached_view – The view attached to this operator.

virtual void OnViewDetached(HPS::View const &in_detached_view) override

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

Parameters: in_detached_view – The view detached from this operator.

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

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

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

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

class MarkupInsertedEvent : public HPS::Event 

Public Functions

inline virtual char const *ClassName() const override

inline virtual Event *Clone() const override

Allocates and returns a copy of this MarkupInsertedEvent.

Returns: A copy of this MarkupInsertedEvent.

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

inline MarkupInsertedEvent(Event const &in_event)

This constructor converts an Event Object to a MarkupInsertedEvent object.

Parameters: in_event – The Event Object to be converted.

inline MarkupInsertedEvent(HPS::Key const &in_markup_key, HPS::View const &in_view)

~MarkupInsertedEvent()

Public Members

Key markup_key

View view