# HOpCameraPan

## Functions

| `HOpCameraPan`
| `~HOpCameraPan`
const char * | `GetName`
int | `OnLButtonDown`
int | `OnLButtonDownAndMove`
int | `OnLButtonUp`
void | `SetLightFollowsCamera`
bool | `GetLightFollowsCamera`
HBaseOperator * | `Clone`

## Detailed Description

class HOpCameraPan : public HBaseOperator

  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

  Public Functions

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

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

  virtual ~HOpCameraPan()
  virtual const char *GetName()
    Returns

      A pointer to a character string denoting the name of the operator which is ‘HOpCameraPan’.

  virtual int OnLButtonDown(HEventInfo &hevent)

    OnLButtonDown records the initial mouse position.

    Parameters

      hevent – An HEventInfo object containing information about the current event.

    Returns

      An HOperatorReturn indicating the status of the event.

  virtual int OnLButtonDownAndMove(HEventInfo &hevent)

    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

      hevent – An HEventInfo object containing information about the current event.

    Returns

      An HOperatorReturn indicating the status of the event.

  virtual int OnLButtonUp(HEventInfo &hevent)

    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.

  inline void SetLightFollowsCamera(bool follow)

    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.

  inline bool GetLightFollowsCamera()
    Returns

      True if the light follows the camera or false if it doesn’t.

  virtual HBaseOperator *Clone()

    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.