
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. If a complete camera is not already set up, one will be populated with default values before dollying. 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 (if the object is derived, this does not give the true type of the derived object). 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. 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. 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. 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. 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). 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. 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_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. 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_vector) |
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. 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. More... | |
![]() | |
override void | Dispose () |
Kit (HPS.Kit in_that) | |
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). More... | |
override HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Static Public Member Functions | |
static 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. 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 () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
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
|
inline |
Initializes an empty kit.
|
inline |
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.
Member Function Documentation
|
inline |
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.
|
inlinevirtual |
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.
|
inline |
|
inlinestatic |
|
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.Object.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
|
inline |
Sets the camera field.
- 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.
Default value
|
inline |
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.
|
inline |
Sets the location of the camera.
- Parameters
-
in_position The location of the camera.
- Returns
- A reference to this object.
|
inline |
Sets the camera projection type and the oblique skew, if any.
- Parameters
-
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.
- Returns
- A reference to this object.
Default value
|
inline |
Sets the camera projection type and the oblique skew, if any.
- Parameters
-
in_type The type of camera projection. in_oblique_y_skew The oblique skew in the vertical direction.
- Returns
- A reference to this object.
Default value
|
inline |
Sets the camera projection type and the oblique skew, if any.
- Parameters
-
in_type The type of camera projection.
- Returns
- A reference to this object.
Default value
|
inline |
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.
|
inline |
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.
|
inline |
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
Shows the camera position.
- Parameters
-
out_position the location of the camera.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the camera projection type.
- Parameters
-
out_type The type of camera projection.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the camera projection type and the oblique skew, if any.
- Parameters
-
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.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the camera target.
- Parameters
-
out_target the location that the camera is pointed at.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
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.
|
inline |
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.
|
inline |
Removes all settings from this object.
- Returns
- A reference to this object.
|
inline |
Removes the camera field setting.
- Returns
- A reference to this object.
|
inline |
Removes the camera near limit setting.
- Returns
- A reference to this object.
|
inline |
Removes the camera position setting.
- Returns
- A reference to this object.
|
inline |
Removes the camera projection setting.
- Returns
- A reference to this object.
|
inline |
Removes the camera target setting.
- Returns
- A reference to this object.
|
inline |
Removes the camera up-vector setting.
- Returns
- A reference to this object.
|
inline |
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.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.CameraKit.cs