#include <hps.h>

Inheritance diagram for HPS::CameraKit:
HPS::Kit HPS::Object

Public Member Functions

 CameraKit ()
 
 CameraKit (const CameraKit &in_kit)
 
 CameraKit (CameraKit &&in_that)
 
CameraKitDolly (float in_x_dir, float in_up, float in_forward)
 
bool Empty () const
 
bool Equals (CameraKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (CameraKit const &in_kit) const
 
CameraKitoperator= (CameraKit &&in_that)
 
CameraKitoperator= (CameraKit const &in_kit)
 
bool operator== (CameraKit const &in_kit) const
 
CameraKitOrbit (float in_theta, float in_phi)
 
CameraKitPan (float in_theta, float in_phi)
 
CameraKitRoll (float in_theta)
 
void Set (CameraKit const &in_kit)
 
CameraKitSetField (float in_width, float in_height)
 
CameraKitSetNearLimit (float const in_limit)
 
CameraKitSetPosition (Point const &in_position)
 
CameraKitSetProjection (Camera::Projection in_type, float in_oblique_y_skew=0.0f, float in_oblique_x_skew=0.0f)
 
CameraKitSetTarget (Point const &in_target)
 
CameraKitSetUpVector (Vector const &in_up)
 
void Show (CameraKit &out_kit) const
 
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_y_skew, float &out_oblique_x_skew) const
 
bool ShowTarget (Point &out_target) const
 
bool ShowUpVector (Vector &out_up_vector) const
 
bool ShowWidth (float &out_width) const
 
CameraKitUnsetEverything ()
 
CameraKitUnsetField ()
 
CameraKitUnsetNearLimit ()
 
CameraKitUnsetPosition ()
 
CameraKitUnsetProjection ()
 
CameraKitUnsetTarget ()
 
CameraKitUnsetUpVector ()
 
CameraKitZoom (float in_zoom)
 
virtual ~CameraKit ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
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 Member Functions

static CameraKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::CameraKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

The HPS::CameraKit class is a user space object, useful for carrying a group of attribute settings. Calling HPS::CameraKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ CameraKit() [1/3]

HPS::CameraKit::CameraKit ( )

Initializes an empty kit.

◆ CameraKit() [2/3]

HPS::CameraKit::CameraKit ( const CameraKit in_kit)

The copy constructor creates a new CameraKit object that contains the same settings as the source object.

Parameters
in_kitThe source object to copy.

◆ CameraKit() [3/3]

HPS::CameraKit::CameraKit ( CameraKit &&  in_that)

The move constructor creates a CameraKit by transferring the underlying impl of the rvalue reference to this CameraKit thereby avoiding a copy and allocation.

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

◆ ~CameraKit()

virtual HPS::CameraKit::~CameraKit ( )
virtual

Destroy this kit.

Member Function Documentation

◆ Dolly()

CameraKit& HPS::CameraKit::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.

◆ Empty()

bool HPS::CameraKit::Empty ( ) const
virtual

Indicates whether this object has any values set on it.

Returns
true if no values are set on this object, false otherwise.

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::CameraKit::Equals ( CameraKit const &  in_kit) const

Check if the source CameraKit is equivalent to this object.

Parameters
in_kitThe source CameraKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static CameraKit HPS::CameraKit::GetDefault ( )
static

Creates a CameraKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Returns
A CameraKit with the default settings.

◆ ObjectType()

HPS::Type HPS::CameraKit::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::Kit.

◆ operator!=()

bool HPS::CameraKit::operator!= ( CameraKit const &  in_kit) const

Check if the source CameraKit is not equivalent to this object.

Parameters
in_kitThe source CameraKit to compare to this object.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

CameraKit& HPS::CameraKit::operator= ( CameraKit &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this CameraKit thereby avoiding a copy.

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

◆ operator=() [2/2]

CameraKit& HPS::CameraKit::operator= ( CameraKit const &  in_kit)

Copies the source CameraKit into this object.

Parameters
in_kitThe source CameraKit to copy.
Returns
A reference to this object.

◆ operator==()

bool HPS::CameraKit::operator== ( CameraKit const &  in_kit) const

Check if the source CameraKit is equivalent to this object.

Parameters
in_kitThe source CameraKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ Orbit()

CameraKit& HPS::CameraKit::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()

CameraKit& HPS::CameraKit::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()

CameraKit& HPS::CameraKit::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.

◆ Set()

void HPS::CameraKit::Set ( CameraKit const &  in_kit)

Copies all settings from the source CameraKit into this object.

Parameters
in_kitThe source CameraKit to copy.

◆ SetField()

CameraKit& HPS::CameraKit::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
Default value

◆ SetNearLimit()

CameraKit& HPS::CameraKit::SetNearLimit ( float const  in_limit)

Sets the near_limit to in_limit 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 choose a wlimit based on the precision of the zbuffer as reported by the driver.

Parameters
in_limitThe value to set the near limit to
Returns
A reference to this object.

◆ SetPosition()

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

Sets the location of the camera.

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

◆ SetProjection()

CameraKit& HPS::CameraKit::SetProjection ( Camera::Projection  in_type,
float  in_oblique_y_skew = 0.0f,
float  in_oblique_x_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
Default value

◆ SetTarget()

CameraKit& HPS::CameraKit::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.

◆ SetUpVector()

CameraKit& HPS::CameraKit::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.

◆ Show()

void HPS::CameraKit::Show ( CameraKit out_kit) const

Copies all settings from this CameraKit into the given CameraKit.

Parameters
out_kitThe CameraKit to populate with the contents of this object.

◆ ShowField()

bool HPS::CameraKit::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::CameraKit::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::CameraKit::ShowNearLimit ( float &  out_near_limit) const

Shows the near limit field.

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

◆ ShowPosition()

bool HPS::CameraKit::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::CameraKit::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::CameraKit::ShowProjection ( Camera::Projection out_type,
float &  out_oblique_y_skew,
float &  out_oblique_x_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::CameraKit::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::CameraKit::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::CameraKit::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.

◆ UnsetEverything()

CameraKit& HPS::CameraKit::UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetField()

CameraKit& HPS::CameraKit::UnsetField ( )

Removes the camera field setting.

Returns
A reference to this object.

◆ UnsetNearLimit()

CameraKit& HPS::CameraKit::UnsetNearLimit ( )

Removes the camera near limit setting.

Returns
A reference to this object.

◆ UnsetPosition()

CameraKit& HPS::CameraKit::UnsetPosition ( )

Removes the camera position setting.

Returns
A reference to this object.

◆ UnsetProjection()

CameraKit& HPS::CameraKit::UnsetProjection ( )

Removes the camera projection setting.

Returns
A reference to this object.

◆ UnsetTarget()

CameraKit& HPS::CameraKit::UnsetTarget ( )

Removes the camera target setting.

Returns
A reference to this object.

◆ UnsetUpVector()

CameraKit& HPS::CameraKit::UnsetUpVector ( )

Removes the camera up-vector setting.

Returns
A reference to this object.

◆ Zoom()

CameraKit& HPS::CameraKit::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: