Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HOpConstructPolyline Class Reference

The HOpConstructPolyline class draws a polyline. More...

#include <HOpConstructPolyline.h>

List of all members.

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 Attributes

HC_KEY m_PolylineKey

Protected Attributes

int m_PolylineCount
HPointm_pPolyline
HPoint m_ptLast

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 ( 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

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, and HOpCreateNurbsCurve.

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, and HOpSelectPolyline.

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, HOpCreatePolyline, HOpSelectPolygon, HOpSelectPolyline, and HOpCreateNurbsCurve.

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, and HOpSelectPolygon.

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

The number of points in the polyline.

The key for HOOPS polyline.

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

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: