The HOpConstructPolyline class draws a polyline. More...

#include <HOpConstructPolyline.h>

Public Member Functions

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

Public Attributes

HC_KEY m_PolylineKey
 

Protected Attributes

int m_PolylineCount
 
HPointm_pPolyline
 
HPoint m_ptLast
 
- 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 HOpConstructPolyline class draws a polyline.

HOpConstructPolyline implements three of the mouse button event handlers defined on the base class and maps the event information to create a polyline. This provides the basic functionality for dynamically creating a temporary, overlayed polyline in the view plane based on pointer input. The polyline points are stored in a protected member array until a double click event is passe. The operation consists of the following steps:

  1. Left Button Down: The operation is initiated and the first point of the polyline is recorded.
  2. No Button Down and Drag: Rubberband line segment to the desired position of the next point.
  3. Left Button Down: The next point in polyline is recorded and continues until the user double clicks the left mouse button.
  4. Left Button Double Click: The polyline is finalized and the geometry is flushed from the scene.

More Detailed Description: see event methods.

Constructor & Destructor Documentation

◆ HOpConstructPolyline()

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

Constructs an HOpConstructPolyline 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* HOpConstructPolyline::Clone ( )
virtual

Creates a new operator which is a copy of the current operator. The user is responsible for deleting the newly created operator.

Returns
A pointer to the newly created HOpConstructPolyline object.

Reimplemented from HBaseOperator.

Reimplemented in HOpConstructNurbsCurve, HOpCreatePolyline, HOpSelectPolygon, HOpSelectPolyline, HOpSelectPolygonOOC< SelectionSet >, and HOpCreateNurbsCurve.

◆ GetName()

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

Reimplemented from HBaseOperator.

Reimplemented in HOpCreatePolyline, HOpConstructNurbsCurve, HOpCreateNurbsCurve, HOpSelectPolygon, HOpSelectPolyline, and HOpSelectPolygonOOC< SelectionSet >.

◆ OnLButtonDblClk()

virtual int HOpConstructPolyline::OnLButtonDblClk ( HEventInfo hevent)
virtual

OnLButtonDblClk places the final mouse position into the temp array. This function also takes care of any cleanup.

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

Reimplemented from HBaseOperator.

Reimplemented in HOpConstructNurbsCurve, HOpSelectPolygonOOC< SelectionSet >, HOpCreatePolyline, HOpSelectPolygon, HOpSelectPolyline, and HOpCreateNurbsCurve.

◆ OnLButtonDown()

virtual int HOpConstructPolyline::OnLButtonDown ( HEventInfo hevent)
virtual

OnLButtonDown records the first mouse position and initiates the polyline-drawing mechanism. The function also records each successive point in the polyline in a temp array, and connects the points with a line.

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

Reimplemented from HBaseOperator.

Reimplemented in HOpConstructNurbsCurve, HOpSelectPolygon, and HOpSelectPolygonOOC< SelectionSet >.

◆ OnNoButtonDownAndMove()

virtual int HOpConstructPolyline::OnNoButtonDownAndMove ( HEventInfo hevent)
virtual

OnNoButtonDownAndMove draws a rubberbanded line from the previous point in the polyline to 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 HBaseOperator.

Reimplemented in HOpConstructNurbsCurve.

Member Data Documentation

◆ m_PolylineCount

int HOpConstructPolyline::m_PolylineCount
protected

The number of points in the polyline.

◆ m_PolylineKey

HC_KEY HOpConstructPolyline::m_PolylineKey

The key for HOOPS polyline.

◆ m_pPolyline

HPoint* HOpConstructPolyline::m_pPolyline
protected

A pointer to the array of points for HOOPS Polyline in World Space.

◆ m_ptLast

HPoint HOpConstructPolyline::m_ptLast
protected

the last point in the temporary polyline array (not m_pPolyline) behind the current mouse position. See OnLButtonDown.


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