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

#include <HOpMarkupAnnotate.h>

Public Member Functions

virtual HBaseOperatorClone ()
 
virtual const char * GetName ()
 
 HOpMarkupAnnotate (HBaseView *view, bool bAddToLayer=false, int DoRepeat=0, int DoCapture=1, bool create_new_notes=true)
 
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 ~HOpMarkupAnnotate ()
 
- 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 ()
 
bool GetAddToLayer () const
 
HUtilityAnnotationGetAnnotation ()
 
int GetBackgroundType () const
 
bool GetCreateNewNotes () const
 
bool GetHideOverlappedText () const
 
HC_KEY GetNoteKey () const
 
bool GetTouchedText () const
 
void SetAddToLayer (bool value)
 
void SetAnnotation (HUtilityAnnotation const &rNote)
 
void SetBackgroundType (int const type)
 
void SetCreateNewNotes (bool yesno)
 
void SetHideOverlappedText (bool onoff)
 
void SetNoteKey (HC_KEY const key)
 
void SetTouchedText (bool value)
 
void StartOp ()
 
void TransmitMarkupSegment ()
 
- Protected Member Functions inherited from HBaseOperator
bool IsSpecialKey (HC_KEY key)
 

Protected Attributes

HUtilityAnnotation m_Annotation
 
bool m_bAddToLayer
 
bool m_bCreateNewNotes
 
bool m_bHideOverlappedText
 
bool m_bTouchedText
 
int m_iBackgroundType
 
HC_KEY m_pNoteKey
 
- 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 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

Constructor & Destructor Documentation

◆ HOpMarkupAnnotate()

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

Constructs an HOpMarkupAnnotate object.

Parameters
viewA pointer to an HBaseView object
bAddToLayerA boolean indicating whether the annotation can be added to markup layers
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.

◆ ~HOpMarkupAnnotate()

virtual HOpMarkupAnnotate::~HOpMarkupAnnotate ( )
virtual

Destructor

Member Function Documentation

◆ Clone()

virtual HBaseOperator* HOpMarkupAnnotate::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 HOpMarkupAnnotate::EndOp ( )
protected

Call this to set the operator in an inactive state.

Return values
Trueof the operator was ended. False if this was called when the operator was not in progress.

◆ GetAddToLayer()

bool HOpMarkupAnnotate::GetAddToLayer ( ) const
inlineprotected

Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).

◆ GetAnnotation()

HUtilityAnnotation& HOpMarkupAnnotate::GetAnnotation ( )
inlineprotected

Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).

◆ GetBackgroundType()

int HOpMarkupAnnotate::GetBackgroundType ( ) const
inlineprotected

Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).

◆ GetCreateNewNotes()

bool HOpMarkupAnnotate::GetCreateNewNotes ( ) const
inlineprotected

Accessor for this value.

◆ GetHideOverlappedText()

bool HOpMarkupAnnotate::GetHideOverlappedText ( ) const
inlineprotected

Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).

◆ GetName()

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

Reimplemented from HBaseOperator.

Reimplemented in HOpMarkupPostIt.

◆ GetNoteKey()

HC_KEY HOpMarkupAnnotate::GetNoteKey ( ) const
inlineprotected

Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).

◆ GetTouchedText()

bool HOpMarkupAnnotate::GetTouchedText ( ) const
inlineprotected

Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).

◆ OnKeyDown()

virtual int HOpMarkupAnnotate::OnKeyDown ( HEventInfo hevent)
virtual

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

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 HOpMarkupAnnotate::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
An HOperatorReturn indicating the status of the event.

Reimplemented from HBaseOperator.

Reimplemented in HOpMarkupPostIt.

◆ OnLButtonDownAndMove()

virtual int HOpMarkupAnnotate::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
An HOperatorReturn indicating the status of the event.

Reimplemented from HBaseOperator.

◆ OnLButtonUp()

virtual int HOpMarkupAnnotate::OnLButtonUp ( HEventInfo hevent)
virtual

OnLButtonUp finalizes movement of annotation.

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

Reimplemented from HBaseOperator.

◆ OnRButtonDown()

virtual int HOpMarkupAnnotate::OnRButtonDown ( HEventInfo hevent)
virtual

OnRButtonDown finalizes movement of annotation.

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

Reimplemented from HBaseOperator.

◆ SetAddToLayer()

void HOpMarkupAnnotate::SetAddToLayer ( bool  value)
inlineprotected

Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).

◆ SetAnnotation()

void HOpMarkupAnnotate::SetAnnotation ( HUtilityAnnotation const &  rNote)
inlineprotected

Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).

◆ SetBackgroundType()

void HOpMarkupAnnotate::SetBackgroundType ( int const  type)
inlineprotected

Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).

◆ SetCreateNewNotes()

void HOpMarkupAnnotate::SetCreateNewNotes ( bool  yesno)
inlineprotected

Accessor for this value.

◆ SetHideOverlappedText()

void HOpMarkupAnnotate::SetHideOverlappedText ( bool  onoff)
inlineprotected

Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).

◆ SetNoteKey()

void HOpMarkupAnnotate::SetNoteKey ( HC_KEY const  key)
inlineprotected

Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).

◆ SetTouchedText()

void HOpMarkupAnnotate::SetTouchedText ( bool  value)
inlineprotected

Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).

◆ StartOp()

void HOpMarkupAnnotate::StartOp ( )
protected

Call this to set the operator to active.

◆ TransmitMarkupSegment()

void HOpMarkupAnnotate::TransmitMarkupSegment ( )
protected

Transmit markup layer to HNet.

Member Data Documentation

◆ m_Annotation

HUtilityAnnotation HOpMarkupAnnotate::m_Annotation
protected

The annotation object.

◆ m_bAddToLayer

bool HOpMarkupAnnotate::m_bAddToLayer
protected

Allow annotation to be added to markup layers

◆ m_bCreateNewNotes

bool HOpMarkupAnnotate::m_bCreateNewNotes
protected

If this is true, this operator will insert new node on the left mouse button.

◆ m_bHideOverlappedText

bool HOpMarkupAnnotate::m_bHideOverlappedText
protected

Hide overlapped text doesn't seem to work with quickmoves so we need to keep track of it after we turn it off.

◆ m_bTouchedText

bool HOpMarkupAnnotate::m_bTouchedText
protected

If the text was touched at some point, then we'll need to update m_Annotation.

◆ m_iBackgroundType

int HOpMarkupAnnotate::m_iBackgroundType
protected

Sets what type of background we're using.

◆ m_pNoteKey

HC_KEY HOpMarkupAnnotate::m_pNoteKey
protected

Selected annotation key


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