HOpConstructCuboid Class Reference

The HOpConstructCuboid class creates a rectangular cube. More...

#include <HOpConstructCuboid.h>

Public Member Functions

HBaseOperatorClone ()
 
virtual void CreateCuboid (HPoint const &last)
 
virtual void CreateSquare (HPoint const &first, HPoint const &last)
 
virtual const char * GetName ()
 
 HOpConstructCuboid (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 Attributes

int m_FaceList [30]
 
HPoint m_ptEdge
 
HPoint m_ptPointList [8]
 
- 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 HOpConstructCuboid class creates a rectangular cube.

HOpConstructCuboid implements four of the mouse event handlers defined on the base class and uses the event information to create a cuboid. This provides the basic functionality for creating a temporary three-dimensional, six-sided cuboid or rectangular box. The cuboid that is generated includes two square faces with the same length and width while the depth is variable. The operation consists of the following steps:

  1. Left Button Down: The first point of square base.
  2. Left Button Down and Drag: Rubberband the base to the desired dimensions.
  3. Left Button Up: The base of the cuboid dimension is finalized.
  4. No Button Down and Drag: Rubberband the cuboid to the desired height.
  5. Left Button Down: The height of the cuboid finalized and the operation ends.

More Detailed Description: see event methods.

Constructor & Destructor Documentation

◆ HOpConstructCuboid()

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

Constructs an HOpConstructCuboid 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()

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

Reimplemented from HBaseOperator.

Reimplemented in HOpCreateCuboid.

◆ CreateCuboid()

virtual void HOpConstructCuboid::CreateCuboid ( HPoint const &  last)
virtual

CreateCuboid constructs the point list from the first, edge and last point and then maps these screen coordinates generated by the event handlers into world coordinates, so that the points can be directed into a call to HC_Insert_Shell. This function is called internally by OnLButtonDown and OnNoButtonDownAndMove.

Parameters
&lastA pointer to an HPoint object.

◆ CreateSquare()

virtual void HOpConstructCuboid::CreateSquare ( HPoint const &  first,
HPoint const &  last 
)
virtual

CreateSquare creates a square that is orthogonal to camera target plane. This function is called internally by OnLButtonDownAndMove and OnLButtonUp.

Parameters
&firstAn HPoint object.
&lastAn HPoint object.

◆ GetName()

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

Reimplemented from HBaseOperator.

Reimplemented in HOpCreateCuboid.

◆ OnLButtonDown()

virtual int HOpConstructCuboid::OnLButtonDown ( HEventInfo hevent)
virtual

OnLButtonDown records the first mouse position and initiates the cuboid-drawing mechanism. It tests for the case that the mechanism has already been started such as OnLButtonDown has been called once already.
In this case, OnLButtonDown finalizes the cuboid's depth, removes the geometry from the scene, updates the display 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 HOpCreateCuboid.

◆ OnLButtonDownAndMove()

virtual int HOpConstructCuboid::OnLButtonDownAndMove ( HEventInfo hevent)
virtual

OnLButtonDownAndMove accepts the initiating point from OnLButtonDown and rubberbands a square for the desired size of the cuboid'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 HOpConstructCuboid::OnLButtonUp ( HEventInfo hevent)
virtual

OnLButtonUp finalizes the size of the cuboid's square base.

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 HOpConstructCuboid::OnNoButtonDownAndMove ( HEventInfo hevent)
virtual

OnNoButtonDownAndMove uses a rubberband to set the desired depth of the cuboid.

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_FaceList

int HOpConstructCuboid::m_FaceList[30]
protected

The facelist for the shell.

◆ m_ptEdge

HPoint HOpConstructCuboid::m_ptEdge
protected

The edge of the cube.

◆ m_ptPointList

HPoint HOpConstructCuboid::m_ptPointList[8]
protected

The array of points for cuboid shell.


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