The HOpCameraOrbit class provides interactive orbiting of the camera around a scene. More...

#include <HOpCameraOrbit.h>

Public Member Functions

virtual HBaseOperatorClone ()
 
bool GetLightFollowsCamera ()
 
virtual const char * GetName ()
 
bool GetSceneBoundingBoxVis ()
 
bool GetSingleClick ()
 
 HOpCameraOrbit (HBaseView *view, int DoRepeat=0, int DoCapture=1)
 
virtual int OnLButtonDown (HEventInfo &hevent)
 
virtual int OnLButtonDownAndMove (HEventInfo &hevent)
 
virtual int OnLButtonUp (HEventInfo &hevent)
 
void SetLightFollowsCamera (bool follow)
 
void SetSceneBoundingBoxVis (bool vis)
 
- 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 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.
 

Public Attributes

float m_Angle1
 
float m_Angle2
 
float m_Angle3
 

Protected Attributes

bool m_bLightFollowsCamera
 
bool m_bSceneBoundingBoxVis
 
bool m_bSingleClick
 
HPoint m_ptRealOld
 
- 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 HOpCameraOrbit class provides interactive orbiting of the camera around a scene.

HOpCameraOrbit implements three mouse event methods defined on the base class and maps the event information to the HOOPS routine #HC_Orbit_Camera. This operation consists of the following steps:

  1. Left Button Down: The orbit is initiated.
  2. Left Button Down and Drag: The camera orbits.
  3. Left Button Up: The operation ends.

As the mouse moves through the scene, the 2D position of the pointer is mapped into 3D space like a trackball around the model. More Detailed Description: see event methods.

Constructor & Destructor Documentation

◆ HOpCameraOrbit()

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

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

Reimplemented from HBaseOperator.

Reimplemented in HOpCameraRelativeOrbit.

◆ GetLightFollowsCamera()

bool HOpCameraOrbit::GetLightFollowsCamera ( )
inline
Returns
True if the light follows the camera or false if it doesn't.

◆ GetName()

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

Reimplemented from HBaseOperator.

Reimplemented in HOpCameraRelativeOrbit.

◆ GetSceneBoundingBoxVis()

bool HOpCameraOrbit::GetSceneBoundingBoxVis ( )
inline
Returns
True if the bounding box is visible or false if it isn't.

◆ GetSingleClick()

bool HOpCameraOrbit::GetSingleClick ( )
inline
Returns
True if the mouse has moved between the left mouse button down and left mouse button up events.

◆ OnLButtonDown()

virtual int HOpCameraOrbit::OnLButtonDown ( HEventInfo hevent)
virtual

OnLButtonDown draws a bounding box around the scene, records the mouse position, and maps the mouse position to spherical coordinates.

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

Reimplemented from HBaseOperator.

Reimplemented in HOpCameraRelativeOrbit.

◆ OnLButtonDownAndMove()

virtual int HOpCameraOrbit::OnLButtonDownAndMove ( HEventInfo hevent)
virtual

OnLButtonDownAndMove records points as the mouse is moved, maps the points to spherical coordinates, and calculates the appropriate values for #HC_Orbit_Camera and #HC_Roll_Camera. It also updates the position of the default light depending on if you have set the light to follow the camera.

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

Reimplemented from HBaseOperator.

Reimplemented in HOpCameraRelativeOrbit.

◆ OnLButtonUp()

virtual int HOpCameraOrbit::OnLButtonUp ( HEventInfo hevent)
virtual

OnLButtonUp updates the scene with the most recent camera and lighting information and cleans up.

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

Reimplemented from HBaseOperator.

◆ SetLightFollowsCamera()

void HOpCameraOrbit::SetLightFollowsCamera ( bool  follow)
inline

SetLightFollowsCamera sets the lights to follow the camera or to stay in one place during orbit. This has the effect of either lighting the scene during orbit or allowing the camera to move through shadow. The default is off.

Parameters
followPass true to have the light follow the camera.

◆ SetSceneBoundingBoxVis()

void HOpCameraOrbit::SetSceneBoundingBoxVis ( bool  vis)
inline

SetSceneBoundingBoxVis controls whether a bounding box denoting the scene extents should be drawn during a camera orbit.

Parameters
visPass true if you want HOOPS to draw the bounding box or false if you don't.

Member Data Documentation

◆ m_Angle2

float HOpCameraOrbit::m_Angle2

For internal use only!

◆ m_bLightFollowsCamera

bool HOpCameraOrbit::m_bLightFollowsCamera
protected

This member indicates whether the light should follow the camera.

◆ m_bSceneBoundingBoxVis

bool HOpCameraOrbit::m_bSceneBoundingBoxVis
protected

This member indicates whether a bounding box denoting the scene extents should be drawn during a camera orbit.

◆ m_bSingleClick

bool HOpCameraOrbit::m_bSingleClick
protected

This member indicates whether the mouse has moved in between lbuttondown/lbuttonup.

◆ m_ptRealOld

HPoint HOpCameraOrbit::m_ptRealOld
protected

For internal use only.


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