CameraKit

class HPS::CameraKit : public HPS::Kit 

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.

Public Functions

CameraKit(): Initializes an empty kit.

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_that – An rvalue reference to a CameraKit to take the impl from.

CameraKit(CameraKit const &in_kit)

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

Parameters: in_kit – The source object to copy.

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

Returns

A reference to this object.

virtual bool Empty() const

Indicates whether this object has any values set on it.

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

bool Equals(CameraKit const &in_kit) const

Check if the source CameraKit is equivalent to this object.

Parameters: in_kit – The source CameraKit to compare to this object.
Returns: true if the objects are equivalent, false otherwise.

inline virtual HPS::Type ObjectType() const

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.

bool operator!=(CameraKit const &in_kit) const

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

Parameters: in_kit – The source CameraKit to compare to this object.
Returns: true if the objects are not equivalent, false otherwise.

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_that – An rvalue reference to a CameraKit to take the impl from.
Returns: A reference to this CameraKit.

CameraKit &operator=(CameraKit const &in_kit)

Copies the source CameraKit into this object.

Parameters: in_kit – The source CameraKit to copy.
Returns: A reference to this object.

bool operator==(CameraKit const &in_kit) const

Check if the source CameraKit is equivalent to this object.

Parameters: in_kit – The source CameraKit to compare to this object.
Returns: true if the objects are equivalent, false otherwise.

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

Returns

A reference to this object.

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

Returns

A reference to this object.

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_theta – The number of degrees to roll the camera.
Returns: A reference to this object.

void Set(CameraKit const &in_kit)

Copies all settings from the source CameraKit into this object.

Parameters: in_kit – The source CameraKit to copy.

CameraKit &SetField(float in_width, float in_height)

Sets the camera field.

See: Default value

Parameters

in_width – The width of the camera field, in object-space units.
in_height – The height of the camera field, in object-space units.

Returns

A reference to this object.

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_limit – The value to set the near limit to
Returns: A reference to this object.

CameraKit &SetPosition(Point const &in_position)

Sets the location of the camera.

Parameters: in_position – The location of the camera.
Returns: A reference to this object.

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.

See: Default value

Parameters

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.

Returns

A reference to this object.

CameraKit &SetTarget(Point const &in_target)

Sets the location that the camera is pointed at.

Parameters: in_target – The location that the camera is pointed at.
Returns: A reference to this object.

CameraKit &SetUpVector(Vector const &in_up)

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

Parameters: in_up – A vector that defines the vertical up direction of the camera.
Returns: A reference to this object.

void Show(CameraKit &out_kit) const

Copies all settings from this CameraKit into the given CameraKit.

Parameters: out_kit – The CameraKit to populate with the contents of this object.

bool ShowField(float &out_width, float &out_height) const

Shows the camera field.

Parameters

out_width – The width of the camera field, in object-space units.
out_height – The height of the camera field, in object-space units.

Returns

true if the setting is valid, false otherwise.

bool ShowHeight(float &out_height) const

Shows the height of the camera field.

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

bool ShowNearLimit(float &out_near_limit) const

Shows the near limit field.

Parameters: out_near_limit – The near limit of the camera field.
Returns: true if the setting is valid, false otherwise.

bool ShowPosition(Point &out_position) const

Shows the camera position.

Parameters: out_position – the location of the camera.
Returns: true if the setting is valid, false otherwise.

bool ShowProjection(Camera::Projection &out_type) const

Shows the camera projection type.

Parameters: out_type – The type of camera projection.
Returns: true if the setting is valid, false otherwise.

bool 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_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.

Returns

true if the setting is valid, false otherwise.

bool ShowTarget(Point &out_target) const

Shows the camera target.

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

bool ShowUpVector(Vector &out_up_vector) const

Shows the camera up-vector.

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

bool ShowWidth(float &out_width) const

Shows the width of the camera field.

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

CameraKit &UnsetEverything()

Removes all settings from this object.

Returns: A reference to this object.

CameraKit &UnsetField()

Removes the camera field setting.

Returns: A reference to this object.

CameraKit &UnsetNearLimit()

Removes the camera near limit setting.

Returns: A reference to this object.

CameraKit &UnsetPosition()

Removes the camera position setting.

Returns: A reference to this object.

CameraKit &UnsetProjection()

Removes the camera projection setting.

Returns: A reference to this object.

CameraKit &UnsetTarget()

Removes the camera target setting.

Returns: A reference to this object.

CameraKit &UnsetUpVector()

Removes the camera up-vector setting.

Returns: A reference to this object.

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_zoom – The zoom scale factor.
Returns: A reference to this object.

virtual ~CameraKit(): Destroy this kit.

Public Static Functions

static CameraKit GetDefault()

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.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::CameraKit