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

#include <HOpObjectAnnotate.h>

Public Member Functions

virtual HBaseOperatorClone ()
 
virtual const char * GetName ()
 
 HOpObjectAnnotate (HBaseView *view, int DoRepeat=0, int DoCapture=1)
 
virtual int OnKeyDown (HEventInfo &hevent)
 
virtual int OnLButtonDown (HEventInfo &hevent)
 
virtual int OnNoButtonDownAndMove (HEventInfo &hevent)
 
- Public Member Functions inherited from HBaseOperator
int Capture ()
 Returns whether we are currently in mouse capture mode. See this class' constructor for a more detailed description of what this means. This method has been deprecated.
 
HPoint const GetFirstPoint ()
 Returns the initial selection point.
 
HPoint const GetNewPoint ()
 Returns the current selection point.
 
HBaseViewGetView ()
 Returns a pointer to the view that this operator is associated with.
 
 HBaseOperator (HBaseView *view, int DoRepeat=0, int DoCapture=1)
 
virtual int OnKeyUp (HEventInfo &hevent)
 
virtual int OnLButtonDblClk (HEventInfo &hevent)
 
virtual int OnLButtonDownAndMove (HEventInfo &hevent)
 
virtual int OnLButtonUp (HEventInfo &hevent)
 
virtual int OnLRButtonDownAndMove (HEventInfo &hevent)
 
virtual int OnMButtonDblClk (HEventInfo &hevent)
 
virtual int OnMButtonDown (HEventInfo &hevent)
 
virtual int OnMButtonDownAndMove (HEventInfo &hevent)
 
virtual int OnMButtonUp (HEventInfo &hevent)
 
virtual int OnMouseMove (HEventInfo &hevent)
 
virtual int OnMouseWheel (HEventInfo &hevent)
 
virtual int OnRButtonDblClk (HEventInfo &hevent)
 
virtual int OnRButtonDown (HEventInfo &hevent)
 
virtual int OnRButtonDownAndMove (HEventInfo &hevent)
 
virtual int OnRButtonUp (HEventInfo &hevent)
 
virtual int OnTimer (HEventInfo &hevent)
 
virtual int OnTouchesDown (HEventInfo &hevent)
 
virtual int OnTouchesMove (HEventInfo &hevent)
 
virtual int OnTouchesUp (HEventInfo &hevent)
 
virtual bool OperatorStarted ()
 Operator has been started if true, and has not been started if false.
 
int Repeat ()
 Returns whether the operation is repeatable. This method has been deprecated.
 
void SetFirstPoint (HPoint const &new_point)
 Sets the initial selection point.
 
void SetMapTouchesToMouseEvents (bool val)
 Touch Events are mapped to mouse events if true, and are not if false.
 
void SetNewPoint (HPoint const &new_point)
 Sets the current selection point.
 
void SetOperatorStarted (bool val)
 Operator has been started if true, and has not been started if false.
 
void SetView (HBaseView *new_view)
 Sets the view that this operator is associated with.
 

Static Public Member Functions

static void AnnotateObject (HBaseView *pView, const char *segment, char *AnnotationText, HPoint lineStart, HPoint lineEnd, bool emit_message)
 
static void AnnotateObjectFromMessage (HBaseView *pView, const char *in_data, unsigned int data_length)
 

Protected Member Functions

void finalize_text ()
 
- Protected Member Functions inherited from HBaseOperator
bool IsSpecialKey (HC_KEY key)
 

Additional Inherited Members

- Protected Attributes inherited from HBaseOperator
bool m_bMapTouchesToMouseEvents
 Indicates if touch events are mapped to mouse events.
 
bool m_bOpStarted
 Indicates whether the operator has already 'started'. More...
 
int m_doCapture
 Integer indicating whether to capture mouse on button down and release on button up. This parameter has been deprecated.
 
int m_doRepeat
 Integer indicating if the operator is repeatable . This parameter has been deprecated.
 
HPoint m_ptFirst
 Initial selection point.
 
HPoint m_ptNew
 Current selection point.
 
HBaseViewm_pView
 The HOOPS view corresponding to this operator.
 
HCutGeometryVisibility m_TempCutGeometryVisibility
 stores original cut geometry visibility
 
HShadowMode m_TempShadowMode
 stores original shadow mode
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ HOpObjectAnnotate()

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

Constructs an HOpObjectAnnotate object.

Parameters
viewA pointer to an HBaseView object,
DoRepeatAn integer denoting whether this is a repeatable operator. This parameter has been deprecated.
DoCaptureAn 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.

Member Function Documentation

◆ AnnotateObject()

static void HOpObjectAnnotate::AnnotateObject ( HBaseView pView,
const char *  segment,
char *  AnnotationText,
HPoint  lineStart,
HPoint  lineEnd,
bool  emit_message 
)
static

This is a utility function which creates an annotation.

Parameters
pViewA pointer to HBaseView object.
segmentThe name of the segment to insert text into.
AnnotationTextThe annotation text string to insert.
lineStartThe location of the beginning of the annotation line.
lineEndThe location of the end of the annotation line.
emit_messagePass true to indicate that a message should be sent to the emit_message_function

◆ AnnotateObjectFromMessage()

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

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

Parameters
pViewA pointer to HBaseView object.
in_dataA character pointer containing the annotation information.
data_lengthThe size of the in_data.

Referenced by HAnnotateObjectMessageHandler::ProcessMessage().

◆ Clone()

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.

Reimplemented from HBaseOperator.

◆ finalize_text()

void HOpObjectAnnotate::finalize_text ( )
protected

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

◆ GetName()

virtual const char* HOpObjectAnnotate::GetName ( )
virtual
Returns
A pointer to a character string denoting the name of the operator which is 'HOpObjectAnnotate'.

Reimplemented from HBaseOperator.

◆ OnKeyDown()

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
heventAn HEventInfo object containing information about the current event.
Returns
An HOperatorReturn indicating the status of the event.

Reimplemented from HBaseOperator.

◆ OnLButtonDown()

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
heventAn HEventInfo object containing information about the current event.
Returns
An HOperatorReturn indicating the status of the event.

Reimplemented from HBaseOperator.

◆ OnNoButtonDownAndMove()

virtual int HOpObjectAnnotate::OnNoButtonDownAndMove ( HEventInfo hevent)
virtual

OnNoButtonDownAndMove draws a rubberbanded line from the first point to the current mouse position.

Parameters
heventAn HEventInfo object containing information about the current event.
Returns
An HOperatorReturn indicating the status of the event.

Reimplemented from HBaseOperator.


The documentation for this class was generated from the following file: