#include <hps.h>

Inheritance diagram for HPS::CameraControl:
HPS::Control HPS::Object

Public Member Functions

 CameraControl (SegmentKey &in_seg)
 
 CameraControl (CameraControl const &in_that)
 
 CameraControl (CameraControl &&in_that)
 
CameraControlDolly (float in_x_dir, float in_up, float in_forward)
 
HPS::Type ObjectType () const
 
CameraControloperator= (CameraControl &&in_that)
 
CameraControloperator= (CameraControl const &in_that)
 
CameraControlOrbit (float in_theta, float in_phi)
 
CameraControlPan (float in_theta, float in_phi)
 
CameraControlRoll (float in_theta)
 
CameraControlSetField (float in_width, float in_height)
 
CameraControlSetNearLimit (float in_double)
 
CameraControlSetPosition (Point const &in_position)
 
CameraControlSetProjection (Camera::Projection in_type, float in_oblique_x_skew=0.0f, float in_oblique_y_skew=0.0f)
 
CameraControlSetTarget (Point const &in_target)
 
CameraControlSetUpVector (Vector const &in_up)
 
bool ShowField (float &out_width, float &out_height) const
 
bool ShowHeight (float &out_height) const
 
bool ShowNearLimit (float &out_near_limit) const
 
bool ShowPosition (Point &out_position) 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 ShowTarget (Point &out_target) const
 
bool ShowUpVector (Vector &out_up_vector) const
 
bool ShowWidth (float &out_width) const
 
virtual HPS::Type Type () const
 
CameraControlUnsetEverything ()
 
CameraControlZoom (float in_zoom)
 
 ~CameraControl ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::CameraControl
 
- Static Public Attributes inherited from HPS::Control
static const HPS::Type staticType = HPS::Type::Control
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Control
 Control (Control &&in_that)
 
Controloperator= (Control &&in_that)
 

Detailed Description

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. A camera with all of its properties is considered a single segment attribute, therefore, cameras inherit down the segment hierarchy along with all their properties as a group. Because all properties of a camera inherit together, it is not possible to modify an individual property of an inherited camera. Attempting to do so will create a new camera initially populated with default values. This table lists default values for the various segment attributes accessible from HPS::CameraControl.

Constructor & Destructor Documentation

◆ CameraControl() [1/3]

HPS::CameraControl::CameraControl ( SegmentKey in_seg)
explicit

Initializes a control tied to the segment in_seg.

◆ CameraControl() [2/3]

HPS::CameraControl::CameraControl ( CameraControl const &  in_that)

Initializes a control tied to the same object as in_that.

◆ CameraControl() [3/3]

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.

Parameters
in_thatAn rvalue reference to a CameraControl to take the impl from.

◆ ~CameraControl()

HPS::CameraControl::~CameraControl ( )

Releases a reference to the database object this control is tied to.

Member Function Documentation

◆ Dolly()

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.

Parameters
in_x_dirThe number of world-space units to move the camera in the x-direction.
in_upThe number of world-space units to move the camera up, or if negative, down.
in_forwardThe number of world-space units to move the camera toward the target, or if negative, away from the target.
Returns
A reference to this object.

◆ ObjectType()

HPS::Type HPS::CameraControl::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS::Control.

◆ operator=() [1/2]

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.

Parameters
in_thatAn rvalue reference to a CameraControl to take the impl from.
Returns
A reference to this CameraControl.

◆ operator=() [2/2]

CameraControl& HPS::CameraControl::operator= ( CameraControl const &  in_that)

Share the underlying smart-pointer of the CameraControl source.

Parameters
in_thatThe CameraControl source of the assignment.
Returns
A reference to this CameraControl.

◆ Orbit()

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.

Parameters
in_thetaThe number of degrees to move the the camera position to the right.
in_phiThe number of degrees to move the the camera position up.
Returns
A reference to this object.

◆ Pan()

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.

Parameters
in_thetaThe number of degrees to move the the camera target to the right.
in_phiThe number of degrees to move the the camera target up.
Returns
A reference to this object.

◆ Roll()

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.

Parameters
in_thetaThe number of degrees to roll the camera.
Returns
A reference to this object.

◆ SetField()

CameraControl& HPS::CameraControl::SetField ( float  in_width,
float  in_height 
)

Sets the camera field.

Parameters
in_widthThe width of the camera field, in object-space units.
in_heightThe height of the camera field, in object-space units.
Returns
A reference to this object.
See also
camera field

◆ SetNearLimit()

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.

Parameters
in_doubleThe value to set the near limit to
Returns
A reference to this object.
See also
camera near limit

◆ SetPosition()

CameraControl& HPS::CameraControl::SetPosition ( Point const &  in_position)

Sets the location of the camera.

Parameters
in_positionThe location of the camera.
Returns
A reference to this object.
See also
camera position

◆ SetProjection()

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.

Parameters
in_typeThe type of camera projection.
in_oblique_x_skewThe oblique skew in the horizontal direction.
in_oblique_y_skewThe oblique skew in the vertical direction.
Returns
A reference to this object.
See also
camera target

◆ SetTarget()

CameraControl& HPS::CameraControl::SetTarget ( Point const &  in_target)

Sets the location that the camera is pointed at.

Parameters
in_targetThe location that the camera is pointed at.
Returns
A reference to this object.
See also
camera position

◆ SetUpVector()

CameraControl& HPS::CameraControl::SetUpVector ( Vector const &  in_up)

Sets a vector that defines the vertical up direction of the camera.

Parameters
in_upA vector that defines the vertical up direction of the camera.
Returns
A reference to this object.
See also
camera up vector

◆ ShowField()

bool HPS::CameraControl::ShowField ( float &  out_width,
float &  out_height 
) const

Shows the camera field.

Parameters
out_widthThe width of the camera field, in object-space units.
out_heightThe height of the camera field, in object-space units.
Returns
true if the setting is valid, false otherwise.

◆ ShowHeight()

bool HPS::CameraControl::ShowHeight ( float &  out_height) const

Shows the height of the camera field.

Parameters
out_heightThe height of the camera field, in object-space units.
Returns
true if the setting is valid, false otherwise.

◆ ShowNearLimit()

bool HPS::CameraControl::ShowNearLimit ( float &  out_near_limit) const

Shows the camera near limit.

Parameters
out_widthThe near limit of the camera field.
Returns
true if the setting is valid, false otherwise.

◆ ShowPosition()

bool HPS::CameraControl::ShowPosition ( Point out_position) const

Shows the camera position.

Parameters
out_positionthe location of the camera.
Returns
true if the setting is valid, false otherwise.

◆ ShowProjection() [1/2]

bool HPS::CameraControl::ShowProjection ( Camera::Projection out_type) const

Shows the camera projection type.

Parameters
out_typeThe type of camera projection.
Returns
true if the setting is valid, false otherwise.

◆ ShowProjection() [2/2]

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.

Parameters
out_typeThe type of camera projection.
out_oblique_x_skewThe oblique skew in the horizontal direction.
out_oblique_y_skewThe oblique skew in the vertical direction.
Returns
true if the setting is valid, false otherwise.

◆ ShowTarget()

bool HPS::CameraControl::ShowTarget ( Point out_target) const

Shows the camera target.

Parameters
out_targetthe location that the camera is pointed at.
Returns
true if the setting is valid, false otherwise.

◆ ShowUpVector()

bool HPS::CameraControl::ShowUpVector ( Vector out_up_vector) const

Shows the camera up-vector.

Parameters
out_up_vectorA vector that defines the vertical up direction of the camera.
Returns
true if the setting is valid, false otherwise.

◆ ShowWidth()

bool HPS::CameraControl::ShowWidth ( float &  out_width) const

Shows the width of the camera field.

Parameters
out_widthThe width of the camera field, in object-space units.
Returns
true if the setting is valid, false otherwise.

◆ Type()

virtual HPS::Type HPS::CameraControl::Type ( ) const
inlinevirtual

This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS::Control.

◆ UnsetEverything()

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. If the control is attached to a WindowKey this function restores the default settings of this control as specified by CameraKit::GetDefault().

Returns
A reference to this object.

◆ Zoom()

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.

Parameters
in_zoomThe zoom scale factor.
Returns
A reference to this object.

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