Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HOpCameraZoom Class Reference

The HOpCameraZoom class zooms the camera toward a target. More...

#include <HOpCameraZoom.h>

Inheritance diagram for HOpCameraZoom:

HBaseOperator

List of all members.

Public Member Functions

virtual HBaseOperatorClone ()
bool GetLightFollowsCamera ()
virtual const char * GetName ()
 HOpCameraZoom (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 HOpCameraZoom class zooms the camera toward a target.

HOpCameraZoom implements three of the mouse button handlers defined on the base class and maps the event information to HOOPS camera routines. This provides the basic functionality for interactively zooming in or out from a model in realtime. The operation consists of the following steps:

  1. Left Button Down: The zoom is initiated.
  2. Left Button Down and Drag: The camera zooms to the default target.
  3. Left Button Up: The operation ends.
More Detailed Description: see event methods.

Constructor & Destructor Documentation

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

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

Reimplemented from HBaseOperator.

bool HOpCameraZoom::GetLightFollowsCamera (  )  [inline]

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

virtual const char* HOpCameraZoom::GetName (  )  [virtual]

Returns:
A pointer to a character string denoting the name of the operator which is 'HOpCameraZoom'.

Reimplemented from HBaseOperator.

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

OnLButtonDown draws a bounding box around the scene, records the first mouse position, and calculates the current camera target based on the first point.

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

Reimplemented from HBaseOperator.

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

OnLButtonDownAndMove tests for left button down, records points as the mouse is moved, recalculates the current target for each point, and zooms the camera towards that current target. The method makes calculations to avoid unneccessary zoom when the camera is close to the target. If this operator is set so that the lights follow the camera, lighting targets will also be recalculated and lights reoriented.

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

Reimplemented from HBaseOperator.

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

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


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