#include <hps.h>
Public Member Functions | |
CameraControl (SegmentKey &in_seg) | |
CameraControl (CameraControl const &in_that) | |
CameraControl (CameraControl &&in_that) | |
CameraControl & | operator= (CameraControl &&in_that) |
~CameraControl () | |
HPS::Type | ObjectType () const |
CameraControl & | operator= (CameraControl const &in_that) |
CameraControl & | SetUpVector (Vector const &in_up) |
CameraControl & | SetPosition (Point const &in_position) |
CameraControl & | SetTarget (Point const &in_target) |
CameraControl & | SetProjection (Camera::Projection in_type, float in_oblique_x_skew=0.0f, float in_oblique_y_skew=0.0f) |
CameraControl & | SetField (float in_width, float in_height) |
CameraControl & | SetNearLimit (float in_double) |
CameraControl & | UnsetEverything () |
bool | ShowUpVector (Vector &out_up_vector) const |
bool | ShowPosition (Point &out_position) const |
bool | ShowTarget (Point &out_target) const |
bool | ShowProjection (Camera::Projection &out_type) const |
bool | ShowProjection (Camera::Projection &out_type, float &out_oblique_x_skew, float &out_oblique_y_skew) const |
bool | ShowWidth (float &out_width) const |
bool | ShowHeight (float &out_height) const |
bool | ShowField (float &out_width, float &out_height) const |
bool | ShowNearLimit (float &out_width) const |
CameraControl & | Dolly (float in_x_dir, float in_up, float in_forward) |
CameraControl & | Orbit (float in_theta, float in_phi) |
CameraControl & | Pan (float in_theta, float in_phi) |
CameraControl & | Roll (float in_theta) |
CameraControl & | Zoom (float in_zoom) |
![]() | |
Control (Control const &in_that)=default | |
![]() | |
Object (Object const &that) | |
Object & | operator= (Object const &other_object) |
Object (Object &&in_that) | |
Object & | operator= (Object &&in_that) |
HPS::Type | Type () const |
virtual bool | Empty () const |
virtual void | Reset () |
bool | HasType (HPS::Type in_mask) const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Control (Control &&in_that) | |
Control & | operator= (Control &&in_that) |
The HPS::CameraControl class is a smart pointer that is tied to a database object. The CameraControl is used to manipulate the viewpoint, or camera, in a scene. Using this control, the view position, orientation, target, and aspect ratio of a segment's camera can be set. Cameras are considered segment attributes, but unlink other attributes, they inherit as a group down the segment hierarchy. This table lists default values for the various segment attributes accessible from HPS::CameraControl.
|
explicit |
Initializes a control tied to the segment in_seg.
HPS::CameraControl::CameraControl | ( | CameraControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
HPS::CameraControl::CameraControl | ( | CameraControl && | in_that | ) |
The move constructor creates a CameraControl by transferring the underlying impl of the rvalue reference to this CameraControl thereby avoiding a copy and allocation.
in_that | An rvalue reference to a CameraControl to take the impl from. |
HPS::CameraControl::~CameraControl | ( | ) |
Releases a reference to the database object this control is tied to.
CameraControl& HPS::CameraControl::Dolly | ( | float | in_x_dir, |
float | in_up, | ||
float | in_forward | ||
) |
Moves the camera position and target the specified amount but maintains the up vector and field. If a complete camera is not already set up, one will be populated with default values before dollying.
in_x_dir | The number of world-space units to move the camera in the x-direction. |
in_up | The number of world-space units to move the camera up, or if negative, down. |
in_forward | The number of world-space units to move the camera toward the target, or if negative, away from the target. |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::Control.
CameraControl& HPS::CameraControl::operator= | ( | CameraControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this CameraControl thereby avoiding a copy.
in_that | An rvalue reference to a CameraControl to take the impl from. |
CameraControl& HPS::CameraControl::operator= | ( | CameraControl const & | in_that | ) |
Share the underlying smart-pointer of the CameraControl source.
in_that | The CameraControl source of the assignment. |
CameraControl& HPS::CameraControl::Orbit | ( | float | in_theta, |
float | in_phi | ||
) |
Moves the camera around the target in_theta degrees to the right and in_phi degrees up. The target and field are maintained but position and up_vector may change. If a complete camera is not already set up, one will be populated with default values before orbiting.
in_theta | The number of degrees to move the the camera position to the right. |
in_phi | The number of degrees to move the the camera position up. |
CameraControl& HPS::CameraControl::Pan | ( | float | in_theta, |
float | in_phi | ||
) |
Pivots the camera on its location in_theta degrees to the right and in_phi degrees up. The position and field remain unchanged while the target and up vector may change. If a complete camera is not already set up, one will be populated with default values before panning.
in_theta | The number of degrees to move the the camera target to the right. |
in_phi | The number of degrees to move the the camera target up. |
CameraControl& HPS::CameraControl::Roll | ( | float | in_theta | ) |
Spins the camera around its target in_theta degrees counter-clockwise (the scene will appear to move clockwise). The position, field, and target are unchanged while the up-vector may change. If a complete camera is not already set up, one will be populated with default values before rolling.
in_theta | The number of degrees to roll the camera. |
CameraControl& HPS::CameraControl::SetField | ( | float | in_width, |
float | in_height | ||
) |
Sets the camera field.
in_width | The width of the camera field, in object-space units. |
in_height | The height of the camera field, in object-space units. |
CameraControl& HPS::CameraControl::SetNearLimit | ( | float | in_double | ) |
Sets the near_limit to in_double that defines the near limit of the camera. A value approaching 0.0 will place it close to the camera position (at the cost of poor z-buffer precision), whereas a value approaching 1.0 will place it near the camera target (at the cost of clipping away anything closer than the target). A value exactly equal to 0 will let HOOPS Visualize choose a limit based on the precision of the zbuffer as reported by the driver.
in_double | The value to set the near limit to |
CameraControl& HPS::CameraControl::SetPosition | ( | Point const & | in_position | ) |
Sets the location of the camera.
in_position | The location of the camera. |
CameraControl& HPS::CameraControl::SetProjection | ( | Camera::Projection | in_type, |
float | in_oblique_x_skew = 0.0f , |
||
float | in_oblique_y_skew = 0.0f |
||
) |
Sets the camera projection type and the oblique skew, if any.
in_type | The type of camera projection. |
in_oblique_x_skew | The oblique skew in the horizontal direction. |
in_oblique_y_skew | The oblique skew in the vertical direction. |
CameraControl& HPS::CameraControl::SetTarget | ( | Point const & | in_target | ) |
Sets the location that the camera is pointed at.
in_target | The location that the camera is pointed at. |
CameraControl& HPS::CameraControl::SetUpVector | ( | Vector const & | in_up | ) |
Sets a vector that defines the vertical up direction of the camera.
in_up | A vector that defines the vertical up direction of the camera. |
bool HPS::CameraControl::ShowField | ( | float & | out_width, |
float & | out_height | ||
) | const |
Shows the camera field.
out_width | The width of the camera field, in object-space units. |
out_height | The height of the camera field, in object-space units. |
bool HPS::CameraControl::ShowHeight | ( | float & | out_height | ) | const |
Shows the height of the camera field.
out_height | The height of the camera field, in object-space units. |
bool HPS::CameraControl::ShowNearLimit | ( | float & | out_width | ) | const |
Shows the camera near limit.
out_width | The near limit of the camera field. |
bool HPS::CameraControl::ShowPosition | ( | Point & | out_position | ) | const |
Shows the camera position.
out_position | the location of the camera. |
bool HPS::CameraControl::ShowProjection | ( | Camera::Projection & | out_type | ) | const |
Shows the camera projection type.
out_type | The type of camera projection. |
bool HPS::CameraControl::ShowProjection | ( | Camera::Projection & | out_type, |
float & | out_oblique_x_skew, | ||
float & | out_oblique_y_skew | ||
) | const |
Shows the camera projection type and the oblique skew, if any.
out_type | The type of camera projection. |
out_oblique_x_skew | The oblique skew in the horizontal direction. |
out_oblique_y_skew | The oblique skew in the vertical direction. |
bool HPS::CameraControl::ShowTarget | ( | Point & | out_target | ) | const |
Shows the camera target.
out_target | the location that the camera is pointed at. |
bool HPS::CameraControl::ShowUpVector | ( | Vector & | out_up_vector | ) | const |
Shows the camera up-vector.
out_up_vector | A vector that defines the vertical up direction of the camera. |
bool HPS::CameraControl::ShowWidth | ( | float & | out_width | ) | const |
Shows the width of the camera field.
out_width | The width of the camera field, in object-space units. |
CameraControl& HPS::CameraControl::UnsetEverything | ( | ) |
Removes all settings from this object. Unlike other attributes, it is not possible to unset just a single field of a camera.
CameraControl& HPS::CameraControl::Zoom | ( | float | in_zoom | ) |
Adjusts the field of view by dividing the width and height by the input value. Numbers greater than one will have the effect of making things on screen appear larger. Numbers between zero and one will have the opposite effect. Only the field is affected. If a complete camera is not already set up, one will be populated with default values before zooming.
in_zoom | The zoom scale factor. |