The HOpMoveHandle class selects/moves "handles" and their associated geometry. More...

#include <HOpMoveHandle.h>

Public Member Functions

virtual HBaseOperatorClone ()
 
HC_KEY FindHandle (HEventInfo &hevent)
 This method finds a handle based on the mouse position.
 
HC_KEY FindObject (HEventInfo &hevent, HC_KEY key, bool exclude=false)
 
virtual const char * GetName ()
 
 HOpMoveHandle (HBaseView *view, bool allowSelect=true, 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)
 
void Reset ()
 Reset the operator so that no object or handle is currently selected for manipulation.
 
void SetupObject (HC_KEY key)
 
- 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

bool m_bAllowSelect
 If the value is true, this class allows selection of different handle objects. This is disabled for cutting planes.
 
HC_KEY m_pHandleKey
 The key of the active handle.
 
HC_KEY m_pObjectKey
 The key of the handle object.
 
- 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 HOpMoveHandle class selects/moves "handles" and their associated geometry.

HOpMoveHandle implements three mouse event methods defined on the base class and maps the event information to operator routines. This operation consists of the following steps:

  1. Left Button Down: The new handle object is selected.
  2. Left Button Down and Drag: Dragging the handle and associated geometry.
  3. Left Button Up: The operation ends.

More Detailed Description: see event methods.

Constructor & Destructor Documentation

◆ HOpMoveHandle()

HOpMoveHandle::HOpMoveHandle ( HBaseView view,
bool  allowSelect = true,
int  DoRepeat = 0,
int  DoCapture = 1 
)

Constructs an HOpMoveHandle object.

Parameters
viewA pointer to an HBaseView object.
allowSelectPass true to allow selection of different handle objects.
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* HOpMoveHandle::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 HOpMoveHandle object.

Reimplemented from HBaseOperator.

◆ FindObject()

HC_KEY HOpMoveHandle::FindObject ( HEventInfo hevent,
HC_KEY  key,
bool  exclude = false 
)

This method finds geometry based on mouse position.

Parameters
heventAn HEventInfo object containing information about the current event.
keyKey of currently selected object.
excludePass true to exclude currently selected object from search.
Returns
The key of the geometry at mouse position that serves as new handle target.

◆ GetName()

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

Reimplemented from HBaseOperator.

◆ OnLButtonDown()

virtual int HOpMoveHandle::OnLButtonDown ( HEventInfo hevent)
virtual

OnLButtonDown selects an existing handle if the mouse is over a handle or designates a new object for handle based movement.

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

Reimplemented from HBaseOperator.

◆ OnLButtonDownAndMove()

virtual int HOpMoveHandle::OnLButtonDownAndMove ( HEventInfo hevent)
virtual

OnLButtonDownAndMove moves/rotates/scales the handle and it's associated geometry based on various constraints (ray, plane, etc).

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

OnLButtonUp finalizes mouse movement and deselectes the active handle.

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

OnNoButtonDownAndMove activates handle in mouse cursor range.

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

Reimplemented from HBaseOperator.

◆ SetupObject()

void HOpMoveHandle::SetupObject ( HC_KEY  key)

Creates handles for the choosen geometry.

Parameters
keyThe key of the geometry to attach handles to.

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