Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HOpCameraOrbit Class Reference

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

#include <HOpCameraOrbit.h>

Inheritance diagram for HOpCameraOrbit:

HBaseOperator HOpCameraRelativeOrbit

List of all members.

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 Attributes

float m_Angle1
float m_Angle2
float m_Angle3

Protected Attributes

bool m_bLightFollowsCamera
bool m_bSceneBoundingBoxVis
bool m_bSingleClick
HPoint m_ptRealOld


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 ( HBaseView view,
int  DoRepeat = 0,
int  DoCapture = 1 
)

Constructs an HOpCameraOrbit object.

Parameters:
view A pointer to an HBaseView object.
DoRepeat An integer denoting whether this is a repeatable operator. This parameter has been deprecated.
DoCapture An 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

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.

bool HOpCameraOrbit::GetLightFollowsCamera (  )  [inline]

Returns:
True if the light follows the camera or false if it doesn't.

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.

bool HOpCameraOrbit::GetSceneBoundingBoxVis (  )  [inline]

Returns:
True if the bounding box is visible or false if it isn't.

bool HOpCameraOrbit::GetSingleClick (  )  [inline]

Returns:
True if the mouse has moved between the left mouse button down and left mouse button up events.

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:
hevent An HEventInfo object containing information about the current event.
Returns:
An HOperatorReturn indicating the status of the event.

Reimplemented from HBaseOperator.

Reimplemented in HOpCameraRelativeOrbit.

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:
hevent An HEventInfo object containing information about the current event.
Returns:
An HOperatorReturn indicating the status of the event.

Reimplemented from HBaseOperator.

Reimplemented in HOpCameraRelativeOrbit.

virtual int HOpCameraOrbit::OnLButtonUp ( HEventInfo hevent  )  [virtual]

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

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

Reimplemented from HBaseOperator.

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:
follow Pass true to have the light follow the camera.

void HOpCameraOrbit::SetSceneBoundingBoxVis ( bool  vis  )  [inline]

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

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


Member Data Documentation

For internal use only!

This member indicates whether the light should follow the camera.

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

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

For internal use only.


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