HOpCreateCuttingPlane Class Reference

The HOpCreateCuttingPlane class provides support for construction a cutting plane and inserting it into the scene. More...

#include <HOpCreateCuttingPlane.h>

Public Member Functions

virtual HBaseOperatorClone ()
 
virtual const char * GetName ()
 
 HOpCreateCuttingPlane (HBaseView *view, int DoRepeat=0, int DoCapture=1)
 
virtual int OnLButtonDown (HEventInfo &hevent)
 
virtual int OnLButtonUp (HEventInfo &hevent)
 
- Public Member Functions inherited from HOpObjectTranslate
 HOpObjectTranslate (HBaseView *view, int DoRepeat=0, int DoCapture=1)
 
virtual int OnLButtonDblClk (HEventInfo &hevent)
 
virtual int OnLButtonDownAndMove (HEventInfo &hevent)
 
virtual void UpdateKeyList (void *data)
 
- 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 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 OnNoButtonDownAndMove (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.
 

Additional Inherited Members

- Public Attributes inherited from HOpObjectTranslate
HPoint m_ptRecent
 
HPoint m_ptRecentVP
 
- Protected Member Functions inherited from HOpObjectTranslate
void Cleanup ()
 
int GetMatrix (HEventInfo &hevent, int key_count, HC_KEY const *full_path_keys, float matrix_out[])
 
void Init ()
 
int UpdateMousePos (HEventInfo &hevent)
 
- Protected Member Functions inherited from HBaseOperator
bool IsSpecialKey (HC_KEY key)
 
- Protected Attributes inherited from HOpObjectTranslate
bool m_bInitialMatrix
 
bool m_bTemporarySelection
 
HKeyList * m_KeyList
 
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
 

Detailed Description

The HOpCreateCuttingPlane class provides support for construction a cutting plane and inserting it into the scene.

HOpCreateCuttingPlane implements two of the mouse button event handlers defined on the base class. In this case, the operator uses the LButtonDown event to begin the cutting plane insertion mechanism, but position info is not used. This provides the basic functionality for viewing cut-away scenes, cross-sections, and slices of models. Upon insertion, the default position of the cutting plane lies parallel to the view plane and intersects the z-value of the scene's centerpoint. The operation consists of the following steps:

  1. Left Button Down: The cutting plane is inserted through center of the scene.
  2. Left Button Up: All geometry is deselected and the operation ends.

More Detailed Description: see event methods.

Constructor & Destructor Documentation

◆ HOpCreateCuttingPlane()

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

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

Reimplemented from HOpObjectTranslate.

◆ GetName()

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

Reimplemented from HOpObjectTranslate.

◆ OnLButtonDown()

virtual int HOpCreateCuttingPlane::OnLButtonDown ( HEventInfo hevent)
virtual

OnLButtonDown begins the cutting plane insertion mechanism and calculates the center of the scene. The center point's z-value is passed internally to initiate the plane's construction. In addition, the plane is placed in the current selection list and will be highlighted until the left mouse button is released.

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

Reimplemented from HOpObjectTranslate.

◆ OnLButtonUp()

virtual int HOpCreateCuttingPlane::OnLButtonUp ( HEventInfo hevent)
virtual

OnLButtonUp ends the operation and removes the cutting plane from the current selection list. The function also deselects every item in the scene upon completion.

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

Reimplemented from HOpObjectTranslate.


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