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 (HPS.CameraKit in_kit)

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

Param in_kit: The source object to copy.

override void Dispose ()

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.

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 bool Empty ()

Indicates whether this object has any values set on it.

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

bool Equals (HPS.CameraKit in_kit)

Check if the source CameraKit is equivalent to this object.

Param in_kit: The source CameraKit to compare to this object.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

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

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

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

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

void Set (HPS.CameraKit in_kit)

Copies all settings from the source CameraKit into this object.

Param in_kit: The source CameraKit to copy.

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

Sets the camera field.

See: Default value

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.CameraKit SetNearLimit (float 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.

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

HPS.CameraKit SetPosition (HPS.Point in_position)

Sets the location of the camera.

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

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

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

See: Default value

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

HPS.CameraKit SetProjection (HPS.Camera.Projection in_type, float in_oblique_y_skew)

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

See: Default value

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

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

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

See: Default value

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

HPS.CameraKit SetTarget (HPS.Point in_target)

Sets the location that the camera is pointed at.

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

HPS.CameraKit SetUpVector (HPS.Vector in_up)

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

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

void Show (out HPS.CameraKit out_kit)

Copies all settings from this CameraKit into the given CameraKit.

Param out_kit: The CameraKit to populate with the contents of 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 near limit field.

Param out_near_limit: The near limit of the camera field.
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_y_skew, out float out_oblique_x_skew)

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

Param out_type: The type of camera projection.
Param out_oblique_y_skew: The oblique skew in the vertical direction.
Param out_oblique_x_skew: The oblique skew in the horizontal 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.CameraKit UnsetEverything ()

Removes all settings from this object.

Return: A reference to this object.

HPS.CameraKit UnsetField ()

Removes the camera field setting.

Return: A reference to this object.

HPS.CameraKit UnsetNearLimit ()

Removes the camera near limit setting.

Return: A reference to this object.

HPS.CameraKit UnsetPosition ()

Removes the camera position setting.

Return: A reference to this object.

HPS.CameraKit UnsetProjection ()

Removes the camera projection setting.

Return: A reference to this object.

HPS.CameraKit UnsetTarget ()

Removes the camera target setting.

Return: A reference to this object.

HPS.CameraKit UnsetUpVector ()

Removes the camera up-vector setting.

Return: A reference to this object.

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.

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

Public Static Functions

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

Return: A CameraKit with the default settings.

bool operator!= (HPS.CameraKit a, HPS.CameraKit b)

bool operator== (HPS.CameraKit a, HPS.CameraKit b)