# HOpCameraOrbit

## Fields

float | `m_Angle2`
float | `m_Angle1`
float | `m_Angle3`

## Functions

| `HOpCameraOrbit`
| `~HOpCameraOrbit`
char const * | `GetName`
int | `OnLButtonDown`
int | `OnLButtonDownAndMove`
int | `OnLButtonUp`
void | `SetLightFollowsCamera`
bool | `GetLightFollowsCamera`
void | `SetSceneBoundingBoxVis`
bool | `GetSceneBoundingBoxVis`
HBaseOperator * | `Clone`
bool | `GetSingleClick`

## Detailed Description

class `HOpCameraOrbit` : public HBaseOperator

  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.

  Subclassed by HOpCameraRelativeOrbit

  Public Functions

  `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.

  virtual `~HOpCameraOrbit`()
  virtual char const *`GetName`()

    Returns: | A pointer to a character string denoting the name of the operator which is ‘HOpCameraOrbit’.

  virtual int `OnLButtonDown`(HEventInfo &hevent)

    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.

  virtual int `OnLButtonDownAndMove`(HEventInfo &hevent)

    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.

  virtual int `OnLButtonUp`(HEventInfo &hevent)

    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.

  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.

  inline void `SetSceneBoundingBoxVis`(bool vis)

    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.

  inline bool `GetSceneBoundingBoxVis`()

    Returns: | True if the bounding box is visible or false if it isn’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 HOpCameraOrbit object.

  inline bool `GetSingleClick`()

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

  Public Members

  float `m_Angle2`

    For internal use only!

  float `m_Angle1`
  float `m_Angle3`

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your multilingual generative AI assistant for documentation. Ask me anything about HOOPS Visualize 3DF in your own language, or choose a sample question below to start a conversation:

What is HOOPS Visualize 3DF?
What are the latest release notes for HOOPS Visualize 3DF?
How do I start evaluating HOOPS Visualize 3DF?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...