The HOpMarkupAnnotate class inserts and manipulates annotation into the current scene.
More...
#include <HOpMarkupAnnotate.h>
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:
-
Left Button Down: create new annotation created or select existing annotation
-
Left Button Down and Drag: dragging
-
Left Button Up: operation ended
More Detailed Description: see event methods
◆ HOpMarkupAnnotate()
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. |
◆ ~HOpMarkupAnnotate()
virtual HOpMarkupAnnotate::~HOpMarkupAnnotate |
( |
| ) |
|
|
virtual |
◆ Clone()
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
-
True | of 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()
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 |
◆ 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 |
◆ 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
-
hevent | An 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
-
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.
◆ 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
-
hevent | An 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
-
hevent | An 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
-
hevent | An 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()
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 |
◆ 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.
◆ m_Annotation
◆ 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 |
The documentation for this class was generated from the following file: