HOpMarkupFreehand
-
class
HOpMarkupFreehand The
HOpMarkupFreehandinserts 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.HOpMarkupFreehandimplements 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’.- Left Button Down: operation initiated, markup begins
- Left Button Down and Drag: MarkupFreehand is incrementally built and inserted into the construction segment
- 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
Inherits from:
HBaseOperator
Methods
-
HOpMarkupFreehand::HOpMarkupFreehand(HBaseView *view, int DoRepeat = 0, int DoCapture = 1) Constructs an
HOpMarkupFreehandobject.Parameters
view: A pointer to an
HBaseViewobjectDoRepeat: 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 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 anHBaseOperatorobject
-
virtual char const *
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‘.
-
virtual int
HOpMarkupFreehand::OnLButtonDownAndMove(HEventInfo &hevent) virtual
OnLButtonDownAndMove computes the line segment to be incrementally added to the existing polyline.
Parameters
hevent: AnHEventInfoobject containing information about the current event.Returns
AnHOperatorReturnindicating the status of the event.
-
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
hevent: AnHEventInfoobject containing information about the current event.Returns
AnHOperatorReturnindicating the status of the event.
-
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
hevent: AnHEventInfoobject containing information about the current event.Returns
AnHOperatorReturnindicating the status of the event.
-
static void
HOpMarkupFreehand::CreateMarkupFreehand(HBaseView *pView, char const *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
pView: A pointer to the
HBaseViewobject where the markup data should be inserted.segment: The name of segment within markup layer that the freehand data should be inserted into.
PolyLineLength: Integer value indicating number of points in the freehand polyline.
pPolyline: An array of triplets, each one defining the x, y and z coordinate of a point of the freehand markup respectively.
emit_message: Determines if polyline creation is broadcasted to other HNet clients
-
static void
HOpMarkupFreehand::CreateMarkupFreehand(HBaseView *pView, char const *segment, unsigned int PolyLineLength, double *pPolyline, bool emit_message) static
Variables
-
HC_KEY
HOpMarkupFreehand::m_lPolyline - HC_KEY
key for HOOPS polyline
-
HPoint
HOpMarkupFreehand::m_ptLast protected
most recent construction point