HOpObjectAnnotate

class HOpObjectAnnotate

The HOpObjectAnnotate class provides support for attaching text to an object.

HOpObjectAnnotate implements three mouse event handlers and one keypress handler defined on the base class and maps the event information to HOOPS routines which insert an annotation line and text. This second point in this line is used as the insertion point for text. This provides the basic functionality for annotating objects with useful information. The operation consists of the following steps:

  1. Left Button Down: The operation is initiated. The first point of the line is recorded.
  2. Left Button Down and Drag: Rubberband the line segment to desired position of the next point.
  3. Left Button Down: The last point of the line is recorded.
  4. Key Down: The text string is recorded until the carriage return keypress.

More Detailed Description: see event methods.

Inherits from: HBaseOperator

Methods

HOpObjectAnnotate::HOpObjectAnnotate(HBaseView *view, int DoRepeat = 0, int DoCapture = 1)

Constructs an HOpObjectAnnotate object.

Parameters

view: A pointer to an HBaseView object,

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 HOpObjectAnnotate::~HOpObjectAnnotate()

virtual

virtual char const *HOpObjectAnnotate::GetName()

virtual

Returns

A pointer to a character string denoting the name of the operator which is ‘HOpObjectAnnotate‘.
virtual HBaseOperator *HOpObjectAnnotate::Clone()

virtual

Creates a new operator which is a copy of the current operator. The user is responsible for deleting the newly created operator.

Returns

A pointer to the newly created HOpObjectAnnotate object.
virtual int HOpObjectAnnotate::OnLButtonDown(HEventInfo &hevent)

virtual

OnLButtonDown records the first pointer position and initiates the line-drawing mechanism. If the annotation line has already been started, OnLButtonDown finishes the line and prepares for text to be entered as described in OnKeyDown.

Parameters

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

Returns

An HOperatorReturn indicating the status of the event.
virtual int HOpObjectAnnotate::OnNoButtonDownAndMove(HEventInfo &hevent)

virtual

OnNoButtonDownAndMove draws a rubberbanded line from the first point to 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 HOpObjectAnnotate::OnKeyDown(HEventInfo &hevent)

virtual

OnKeyDown inserts annotation text near the second point in the annotation line. The text field is terminated by a carriage return event. To erase, use the backspace key.

Parameters

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

Returns

An HOperatorReturn indicating the status of the event.
static void HOpObjectAnnotate::AnnotateObject(HBaseView *pView, char const *segment, char *AnnotationText, HPoint lineStart, HPoint lineEnd, bool emit_message)

static

This is a utility function which creates an annotation.

Parameters

pView: A pointer to HBaseView object.

segment: The name of the segment to insert text into.

AnnotationText: The annotation text string to insert.

lineStart: The location of the beginning of the annotation line.

lineEnd: The location of the end of the annotation line.

emit_message: Pass true to indicate that a message should be sent to the emit_message_function

static void HOpObjectAnnotate::AnnotateObjectFromMessage(HBaseView *pView, char const *in_data, unsigned int data_length)

static

This method annotates an object based on the information in the message.

Parameters

pView: A pointer to HBaseView object.

in_data: A character pointer containing the annotation information.

data_length: The size of the in_data.

void HOpObjectAnnotate::finalize_text()

protected

This is a cleanup method that moves annotation from construction segment to the include segment.

Variables

char *HOpObjectAnnotate::m_pString

private

char
HPoint HOpObjectAnnotate::m_ptLast

private

char HOpObjectAnnotate::m_sSegment[MVO_BUFFER_SIZE]

private

char
bool HOpObjectAnnotate::m_bObject

private

bool
int HOpObjectAnnotate::m_iPathKeysCount

private static

int
HC_KEY *HOpObjectAnnotate::m_pSelectionPath

private static

HC_KEY