The HOpConstructCylinder class provides support for constructing a cylinder and inserting it into the model. More...

#include <HOpConstructCylinder.h>

Public Member Functions

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

Protected Member Functions

void ConstructWireframeCylinder (HPoint center, float radius, float height)
 
- Protected Member Functions inherited from HBaseOperator
bool IsSpecialKey (HC_KEY key)
 

Protected Attributes

float m_height
 
float m_RadiusLength
 
HVector m_WorldRadiusVector
 
- 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
 

Detailed Description

The HOpConstructCylinder class provides support for constructing a cylinder and inserting it into the model.

HOpConstructCylinder implements four of the mouse button event handlers defined on the base class and maps the event information to local methods that rubberband a cylinder and insert a corresponding HOOPS shell into the HOOPS database.
This provides the basic functionality for drawing a temporary three-dimensional, tesselated cylinder with a circular base, a circular cap of equivalent size, and a number of rectangular, facetted sides with the default as 30. The operation consists of the following steps:

  1. Left Button Down: Register the center point of the cylinder base.
  2. Left Button Down and Drag: Rubberbands the circular base to the desired circumference.
  3. Left Button Up: The base circumference finalized.
  4. No Button Down and Drag: Rubberbands the cylinder to the desired height.
  5. Left Button Down: The height is finalized, the cylinder is cleared from the scene and the operation ends.

More Detailed Description: see event methods.

Constructor & Destructor Documentation

◆ HOpConstructCylinder()

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

Constructs an HOpConstructCylinder 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* HOpConstructCylinder::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 HOpConstructCylinder object.

Reimplemented from HBaseOperator.

Reimplemented in HOpCreateCylinder.

◆ ConstructWireframeCylinder()

void HOpConstructCylinder::ConstructWireframeCylinder ( HPoint  center,
float  radius,
float  height 
)
protected

ConstructWireframeCylinder transforms the pointer coordinates from screen to world space and inserts a wireframe cylinder into the scene. This function is repeatedly called internally by OnNoButtonDownAndMove after the base dimensions have been finalized.

Parameters
centerThe center of the circular top and base of the cylinder.
radiusThe radius of the cylinders's base.
heightThe height of the cylinder.

◆ GetName()

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

Reimplemented from HBaseOperator.

Reimplemented in HOpCreateCylinder.

◆ OnLButtonDown()

virtual int HOpConstructCylinder::OnLButtonDown ( HEventInfo hevent)
virtual

OnLButtonDown records the first pointer position and initiates the cylinder-drawing mechanism. The first point is used as the center of the cylinder's circular base. If the drawing mechanism has already been started such as LButtonDown having been called once already, LButtonDown finalizes the height of the cylinder, clears the scene and ends the operation.

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

Reimplemented from HBaseOperator.

Reimplemented in HOpCreateCylinder.

◆ OnLButtonDownAndMove()

virtual int HOpConstructCylinder::OnLButtonDownAndMove ( HEventInfo hevent)
virtual

OnLButtonDownAndMove draws a rubberbanded line along the circumference of a circle centered on the first pointer position. Note that the basic drawing work is done by HUtility::CreateAxisCircle, while OnLButtonDownAndMove computes and keeps track of the radial vector that defines the cylinder's base.

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 HOpConstructCylinder::OnLButtonUp ( HEventInfo hevent)
virtual

OnLButtonUp finalizes the size of the base, sets the value of m_RadiusLength and m_radius_world_vector, and cleans up. This function is not called after the second call to OnLButtonDown.

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

Reimplemented from HBaseOperator.

◆ OnNoButtonDownAndMove()

virtual int HOpConstructCylinder::OnNoButtonDownAndMove ( HEventInfo hevent)
virtual

OnNoButtonDownAndMove draws rubberband lines from the base the cylinder to the cap.
Note that the basic work is done by repeated internal calls to HOpConstructCylinder::ConstructWireframeCylinder.

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

Reimplemented from HBaseOperator.

Member Data Documentation

◆ m_height

float HOpConstructCylinder::m_height
protected

The height of the cylinder based on first and last pointer positions.

◆ m_RadiusLength

float HOpConstructCylinder::m_RadiusLength
protected

The magnitude of the base radius vector in screen coordinates.

◆ m_WorldRadiusVector

HVector HOpConstructCylinder::m_WorldRadiusVector
protected

The base radius vector in world coordinates.


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