HOpCameraManipulate Class Reference

The HOpCameraManipulate class combines the Orbit, Pan and Zoom Operators. More...

#include <HOpCameraManipulate.h>

Public Member Functions

virtual HBaseOperatorClone ()
 
bool GetLButtonDown ()
 
virtual const char * GetName ()
 
HOpCameraOrbitGetOrbitOperator ()
 
void HandleDblClk (float requested_time, float actual_time)
 
 HOpCameraManipulate (HBaseView *view, int DoRepeat=0, int DoCapture=1, HBaseOperator *orbit=0, HBaseOperator *pan=0, HBaseOperator *zoom=0, HBaseOperator *relative=0, bool AllowHandleActivation=false)
 
virtual int OnLButtonDown (HEventInfo &hevent)
 
virtual int OnLButtonDownAndMove (HEventInfo &hevent)
 
virtual int OnLButtonUp (HEventInfo &hevent)
 
virtual int OnMButtonDown (HEventInfo &hevent)
 
virtual int OnMButtonDownAndMove (HEventInfo &hevent)
 
virtual int OnMButtonUp (HEventInfo &hevent)
 
virtual int OnRButtonDown (HEventInfo &hevent)
 
virtual int OnRButtonDownAndMove (HEventInfo &hevent)
 
virtual int OnRButtonUp (HEventInfo &hevent)
 
virtual bool OperatorStarted ()
 Operator has been started if true, and has not been started if false.
 
- 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 OnMouseMove (HEventInfo &hevent)
 
virtual int OnMouseWheel (HEventInfo &hevent)
 
virtual int OnNoButtonDownAndMove (HEventInfo &hevent)
 
virtual int OnRButtonDblClk (HEventInfo &hevent)
 
virtual int OnTimer (HEventInfo &hevent)
 
virtual int OnTouchesDown (HEventInfo &hevent)
 
virtual int OnTouchesMove (HEventInfo &hevent)
 
virtual int OnTouchesUp (HEventInfo &hevent)
 
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

HTClientm_pDblClkTimer
 
HBaseOperatorm_pOrbitOperator
 
HBaseOperatorm_pPanOperator
 
HBaseOperatorm_pRelativeOrbitOperator
 
HPoint m_ptRealOld
 
HBaseOperatorm_pZoomOperator
 
- 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 HOpCameraManipulate class combines the Orbit, Pan and Zoom Operators.

HOpCameraManipulate implements three mouse event methods defined on the base class and maps the event information to orbit, pan or zoom the camera. This operator has three modes of operation.

  1. With no key press, the camera orbits.
  2. With the Shift key down, the camera pans.
  3. With the Ctrl key down, the camer zooms.

More Detailed Description: see event methods.

Constructor & Destructor Documentation

◆ HOpCameraManipulate()

HOpCameraManipulate::HOpCameraManipulate ( HBaseView view,
int  DoRepeat = 0,
int  DoCapture = 1,
HBaseOperator orbit = 0,
HBaseOperator pan = 0,
HBaseOperator zoom = 0,
HBaseOperator relative = 0,
bool  AllowHandleActivation = false 
)

Constructs an HOpCameraManipulate 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.
orbitA pointer to an HOpCameraOrbit object. If you pass null, HOpCameraManipulate will make construct a new one.
panA pointer to an HOpCameraPan object. If you pass null, HOpCameraManipulate will make construct a new one.
zoomA pointer to an HOpCameraZoom object. If you pass null, HOpCameraManipulate will make construct a new one.
relativeA pointer to an HOpCameraRelativeOrbit object. If you pass null, HOpCameraManipulate will make construct a new one.
AllowHandleActivationPass true to allow manipulation using handles.

Member Function Documentation

◆ Clone()

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

Reimplemented from HBaseOperator.

◆ GetLButtonDown()

bool HOpCameraManipulate::GetLButtonDown ( )
inline
Returns
The state of the left button down flag.

◆ GetName()

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

Reimplemented from HBaseOperator.

◆ GetOrbitOperator()

HOpCameraOrbit* HOpCameraManipulate::GetOrbitOperator ( )
inline
Returns
A pointer to the orbit operator.

◆ HandleDblClk()

void HOpCameraManipulate::HandleDblClk ( float  requested_time,
float  actual_time 
)

This method is the double click function called from timer callback.

Parameters
requested_timeThe time that the event had requested.
actual_timeThe actual time the event callback happened.

◆ OnLButtonDown()

virtual int HOpCameraManipulate::OnLButtonDown ( HEventInfo hevent)
virtual

This method handles the left mouse button down event.

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 HOpCameraManipulate::OnLButtonDownAndMove ( HEventInfo hevent)
virtual

This method handles the left mouse button down and move event. It determines if the shift or control key is down and then passes control over to the correct camera operator which can be pan, orbit or zoom.

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

This method handles the left mouse button up event.

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

Reimplemented from HBaseOperator.

◆ OnMButtonDown()

virtual int HOpCameraManipulate::OnMButtonDown ( HEventInfo hevent)
virtual

This methods passes the event to the relative orbit camera operator's left button mouse down event handler.

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

Reimplemented from HBaseOperator.

◆ OnMButtonDownAndMove()

virtual int HOpCameraManipulate::OnMButtonDownAndMove ( HEventInfo hevent)
virtual

This methods passes the event to the relative orbit camera operator's left button mouse down and move event handler.

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

Reimplemented from HBaseOperator.

◆ OnMButtonUp()

virtual int HOpCameraManipulate::OnMButtonUp ( HEventInfo hevent)
virtual

This methods passes the event to the relative orbit camera operator's left button mouse up event handler.

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

Reimplemented from HBaseOperator.

◆ OnRButtonDown()

virtual int HOpCameraManipulate::OnRButtonDown ( HEventInfo hevent)
virtual

This methods passes the event to the pan camera operator's left button mouse down event handler.

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

Reimplemented from HBaseOperator.

◆ OnRButtonDownAndMove()

virtual int HOpCameraManipulate::OnRButtonDownAndMove ( HEventInfo hevent)
virtual

This methods passes the event to the pan camera operator's left button mouse down and move event handler.

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

Reimplemented from HBaseOperator.

◆ OnRButtonUp()

virtual int HOpCameraManipulate::OnRButtonUp ( HEventInfo hevent)
virtual

This event handler passes the event to the pan camera operator's OnLButtonUp handler.

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_pDblClkTimer

HTClient* HOpCameraManipulate::m_pDblClkTimer
protected

A pointer to the timer client for detection of double click events.

◆ m_pOrbitOperator

HBaseOperator* HOpCameraManipulate::m_pOrbitOperator
protected

A pointer to the orbit operator.

◆ m_pPanOperator

HBaseOperator* HOpCameraManipulate::m_pPanOperator
protected

A pointer to the pan operator.

◆ m_pRelativeOrbitOperator

HBaseOperator* HOpCameraManipulate::m_pRelativeOrbitOperator
protected

A pointer to the relative orbit operator.

◆ m_ptRealOld

HPoint HOpCameraManipulate::m_ptRealOld
protected

For internal use only.

◆ m_pZoomOperator

HBaseOperator* HOpCameraManipulate::m_pZoomOperator
protected

A pointer to the zoom operator.


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