Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HOpConstructCircle Class Reference

The HOpConstructCircle class draws a circle. More...

#include <HOpConstructCircle.h>

List of all members.

Public Member Functions

virtual HBaseOperatorClone ()
virtual const char * GetName ()
 HOpConstructCircle (HBaseView *view, int DoRepeat=0, int DoCapture=1, bool UseCenterMarker=true)
virtual int OnLButtonDown (HEventInfo &hevent)
virtual int OnLButtonDownAndMove (HEventInfo &hevent)
virtual int OnLButtonUp (HEventInfo &hevent)

Protected Attributes

HPoint m_ptCircle [2]
 The first and last points in the circle which are stored in window space.
float m_radius
 The radius of the circle.

Detailed Description

The HOpConstructCircle class draws a circle.

HOpConstructCircle implements three of the mouse button event handlers and uses the event information to draw a circle. This class provides the basic functionality for drawing a temporary, overlayed 2-D box outline in the view plane based on first and last pointer positions. The operation consists of the following steps:

  1. Left Button Down: Identifies the center point of the circle.
  2. Left Button Down and Drag: Rubberband circle to desired dimensions.
  3. Left Button Up: Circle finalized and the polyline primitive used to represent the circle is flushed from the scene.

More Detailed Description: see event methods.


Constructor & Destructor Documentation

HOpConstructCircle::HOpConstructCircle ( HBaseView view,
int  DoRepeat = 0,
int  DoCapture = 1,
bool  UseCenterMarker = true 
)

Constructs an HOpConstructCircle 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.
UseCenterMarkerPass true if you want HOOPS to draw a mark at the center.

Member Function Documentation

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

Reimplemented from HBaseOperator.

Reimplemented in HOpMarkupCircle, and HOpCreateCircle.

virtual const char* HOpConstructCircle::GetName ( ) [virtual]
Returns:
A pointer to a character string denoting the name of the operator which is 'Construct Circle'.

Reimplemented from HBaseOperator.

Reimplemented in HOpMarkupCircle, and HOpCreateCircle.

virtual int HOpConstructCircle::OnLButtonDown ( HEventInfo hevent) [virtual]

OnLButtonDown records the first mouse position and initiates the circle-drawing mechanism.

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

Reimplemented from HBaseOperator.

virtual int HOpConstructCircle::OnLButtonDownAndMove ( HEventInfo hevent) [virtual]

OnLButtonDownAndMove draws rubberbanded lines along the circumference of the circle centered on the first pointer position. Note that the basic dynamic drawing work is done by repeated calls to the HUtility::CreateAxisCircle while OnLButtonDownandMove keeps track the changing radius value.

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

Reimplemented from HBaseOperator.

virtual int HOpConstructCircle::OnLButtonUp ( HEventInfo hevent) [virtual]

OnLButtonUp finalizes the size of the circle and cleans up the geometry that was drawn under the construction key.

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

Reimplemented from HBaseOperator.

Reimplemented in HOpMarkupCircle, and HOpCreateCircle.


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