Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HOpCameraPan Class Reference

The HOpCameraPan class pans the camera about a current view. More...

#include <HOpCameraPan.h>

List of all members.

Public Member Functions

virtual HBaseOperatorClone ()
bool GetLightFollowsCamera ()
virtual const char * GetName ()
 HOpCameraPan (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)

Detailed Description

The HOpCameraPan class pans the camera about a current view.

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

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

More Detailed Description: see event methods


Constructor & Destructor Documentation

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

Constructs an HOpCameraPan 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

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

Reimplemented from HBaseOperator.

bool HOpCameraPan::GetLightFollowsCamera ( ) [inline]
Returns:
True if the light follows the camera or false if it doesn't.
virtual const char* HOpCameraPan::GetName ( ) [virtual]
Returns:
A pointer to a character string denoting the name of the operator which is 'HOpCameraPan'.

Reimplemented from HBaseOperator.

virtual int HOpCameraPan::OnLButtonDown ( HEventInfo hevent) [virtual]

OnLButtonDown records the initial mouse position.

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

Reimplemented from HBaseOperator.

virtual int HOpCameraPan::OnLButtonDownAndMove ( HEventInfo hevent) [virtual]

OnLButtonDownAndMove records points as the mouse is moved and calculates the values used for panning the camera by modifying the camera's target and position. It also updates the position of the default light, depending on whether 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.

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

OnLButtonUp updates the scene with current 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.

void HOpCameraPan::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.

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