Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HOpMarkupAnnotate Class Reference

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

#include <HOpMarkupAnnotate.h>

Inheritance diagram for HOpMarkupAnnotate:

HBaseOperator HOpMarkupPostIt

List of all members.

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 ()

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 Attributes

HUtilityAnnotation m_Annotation
bool m_bAddToLayer
bool m_bCreateNewNotes
bool m_bHideOverlappedText
bool m_bTouchedText
int m_iBackgroundType
HC_KEY m_pNoteKey


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 ( 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::~HOpMarkupAnnotate (  )  [virtual]

Destructor


Member Function Documentation

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.

bool HOpMarkupAnnotate::EndOp (  )  [protected]

Call this to set the operator in an inactive state.

Return values:
True of the operator was ended. False if this was called when the operator was not in progress.

bool HOpMarkupAnnotate::GetAddToLayer (  )  const [inline, protected]

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

HUtilityAnnotation& HOpMarkupAnnotate::GetAnnotation (  )  [inline, protected]

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

int HOpMarkupAnnotate::GetBackgroundType (  )  const [inline, protected]

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

bool HOpMarkupAnnotate::GetCreateNewNotes (  )  const [inline, protected]

Accessor for this value.

bool HOpMarkupAnnotate::GetHideOverlappedText (  )  const [inline, protected]

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

virtual const char* HOpMarkupAnnotate::GetName (  )  [virtual]

Returns:
A pointer to a character string denoting the name of the operator 'Realtime 2D Camera Pan'.

Reimplemented from HBaseOperator.

Reimplemented in HOpMarkupPostIt.

HC_KEY HOpMarkupAnnotate::GetNoteKey (  )  const [inline, protected]

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

References HC_KEY.

bool HOpMarkupAnnotate::GetTouchedText (  )  const [inline, protected]

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

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

Reimplemented from HBaseOperator.

virtual int HOpMarkupAnnotate::OnLButtonDown ( HEventInfo hevent  )  [virtual]

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.

Reimplemented from HBaseOperator.

Reimplemented in HOpMarkupPostIt.

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

Reimplemented from HBaseOperator.

virtual int HOpMarkupAnnotate::OnLButtonUp ( HEventInfo hevent  )  [virtual]

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.

Reimplemented from HBaseOperator.

virtual int HOpMarkupAnnotate::OnRButtonDown ( HEventInfo hevent  )  [virtual]

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.

Reimplemented from HBaseOperator.

void HOpMarkupAnnotate::SetAddToLayer ( bool  value  )  [inline, protected]

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

void HOpMarkupAnnotate::SetAnnotation ( HUtilityAnnotation const &  rNote  )  [inline, protected]

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

void HOpMarkupAnnotate::SetBackgroundType ( int const   type  )  [inline, protected]

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

void HOpMarkupAnnotate::SetCreateNewNotes ( bool  yesno  )  [inline, protected]

Accessor for this value.

void HOpMarkupAnnotate::SetHideOverlappedText ( bool  onoff  )  [inline, protected]

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

void HOpMarkupAnnotate::SetNoteKey ( HC_KEY const   key  )  [inline, protected]

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

void HOpMarkupAnnotate::SetTouchedText ( bool  value  )  [inline, protected]

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

void HOpMarkupAnnotate::StartOp (  )  [protected]

Call this to set the operator to active.

void HOpMarkupAnnotate::TransmitMarkupSegment (  )  [protected]

Transmit markup layer to HNet.


Member Data Documentation

The annotation object.

Allow annotation to be added to markup layers

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

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

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

Sets what type of background we're using.

HC_KEY HOpMarkupAnnotate::m_pNoteKey [protected]

Selected annotation key


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