REFERENCE MANUAL
The CameraKit class is a user space object, useful for carrying a group of attribute settings. More...
Public Member Functions | |
CameraKit () | |
Initializes an empty kit. More... | |
CameraKit (HPS.CameraKit in_kit) | |
The copy constructor creates a new CameraKit object that contains the same settings as the source object. More... | |
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. More... | |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.CameraKit in_kit) |
Check if the source CameraKit is equivalent to this object. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
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. More... | |
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. More... | |
HPS.CameraKit | Roll (float in_theta) |
Spins the camera around its target in_theta degrees counter-clockwise (the scene will appear to move clockwise). More... | |
void | Set (HPS.CameraKit in_kit) |
Copies all settings from the source CameraKit into this object. More... | |
HPS.CameraKit | SetField (float in_width, float in_height) |
Sets the camera field. More... | |
HPS.CameraKit | SetNearLimit (float in_limit) |
Sets the near_limit to in_double that defines the near limit of the camera. More... | |
HPS.CameraKit | SetPosition (HPS.Point in_position) |
Sets the location of the camera. More... | |
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. More... | |
HPS.CameraKit | SetProjection (HPS.Camera.Projection in_type, float in_oblique_y_skew) |
Sets the camera projection type and the oblique skew, if any. More... | |
HPS.CameraKit | SetProjection (HPS.Camera.Projection in_type) |
Sets the camera projection type and the oblique skew, if any. More... | |
HPS.CameraKit | SetTarget (HPS.Point in_target) |
Sets the location that the camera is pointed at. More... | |
HPS.CameraKit | SetUpVector (HPS.Vector in_up) |
Sets a vector that defines the vertical up direction of the camera. More... | |
void | Show (out HPS.CameraKit out_kit) |
Copies all settings from this CameraKit into the given CameraKit. More... | |
bool | ShowField (out float out_width, out float out_height) |
Shows the camera field. More... | |
bool | ShowHeight (out float out_height) |
Shows the height of the camera field. More... | |
bool | ShowNearLimit (out float out_near_limit) |
Shows the near limit field. More... | |
bool | ShowPosition (out HPS.Point out_position) |
Shows the camera position. More... | |
bool | ShowProjection (out HPS.Camera.Projection out_type) |
Shows the camera projection type. More... | |
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. More... | |
bool | ShowTarget (out HPS.Point out_target) |
Shows the camera target. More... | |
bool | ShowUpVector (out HPS.Vector out_up) |
Shows the camera up-vector. More... | |
bool | ShowWidth (out float out_width) |
Shows the width of the camera field. More... | |
HPS.CameraKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.CameraKit | UnsetField () |
Removes the camera field setting. More... | |
HPS.CameraKit | UnsetNearLimit () |
Removes the camera near limit setting. More... | |
HPS.CameraKit | UnsetPosition () |
Removes the camera position setting. More... | |
HPS.CameraKit | UnsetProjection () |
Removes the camera projection setting. More... | |
HPS.CameraKit | UnsetTarget () |
Removes the camera target setting. More... | |
HPS.CameraKit | UnsetUpVector () |
Removes the camera up-vector setting. More... | |
HPS.CameraKit | Zoom (float in_zoom) |
Adjusts the field of view by dividing the width and height by the input value. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static HPS.CameraKit | GetDefault () |
Creates a CameraKit which contains the default settings. More... | |
static bool | operator!= (HPS.CameraKit a, HPS.CameraKit b) |
static bool | operator== (HPS.CameraKit a, HPS.CameraKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The CameraKit class is a user space object, useful for carrying a group of attribute settings.
Calling CameraKit::GetDefault() will return a kit with values found in this table.
HPS.CameraKit.CameraKit | ( | ) |
Initializes an empty kit.
HPS.CameraKit.CameraKit | ( | HPS.CameraKit | in_kit | ) |
The copy constructor creates a new CameraKit object that contains the same settings as the source object.
in_kit | The source object to copy. |
HPS.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.
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. |
|
virtual |
Indicates whether this object has any values set on it.
Reimplemented from HPS.Object.
bool HPS.CameraKit.Equals | ( | HPS.CameraKit | in_kit | ) |
|
static |
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
HPS.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.
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. |
HPS.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.
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. |
HPS.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.
in_theta | The number of degrees to roll the camera. |
void HPS.CameraKit.Set | ( | HPS.CameraKit | in_kit | ) |
HPS.CameraKit HPS.CameraKit.SetField | ( | float | in_width, |
float | in_height | ||
) |
Sets the camera field.
in_width | The width of the camera field, in object-space units. |
in_height | The height of the camera field, in object-space units. |
Default value
HPS.CameraKit HPS.CameraKit.SetNearLimit | ( | float | in_limit | ) |
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 choose a wlimit based on the precision of the zbuffer as reported by the driver.
HPS.CameraKit HPS.CameraKit.SetPosition | ( | HPS.Point | in_position | ) |
Sets the location of the camera.
in_position | The location of the camera. |
HPS.CameraKit 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.
in_type | The type of camera projection. |
in_oblique_y_skew | The oblique skew in the vertical direction. |
in_oblique_x_skew | The oblique skew in the horizontal direction. |
Default value
HPS.CameraKit HPS.CameraKit.SetProjection | ( | HPS.Camera.Projection | in_type, |
float | in_oblique_y_skew | ||
) |
Sets the camera projection type and the oblique skew, if any.
in_type | The type of camera projection. |
in_oblique_y_skew | The oblique skew in the vertical direction. |
Default value
HPS.CameraKit HPS.CameraKit.SetProjection | ( | HPS.Camera.Projection | in_type | ) |
Sets the camera projection type and the oblique skew, if any.
in_type | The type of camera projection. |
Default value
HPS.CameraKit HPS.CameraKit.SetTarget | ( | HPS.Point | in_target | ) |
Sets the location that the camera is pointed at.
in_target | The location that the camera is pointed at. |
HPS.CameraKit HPS.CameraKit.SetUpVector | ( | HPS.Vector | in_up | ) |
Sets a vector that defines the vertical up direction of the camera.
in_up | A vector that defines the vertical up direction of the camera. |
void HPS.CameraKit.Show | ( | out HPS.CameraKit | out_kit | ) |
bool HPS.CameraKit.ShowField | ( | out float | out_width, |
out float | out_height | ||
) |
Shows the camera field.
out_width | The width of the camera field, in object-space units. |
out_height | The height of the camera field, in object-space units. |
bool HPS.CameraKit.ShowHeight | ( | out float | out_height | ) |
Shows the height of the camera field.
out_height | The height of the camera field, in object-space units. |
bool HPS.CameraKit.ShowNearLimit | ( | out float | out_near_limit | ) |
Shows the near limit field.
out_near_limit | The near_limit of the camera field; |
bool HPS.CameraKit.ShowPosition | ( | out HPS.Point | out_position | ) |
Shows the camera position.
out_position | the location of the camera. |
bool HPS.CameraKit.ShowProjection | ( | out HPS.Camera.Projection | out_type | ) |
Shows the camera projection type.
out_type | The type of camera projection. |
bool HPS.CameraKit.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.
out_type | The type of camera projection. |
out_oblique_y_skew | The oblique skew in the vertical direction. |
out_oblique_x_skew | The oblique skew in the horizontal direction. |
bool HPS.CameraKit.ShowTarget | ( | out HPS.Point | out_target | ) |
Shows the camera target.
out_target | the location that the camera is pointed at. |
bool HPS.CameraKit.ShowUpVector | ( | out HPS.Vector | out_up | ) |
Shows the camera up-vector.
out_up | A vector that defines the vertical up direction of the camera. |
bool HPS.CameraKit.ShowWidth | ( | out float | out_width | ) |
Shows the width of the camera field.
out_width | The width of the camera field, in object-space units. |
HPS.CameraKit HPS.CameraKit.UnsetEverything | ( | ) |
Removes all settings from this object.
HPS.CameraKit HPS.CameraKit.UnsetField | ( | ) |
Removes the camera field setting.
HPS.CameraKit HPS.CameraKit.UnsetNearLimit | ( | ) |
Removes the camera near limit setting.
HPS.CameraKit HPS.CameraKit.UnsetPosition | ( | ) |
Removes the camera position setting.
HPS.CameraKit HPS.CameraKit.UnsetProjection | ( | ) |
Removes the camera projection setting.
HPS.CameraKit HPS.CameraKit.UnsetTarget | ( | ) |
Removes the camera target setting.
HPS.CameraKit HPS.CameraKit.UnsetUpVector | ( | ) |
Removes the camera up-vector setting.
HPS.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.
in_zoom | The zoom scale factor. |