CameraControl

class HPS.CameraControl : public HPS.Control 

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.

Public Functions

CameraControl (HPS.CameraControl in_that): Initializes a control tied to the same object as in_that.

CameraControl (HPS.SegmentKey in_seg): Initializes a control tied to the segment in_seg.

override void Dispose ()

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.

Param in_x_dir: The number of world-space units to move the camera in the x-direction.
Param in_up: The number of world-space units to move the camera up, or if negative, down.
Param in_forward: The number of world-space units to move the camera toward the target, or if negative, away from the target.
Return: A reference to this object.

override HPS.Type ObjectType ()

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

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

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.

Param in_theta: The number of degrees to move the the camera position to the right.
Param in_phi: The number of degrees to move the the camera position up.
Return: A reference to this object.

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.

Param in_theta: The number of degrees to move the the camera target to the right.
Param in_phi: The number of degrees to move the the camera target up.
Return: A reference to this object.

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.

Param in_theta: The number of degrees to roll the camera.
Return: A reference to this object.

HPS.CameraControl SetField (float in_width, float in_height)

Sets the camera field.

See: camera field

Param in_width: The width of the camera field, in object-space units.
Param in_height: The height of the camera field, in object-space units.
Return: A reference to this object.

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.

See: camera near limit

Param in_double: The value to set the near limit to
Return: A reference to this object.

HPS.CameraControl SetPosition (HPS.Point in_position)

Sets the location of the camera.

See: camera position

Param in_position: The location of the camera.
Return: A reference to this object.

HPS.CameraControl SetProjection (HPS.Camera.Projection in_type)

Sets the camera projection type and the oblique skew, if any.

See: camera target

Param in_type: The type of camera projection.
Return: A reference to this object.

HPS.CameraControl SetProjection (HPS.Camera.Projection in_type, float in_oblique_x_skew)

Sets the camera projection type and the oblique skew, if any.

See: camera target

Param in_type: The type of camera projection.
Param in_oblique_x_skew: The oblique skew in the horizontal direction.
Return: A reference to this object.

HPS.CameraControl SetProjection (HPS.Camera.Projection in_type, float in_oblique_x_skew, float in_oblique_y_skew)

Sets the camera projection type and the oblique skew, if any.

See: camera target

Param in_type: The type of camera projection.
Param in_oblique_x_skew: The oblique skew in the horizontal direction.
Param in_oblique_y_skew: The oblique skew in the vertical direction.
Return: A reference to this object.

HPS.CameraControl SetTarget (HPS.Point in_target)

Sets the location that the camera is pointed at.

See: camera position

Param in_target: The location that the camera is pointed at.
Return: A reference to this object.

HPS.CameraControl SetUpVector (HPS.Vector in_up)

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

See: camera up vector

Param in_up: A vector that defines the vertical up direction of the camera.
Return: A reference to this object.

bool ShowField (out float out_width, out float out_height)

Shows the camera field.

Param out_width: The width of the camera field, in object-space units.
Param out_height: The height of the camera field, in object-space units.
Return: true if the setting is valid, false otherwise.

bool ShowHeight (out float out_height)

Shows the height of the camera field.

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

bool ShowNearLimit (out float out_near_limit)

Shows the camera near limit.

Return: true if the setting is valid, false otherwise.

bool ShowPosition (out HPS.Point out_position)

Shows the camera position.

Param out_position: the location of the camera.
Return: true if the setting is valid, false otherwise.

bool ShowProjection (out HPS.Camera.Projection out_type)

Shows the camera projection type.

Param out_type: The type of camera projection.
Return: true if the setting is valid, false otherwise.

bool ShowProjection (out HPS.Camera.Projection out_type, out float out_oblique_x_skew, out float out_oblique_y_skew)

Shows the camera projection type and the oblique skew, if any.

Param out_type: The type of camera projection.
Param out_oblique_x_skew: The oblique skew in the horizontal direction.
Param out_oblique_y_skew: The oblique skew in the vertical direction.
Return: true if the setting is valid, false otherwise.

bool ShowTarget (out HPS.Point out_target)

Shows the camera target.

Param out_target: the location that the camera is pointed at.
Return: true if the setting is valid, false otherwise.

bool ShowUpVector (out HPS.Vector out_up_vector)

Shows the camera up-vector.

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

bool ShowWidth (out float out_width)

Shows the width of the camera field.

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

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().

Return: A reference to this object.

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.

Param in_zoom: The zoom scale factor.
Return: A reference to this object.