HOpMarkupAnnotate

Functions

	HOpMarkupAnnotate
	~HOpMarkupAnnotate
char const *	GetName
int	OnLButtonDown
int	OnLButtonDownAndMove
int	OnRButtonDown
int	OnLButtonUp
int	OnKeyDown
HBaseOperator *	Clone

Detailed Description

class HOpMarkupAnnotate : public HBaseOperator

The HOpMarkupAnnotate class inserts and manipulates annotation into the current scene.

HOpMarkupAnnotate implements three mouse event methods defined on the base class and maps the event information to operator routines. This operation consists of the following steps:

1. Left Button Down: create new annotation created or select existing annotation

2. Left Button Down and Drag: dragging

3. Left Button Up: operation ended

More Detailed Description: see event methods

Subclassed by HOpMarkupPostIt

Public Functions

HOpMarkupAnnotate(HBaseView *view, bool bAddToLayer = false, int DoRepeat = 0, int DoCapture = 1, bool create_new_notes = true)

Constructs an HOpMarkupAnnotate object.

Parameters

• view – A pointer to an HBaseView object

• bAddToLayer – A boolean indicating whether the annotation can be added to markup layers

• DoRepeat – An integer denoting whether this is a repeatable operator. This parameter has been deprecated.

• DoCapture – An integer denoting whether the mouse state should be captured, which means that all mouse events should be received after a mousedown, even if it leaves the window. This parameter has been deprecated.

virtual ~HOpMarkupAnnotate()

Destructor

virtual char const *GetName()

Returns

A pointer to a character string denoting the name of the operator, ‘HOpMarkupAnnotate’.

virtual int OnLButtonDown(HEventInfo &hevent)

OnLButtonDown either selects an existing annotation or inserts a new annotation at the current mouse position.

Parameters

hevent – An HEventInfo object containing information about the current event.

Returns

An HOperatorReturn indicating the status of the event.

virtual int OnLButtonDownAndMove(HEventInfo &hevent)

OnLButtonDownAndMove computes the translation transform based on the distance between the first and current pointer positions, and translates the annotation accordingly.

Parameters

hevent – An HEventInfo object containing information about the current event.

Returns

An HOperatorReturn indicating the status of the event.

virtual int OnRButtonDown(HEventInfo &hevent)

OnRButtonDown finalizes movement of annotation.

Parameters

hevent – An HEventInfo object containing information about the current event.

Returns

An HOperatorReturn indicating the status of the event.

virtual int OnLButtonUp(HEventInfo &hevent)

OnLButtonUp finalizes movement of annotation.

Parameters

hevent – An HEventInfo object containing information about the current event.

Returns

An HOperatorReturn indicating the status of the event.

virtual int OnKeyDown(HEventInfo &hevent)

OnKeyDown adds and/or replaces text of the selected annotation with the character or key that was provided in hevent.

Parameters

hevent – An HEventInfo object containing information about the current event.

Returns

An HOperatorReturn indicating the status of the event.

virtual HBaseOperator *Clone()

Creates a new operator which is associated with the same view as the current operator. The user is responsible for deleting the newly created operator.

Returns

A pointer to an HBaseOperator object