HOpMarkupPostIt Class Reference

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

#include <HOpMarkupPostIt.h>

Public Member Functions

virtual const char * GetName ()
 
 HOpMarkupPostIt (HBaseView *view, int DoRepeat=0, int DoCapture=1)
 
virtual int OnLButtonDown (HEventInfo &hevent)
 
- Public Member Functions inherited from HOpMarkupAnnotate
virtual HBaseOperatorClone ()
 
 HOpMarkupAnnotate (HBaseView *view, bool bAddToLayer=false, int DoRepeat=0, int DoCapture=1, bool create_new_notes=true)
 
virtual int OnKeyDown (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.
 

Additional Inherited Members

- Protected Member Functions inherited from HOpMarkupAnnotate
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 inherited from HOpMarkupAnnotate
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 HOpMarkupPostIt class inserts and manipulates annotation into the current scene.

HOpMarkupPostIt 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: new annotation created/annotation selected
  2. Left Button Down and Drag: dragging
  3. Left Button Up: operation ended

More Detailed Description: see event methods

Constructor & Destructor Documentation

◆ HOpMarkupPostIt()

HOpMarkupPostIt::HOpMarkupPostIt ( HBaseView view,
int  DoRepeat = 0,
int  DoCapture = 1 
)

Constructs an HOpMarkupPostIt object.

Parameters
viewA pointer to an HBaseView object
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.

Member Function Documentation

◆ GetName()

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

Reimplemented from HOpMarkupAnnotate.

◆ OnLButtonDown()

virtual int HOpMarkupPostIt::OnLButtonDown ( HEventInfo hevent)
virtual

OnLButtonDown either selects an existing annotation or inserts a new annotation into the current markup layer 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 HOpMarkupAnnotate.


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