The HOpMarkupFreehand inserts a 2D freehand polyline into a markup layer. If a layer is already active, then the operator will use that layer. Otherwise, the operator will create a new unnamed layer. More...

#include <HOpMarkupFreehand.h>

Public Member Functions

virtual HBaseOperatorClone ()
 
virtual const char * GetName ()
 
 HOpMarkupFreehand (HBaseView *view, int DoRepeat=0, int DoCapture=1)
 
virtual int OnLButtonDown (HEventInfo &hevent)
 
virtual int OnLButtonDownAndMove (HEventInfo &hevent)
 
virtual int OnLButtonUp (HEventInfo &hevent)
 
- 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 OnKeyDown (HEventInfo &hevent)
 
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 OnRButtonDown (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.
 

Static Public Member Functions

static void CreateMarkupFreehand (HBaseView *pView, const char *segment, unsigned int PolyLineLength, HPoint *pPolyline, bool emit_message)
 
static void CreateMarkupFreehand (HBaseView *pView, const char *segment, unsigned int PolyLineLength, double *pPolyline, bool emit_message)
 

Public Attributes

HC_KEY m_lPolyline
 key for HOOPS polyline
 

Protected Attributes

HPoint m_ptLast
 most recent construction point
 
- 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
 

Additional Inherited Members

- Protected Member Functions inherited from HBaseOperator
bool IsSpecialKey (HC_KEY key)
 

Detailed Description

The HOpMarkupFreehand inserts a 2D freehand polyline into a markup layer. If a layer is already active, then the operator will use that layer. Otherwise, the operator will create a new unnamed layer.

HOpMarkupFreehand implements three of the mouse event handlers defined on the base class and maps the event information to logic which inserts a polyline into the scene to serve as a 'MarkupFreehand'.

  1. Left Button Down: operation initiated, markup begins
  2. Left Button Down and Drag: MarkupFreehand is incrementally built and inserted into the construction segment
  3. Left Button Up: depending on existence of an active markup layer it either opens the existing or creates a new markup layer and inserts freehand markup into it

More Detailed Description: see event methods

Constructor & Destructor Documentation

◆ HOpMarkupFreehand()

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

Constructs an HOpMarkupFreehand 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

◆ Clone()

virtual HBaseOperator* HOpMarkupFreehand::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.

◆ CreateMarkupFreehand()

static void HOpMarkupFreehand::CreateMarkupFreehand ( HBaseView pView,
const char *  segment,
unsigned int  PolyLineLength,
HPoint pPolyline,
bool  emit_message 
)
static

CreateMarkupFreehand inserts the polyline representing the freehand drawing into the active markup layer. If there is no active markup layer, then it creates a new unnamed layer.

Parameters
pViewA pointer to the HBaseView object where the markup data should be inserted.
segmentThe name of segment within markup layer that the freehand data should be inserted into.
PolyLineLengthInteger value indicating number of points in the freehand polyline.
pPolylineAn array of triplets, each one defining the x, y and z coordinate of a point of the freehand markup respectively.
emit_messageDetermines if polyline creation is broadcasted to other HNet clients

◆ GetName()

virtual const char* HOpMarkupFreehand::GetName ( )
virtual

returns a pointer to a copy of the operator

Returns
A pointer to a character string denoting the name of the operator, which is 'HOpMarkupFreehand'.

Reimplemented from HBaseOperator.

◆ OnLButtonDown()

virtual int HOpMarkupFreehand::OnLButtonDown ( HEventInfo hevent)
virtual

OnLButtonDown records the first pointer position and initializes the redlining mechanism by creating a polyline which will be incrementally built.

Parameters
heventAn HEventInfo object containing information about the current event.
Returns
An HOperatorReturn indicating the status of the event.

Reimplemented from HBaseOperator.

◆ OnLButtonDownAndMove()

virtual int HOpMarkupFreehand::OnLButtonDownAndMove ( HEventInfo hevent)
virtual

OnLButtonDownAndMove computes the line segment to be incrementally added to the existing polyline.

Parameters
heventAn HEventInfo object containing information about the current event.
Returns
An HOperatorReturn indicating the status of the event.

Reimplemented from HBaseOperator.

◆ OnLButtonUp()

virtual int HOpMarkupFreehand::OnLButtonUp ( HEventInfo hevent)
virtual

OnLButtonUp cleans up the construction segments used during the redling and inserts the polyline representing the 'MarkupFreehand' into the scene.

Parameters
heventAn HEventInfo object containing information about the current event.
Returns
An HOperatorReturn indicating the status of the event.

Reimplemented from HBaseOperator.


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