The HOpMarkupAnnotate class inserts and manipulates annotation into the current scene. More...
#include <HOpMarkupAnnotate.h>
Public Member Functions | |
virtual HBaseOperator * | Clone () |
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 () |
![]() | |
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. | |
HBaseView * | GetView () |
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 |
HUtilityAnnotation & | GetAnnotation () |
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 () |
![]() | |
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 |
![]() | |
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. | |
HBaseView * | m_pView |
The HOOPS view corresponding to this operator. | |
HCutGeometryVisibility | m_TempCutGeometryVisibility |
stores original cut geometry visibility | |
HShadowMode | m_TempShadowMode |
stores original shadow mode | |
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:
More Detailed Description: see event methods
HOpMarkupAnnotate::HOpMarkupAnnotate | ( | HBaseView * | view, |
bool | bAddToLayer = false , |
||
int | DoRepeat = 0 , |
||
int | DoCapture = 1 , |
||
bool | create_new_notes = true |
||
) |
Constructs an HOpMarkupAnnotate object.
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 |
Destructor
|
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.
Reimplemented from HBaseOperator.
|
protected |
Call this to set the operator in an inactive state.
True | of the operator was ended. False if this was called when the operator was not in progress. |
|
inlineprotected |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
|
inlineprotected |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
|
inlineprotected |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
|
inlineprotected |
Accessor for this value.
|
inlineprotected |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
|
virtual |
Reimplemented from HBaseOperator.
Reimplemented in HOpMarkupPostIt.
|
inlineprotected |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
References HC_KEY.
|
inlineprotected |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
|
virtual |
OnKeyDown adds and/or replaces text of the selected annotation with the character or key that was provided in hevent.
hevent | An HEventInfo object containing information about the current event. |
Reimplemented from HBaseOperator.
|
virtual |
OnLButtonDown either selects an existing annotation or inserts a new annotation at the current mouse position.
hevent | An HEventInfo object containing information about the current event. |
Reimplemented from HBaseOperator.
Reimplemented in HOpMarkupPostIt.
|
virtual |
OnLButtonDownAndMove computes the translation transform based on the distance between the first and current pointer positions, and translates the annotation accordingly.
hevent | An HEventInfo object containing information about the current event. |
Reimplemented from HBaseOperator.
|
virtual |
OnLButtonUp finalizes movement of annotation.
hevent | An HEventInfo object containing information about the current event. |
Reimplemented from HBaseOperator.
|
virtual |
OnRButtonDown finalizes movement of annotation.
hevent | An HEventInfo object containing information about the current event. |
Reimplemented from HBaseOperator.
|
inlineprotected |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
|
inlineprotected |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
|
inlineprotected |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
|
inlineprotected |
Accessor for this value.
|
inlineprotected |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
|
inlineprotected |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
|
inlineprotected |
Accessor method for this value (which probably should be private so use the accessor rather than directly accessing it).
|
protected |
Call this to set the operator to active.
|
protected |
Transmit markup layer to HNet.
|
protected |
The annotation object.
|
protected |
Allow annotation to be added to markup layers
|
protected |
If this is true, this operator will insert new node on the left mouse button.
|
protected |
Hide overlapped text doesn't seem to work with quickmoves so we need to keep track of it after we turn it off.
|
protected |
If the text was touched at some point, then we'll need to update m_Annotation.
|
protected |
Sets what type of background we're using.
|
protected |
Selected annotation key