The HOpMarkupAnnotate class inserts/manipulates annotation into the current scene. More...

#include <HOpMarkupMeasure.h>

Public Member Functions

virtual HBaseOperatorClone ()
 
virtual const char * GetName ()
 
 HOpMarkupMeasure (HBaseView *view, bool AddToLayer=false, int DoRepeat=0, int DoCapture=1)
 
virtual int OnKeyDown (HEventInfo &hevent)
 
virtual int OnLButtonDown (HEventInfo &hevent)
 
virtual int OnLButtonDownAndMove (HEventInfo &hevent)
 
virtual int OnLButtonUp (HEventInfo &hevent)
 
virtual int OnRButtonDown (HEventInfo &hevent)
 
virtual ~HOpMarkupMeasure ()
 
- 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 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 OnNoButtonDownAndMove (HEventInfo &hevent)
 
virtual int OnRButtonDblClk (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.
 

Protected Member Functions

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

Protected Attributes

HUtilityAnnotationMeasure m_Annotation
 
bool m_bAddToLayer
 
bool m_bHideOverlappedText
 
bool m_bNewNote
 
bool m_bTouchedText
 
int m_iBackgroundType
 
- 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 HOpMarkupAnnotate class inserts/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: new annotation created/annotation selected
  2. Left Button Down and Drag: dragging
  3. Left Button Up: operation ended

More Detailed Description: see event methods

Constructor & Destructor Documentation

◆ HOpMarkupMeasure()

HOpMarkupMeasure::HOpMarkupMeasure ( HBaseView view,
bool  AddToLayer = false,
int  DoRepeat = 0,
int  DoCapture = 1 
)

constructor

◆ ~HOpMarkupMeasure()

virtual HOpMarkupMeasure::~HOpMarkupMeasure ( )
virtual

destructor

Member Function Documentation

◆ Clone()

virtual HBaseOperator* HOpMarkupMeasure::Clone ( )
virtual

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

Reimplemented from HBaseOperator.

◆ EndOp()

bool HOpMarkupMeasure::EndOp ( )
protected

EbdOp sets the operator in an inactive state

Returns
true of the op was ended false if EndOp was called when the op was already ended.

◆ GetName()

virtual const char* HOpMarkupMeasure::GetName ( )
virtual
Returns
"HOpMarkupMeasure"

Reimplemented from HBaseOperator.

◆ OnKeyDown()

virtual int HOpMarkupMeasure::OnKeyDown ( HEventInfo hevent)
virtual

OnKeyDown adds/replaces text of the selected annotation

Parameters
heventAn HEventInfo object containing information about the current event.
Returns
A value indicating the result of the event handling.

Reimplemented from HBaseOperator.

◆ OnLButtonDown()

virtual int HOpMarkupMeasure::OnLButtonDown ( HEventInfo hevent)
virtual

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

Parameters
heventAn HEventInfo object containing information about the current event.
Returns
A value indicating the result of the event handling.

Reimplemented from HBaseOperator.

◆ OnLButtonDownAndMove()

virtual int HOpMarkupMeasure::OnLButtonDownAndMove ( HEventInfo hevent)
virtual

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

Parameters
heventAn HEventInfo object containing information about the current event.
Returns
A value indicating the result of the event handling.

Reimplemented from HBaseOperator.

◆ OnLButtonUp()

virtual int HOpMarkupMeasure::OnLButtonUp ( HEventInfo hevent)
virtual

OnLButtonUp finalizes movement of annotation

Parameters
heventAn HEventInfo object containing information about the current event.
Returns
A value indicating the result of the event handling.

Reimplemented from HBaseOperator.

◆ OnRButtonDown()

virtual int HOpMarkupMeasure::OnRButtonDown ( HEventInfo hevent)
virtual

OnRButtonDown finalizes movement of annotation

Parameters
heventAn HEventInfo object containing information about the current event.
Returns
A value indicating the result of the event handling.

Reimplemented from HBaseOperator.

◆ StartOp()

void HOpMarkupMeasure::StartOp ( )
protected

StartOp sets the operator in an active state

Member Data Documentation

◆ m_Annotation

HUtilityAnnotationMeasure HOpMarkupMeasure::m_Annotation
protected

The annotation object

◆ m_bAddToLayer

bool HOpMarkupMeasure::m_bAddToLayer
protected

Keeps track of where this not is getting inserted and which segments it's styling.

◆ m_bHideOverlappedText

bool HOpMarkupMeasure::m_bHideOverlappedText
protected

Keeps track of the hide overlapped text setting since we explicitly unset it.

◆ m_bNewNote

bool HOpMarkupMeasure::m_bNewNote
protected

Set if the note is new of it it was selected.

◆ m_bTouchedText

bool HOpMarkupMeasure::m_bTouchedText
protected

Keeps track of if we need to update the note or not.

◆ m_iBackgroundType

int HOpMarkupMeasure::m_iBackgroundType
protected

Keeps track of what background type we're using.


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