HOpMarkupAnnotate
-
class
HOpMarkupAnnotate The
HOpMarkupAnnotateclass inserts and manipulates annotation into the current scene.HOpMarkupAnnotateimplements 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
Inherits from:
HBaseOperatorIndex
Methods
Clone()EndOp()GetAddToLayer()GetAnnotation()GetBackgroundType()GetCreateNewNotes()GetHideOverlappedText()GetName()GetNoteKey()GetTouchedText()HOpMarkupAnnotate()OnKeyDown()OnLButtonDown()OnLButtonDownAndMove()OnLButtonUp()OnRButtonDown()SetAddToLayer()SetAnnotation()SetBackgroundType()SetCreateNewNotes()SetHideOverlappedText()SetNoteKey()SetTouchedText()StartOp()TransmitMarkupSegment()~HOpMarkupAnnotate()
Variables
Methods
-
HOpMarkupAnnotate::HOpMarkupAnnotate(HBaseView *view, bool bAddToLayer = false, int DoRepeat = 0, int DoCapture = 1, bool create_new_notes = true) Constructs an
HOpMarkupAnnotateobject.Parameters
view: A pointer to an
HBaseViewobjectbAddToLayer: 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
-
virtual char const *
HOpMarkupAnnotate::GetName() virtual
Returns
A pointer to a character string denoting the name of the operator, ‘HOpMarkupAnnotate‘.
-
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: AnHEventInfoobject containing information about the current event.Returns
AnHOperatorReturnindicating the status of the event.
-
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: AnHEventInfoobject containing information about the current event.Returns
AnHOperatorReturnindicating the status of the event.
-
virtual int
HOpMarkupAnnotate::OnRButtonDown(HEventInfo &hevent) virtual
OnRButtonDown finalizes movement of annotation.
Parameters
hevent: AnHEventInfoobject containing information about the current event.Returns
AnHOperatorReturnindicating the status of the event.
-
virtual int
HOpMarkupAnnotate::OnLButtonUp(HEventInfo &hevent) virtual
OnLButtonUp finalizes movement of annotation.
Parameters
hevent: AnHEventInfoobject containing information about the current event.Returns
AnHOperatorReturnindicating the status of the event.
-
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: AnHEventInfoobject containing information about the current event.Returns
AnHOperatorReturnindicating the status of the event.
-
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 anHBaseOperatorobject
-
int
HOpMarkupAnnotate::GetBackgroundType() const protected const
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) protected
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
-
HC_KEY
HOpMarkupAnnotate::GetNoteKey() const protected const
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) protected
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
-
HUtilityAnnotation &
HOpMarkupAnnotate::GetAnnotation() 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) protected
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
-
bool
HOpMarkupAnnotate::GetAddToLayer() const protected const
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
-
void
HOpMarkupAnnotate::SetAddToLayer(bool value) protected
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
-
bool
HOpMarkupAnnotate::GetTouchedText() const protected const
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
-
void
HOpMarkupAnnotate::SetTouchedText(bool value) protected
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
-
bool
HOpMarkupAnnotate::GetHideOverlappedText() const protected const
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
-
void
HOpMarkupAnnotate::SetHideOverlappedText(bool onoff) protected
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
-
bool
HOpMarkupAnnotate::GetCreateNewNotes() const protected const
Accessor for this value.
-
void
HOpMarkupAnnotate::SetCreateNewNotes(bool yesno) protected
Accessor for this value.
-
void
HOpMarkupAnnotate::StartOp() protected
Call this to set the operator to active.
-
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.
-
void
HOpMarkupAnnotate::TransmitMarkupSegment() protected
Transmit markup layer to HNet.
Variables
-
int
HOpMarkupAnnotate::m_iBackgroundType protected
intSets what type of background we’re using.
-
HC_KEY
HOpMarkupAnnotate::m_pNoteKey protected
HC_KEYSelected annotation key
-
HUtilityAnnotation
HOpMarkupAnnotate::m_Annotation protected
The annotation object.
-
bool
HOpMarkupAnnotate::m_bAddToLayer protected
boolAllow annotation to be added to markup layers
-
bool
HOpMarkupAnnotate::m_bTouchedText protected
boolIf the text was touched at some point, then we’ll need to update m_Annotation.
-
bool
HOpMarkupAnnotate::m_bHideOverlappedText protected
boolHide overlapped text doesn’t seem to work with quickmoves so we need to keep track of it after we turn it off.
-
bool
HOpMarkupAnnotate::m_bCreateNewNotes protected
boolIf this is true, this operator will insert new node on the left mouse button.