Inheritance diagram for HPS.CameraKit:
HPS.Kit HPS.Object

Public Member Functions

 CameraKit ()
 
 CameraKit (HPS.CameraKit in_kit)
 
override void Dispose ()
 
HPS.CameraKit Dolly (float in_x_dir, float in_up, float in_forward)
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.CameraKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
HPS.CameraKit Orbit (float in_theta, float in_phi)
 
HPS.CameraKit Pan (float in_theta, float in_phi)
 
HPS.CameraKit Roll (float in_theta)
 
void Set (HPS.CameraKit in_kit)
 
HPS.CameraKit SetField (float in_width, float in_height)
 
HPS.CameraKit SetNearLimit (float in_limit)
 
HPS.CameraKit SetPosition (HPS.Point in_position)
 
HPS.CameraKit SetProjection (HPS.Camera.Projection in_type, float in_oblique_y_skew, float in_oblique_x_skew)
 
HPS.CameraKit SetProjection (HPS.Camera.Projection in_type, float in_oblique_y_skew)
 
HPS.CameraKit SetProjection (HPS.Camera.Projection in_type)
 
HPS.CameraKit SetTarget (HPS.Point in_target)
 
HPS.CameraKit SetUpVector (HPS.Vector in_up)
 
void Show (out HPS.CameraKit out_kit)
 
bool ShowField (out float out_width, out float out_height)
 
bool ShowHeight (out float out_height)
 
bool ShowNearLimit (out float out_near_limit)
 
bool ShowPosition (out HPS.Point out_position)
 
bool ShowProjection (out HPS.Camera.Projection out_type)
 
bool ShowProjection (out HPS.Camera.Projection out_type, out float out_oblique_y_skew, out float out_oblique_x_skew)
 
bool ShowTarget (out HPS.Point out_target)
 
bool ShowUpVector (out HPS.Vector out_up_vector)
 
bool ShowWidth (out float out_width)
 
HPS.CameraKit UnsetEverything ()
 
HPS.CameraKit UnsetField ()
 
HPS.CameraKit UnsetNearLimit ()
 
HPS.CameraKit UnsetPosition ()
 
HPS.CameraKit UnsetProjection ()
 
HPS.CameraKit UnsetTarget ()
 
HPS.CameraKit UnsetUpVector ()
 
HPS.CameraKit Zoom (float in_zoom)
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.CameraKit GetDefault ()
 
static bool operator!= (HPS.CameraKit a, HPS.CameraKit b)
 
static bool operator== (HPS.CameraKit a, HPS.CameraKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Kit
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
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

◆ CameraKit() [1/2]

HPS.CameraKit.CameraKit ( )
inline

Initializes an empty kit.

◆ CameraKit() [2/2]

HPS.CameraKit.CameraKit ( HPS.CameraKit  in_kit)
inline

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

Parameters
in_kitThe source object to copy.

Member Function Documentation

◆ Dolly()

HPS.CameraKit HPS.CameraKit.Dolly ( float  in_x_dir,
float  in_up,
float  in_forward 
)
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_dirThe number of world-space units to move the camera in the x-direction.
in_upThe number of world-space units to move the camera up, or if negative, down.
in_forwardThe 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.

◆ Empty()

override bool HPS.CameraKit.Empty ( )
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.

◆ Equals()

bool HPS.CameraKit.Equals ( HPS.CameraKit  in_kit)
inline

Check if the source CameraKit is equivalent to this object.

Parameters
in_kitThe source CameraKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.CameraKit HPS.CameraKit.GetDefault ( )
inlinestatic

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.

◆ ObjectType()

override HPS.Type HPS.CameraKit.ObjectType ( )
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.

◆ Orbit()

HPS.CameraKit HPS.CameraKit.Orbit ( float  in_theta,
float  in_phi 
)
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_thetaThe number of degrees to move the the camera position to the right.
in_phiThe number of degrees to move the the camera position up.
Returns
A reference to this object.

◆ Pan()

HPS.CameraKit HPS.CameraKit.Pan ( float  in_theta,
float  in_phi 
)
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_thetaThe number of degrees to move the the camera target to the right.
in_phiThe number of degrees to move the the camera target up.
Returns
A reference to this object.

◆ Roll()

HPS.CameraKit HPS.CameraKit.Roll ( float  in_theta)
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_thetaThe number of degrees to roll the camera.
Returns
A reference to this object.

◆ Set()

void HPS.CameraKit.Set ( HPS.CameraKit  in_kit)
inline

Copies all settings from the source CameraKit into this object.

Parameters
in_kitThe source CameraKit to copy.

◆ SetField()

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

Sets the camera field.

Parameters
in_widthThe width of the camera field, in object-space units.
in_heightThe height of the camera field, in object-space units.
Returns
A reference to this object.
See also
Default value

◆ SetNearLimit()

HPS.CameraKit HPS.CameraKit.SetNearLimit ( float  in_limit)
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_limitThe value to set the near limit to
Returns
A reference to this object.

◆ SetPosition()

HPS.CameraKit HPS.CameraKit.SetPosition ( HPS.Point  in_position)
inline

Sets the location of the camera.

Parameters
in_positionThe location of the camera.
Returns
A reference to this object.

◆ SetProjection() [1/3]

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

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

Parameters
in_typeThe type of camera projection.
in_oblique_y_skewThe oblique skew in the vertical direction.
in_oblique_x_skewThe oblique skew in the horizontal direction.
Returns
A reference to this object.
See also
Default value

◆ SetProjection() [2/3]

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

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

Parameters
in_typeThe type of camera projection.
in_oblique_y_skewThe oblique skew in the vertical direction.
Returns
A reference to this object.
See also
Default value

◆ SetProjection() [3/3]

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

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

Parameters
in_typeThe type of camera projection.
Returns
A reference to this object.
See also
Default value

◆ SetTarget()

HPS.CameraKit HPS.CameraKit.SetTarget ( HPS.Point  in_target)
inline

Sets the location that the camera is pointed at.

Parameters
in_targetThe location that the camera is pointed at.
Returns
A reference to this object.

◆ SetUpVector()

HPS.CameraKit HPS.CameraKit.SetUpVector ( HPS.Vector  in_up)
inline

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

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

◆ Show()

void HPS.CameraKit.Show ( out HPS.CameraKit  out_kit)
inline

Copies all settings from this CameraKit into the given CameraKit.

Parameters
out_kitThe CameraKit to populate with the contents of this object.

◆ ShowField()

bool HPS.CameraKit.ShowField ( out float  out_width,
out float  out_height 
)
inline

Shows the camera field.

Parameters
out_widthThe width of the camera field, in object-space units.
out_heightThe height of the camera field, in object-space units.
Returns
true if the setting is valid, false otherwise.

◆ ShowHeight()

bool HPS.CameraKit.ShowHeight ( out float  out_height)
inline

Shows the height of the camera field.

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

◆ ShowNearLimit()

bool HPS.CameraKit.ShowNearLimit ( out float  out_near_limit)
inline

Shows the near limit field.

Parameters
out_near_limitThe near limit of the camera field.
Returns
true if the setting is valid, false otherwise.

◆ ShowPosition()

bool HPS.CameraKit.ShowPosition ( out HPS.Point  out_position)
inline

Shows the camera position.

Parameters
out_positionthe location of the camera.
Returns
true if the setting is valid, false otherwise.

◆ ShowProjection() [1/2]

bool HPS.CameraKit.ShowProjection ( out HPS.Camera.Projection  out_type)
inline

Shows the camera projection type.

Parameters
out_typeThe type of camera projection.
Returns
true if the setting is valid, false otherwise.

◆ ShowProjection() [2/2]

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

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

Parameters
out_typeThe type of camera projection.
out_oblique_y_skewThe oblique skew in the vertical direction.
out_oblique_x_skewThe oblique skew in the horizontal direction.
Returns
true if the setting is valid, false otherwise.

◆ ShowTarget()

bool HPS.CameraKit.ShowTarget ( out HPS.Point  out_target)
inline

Shows the camera target.

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

◆ ShowUpVector()

bool HPS.CameraKit.ShowUpVector ( out HPS.Vector  out_up_vector)
inline

Shows the camera up-vector.

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

◆ ShowWidth()

bool HPS.CameraKit.ShowWidth ( out float  out_width)
inline

Shows the width of the camera field.

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

◆ UnsetEverything()

HPS.CameraKit HPS.CameraKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetField()

HPS.CameraKit HPS.CameraKit.UnsetField ( )
inline

Removes the camera field setting.

Returns
A reference to this object.

◆ UnsetNearLimit()

HPS.CameraKit HPS.CameraKit.UnsetNearLimit ( )
inline

Removes the camera near limit setting.

Returns
A reference to this object.

◆ UnsetPosition()

HPS.CameraKit HPS.CameraKit.UnsetPosition ( )
inline

Removes the camera position setting.

Returns
A reference to this object.

◆ UnsetProjection()

HPS.CameraKit HPS.CameraKit.UnsetProjection ( )
inline

Removes the camera projection setting.

Returns
A reference to this object.

◆ UnsetTarget()

HPS.CameraKit HPS.CameraKit.UnsetTarget ( )
inline

Removes the camera target setting.

Returns
A reference to this object.

◆ UnsetUpVector()

HPS.CameraKit HPS.CameraKit.UnsetUpVector ( )
inline

Removes the camera up-vector setting.

Returns
A reference to this object.

◆ Zoom()

HPS.CameraKit HPS.CameraKit.Zoom ( float  in_zoom)
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_zoomThe 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