Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.View Class Reference
Inheritance diagram for HPS.View:
HPS.Sprocket HPS.Object

Public Member Functions

void Assign (HPS.View in_that)
 
void AttachModel (HPS.Model in_model)
 
HPS.View ComputeFitWorldCamera (out HPS.CameraKit out_camera)
 
HPS.View ComputeFitWorldCamera (HPS.SegmentKey in_segment, out HPS.CameraKit out_camera)
 
HPS.View ComputeFitWorldCamera (HPS.BoundingKit in_bounding, out HPS.CameraKit out_camera)
 
HPS.View ComputeFitWorldCamera (HPS.SegmentKey in_segment, HPS.MatrixKit in_transform, out HPS.CameraKit out_camera)
 
HPS.View ComputeFitWorldCamera (HPS.BoundingKit in_bounding, HPS.MatrixKit in_transform, out HPS.CameraKit out_camera)
 
void Delete ()
 
void DetachModel ()
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.View in_that)
 
HPS.View FitWorld ()
 
HPS.View FitWorld (HPS.SegmentKey in_segment)
 
HPS.View FitWorld (HPS.BoundingKit in_bounding)
 
HPS.View FitWorld (HPS.SegmentKey in_segment, HPS.MatrixKit in_transform)
 
HPS.View FitWorld (HPS.BoundingKit in_bounding, HPS.MatrixKit in_transform)
 
HPS.AnimationControl GetAnimationControl ()
 
HPS.Model GetAttachedModel ()
 
HPS.IncludeKey GetAttachedModelIncludeLink ()
 
HPS.AxisTriadControl GetAxisTriadControl ()
 
override int GetHashCode ()
 
HPS.SegmentKey GetModelOverrideSegmentKey ()
 
string GetName ()
 
HPS.NavigationCubeControl GetNavigationCubeControl ()
 
HPS.Key [] GetNavigationKeys ()
 
HPS.OperatorControl GetOperatorControl ()
 
HPS.Layout [] GetOwningLayouts ()
 
HPS.PortfolioKey GetPortfolioKey ()
 
HPS.Rendering.Mode GetRenderingMode ()
 
HPS.SegmentKey GetSegmentKey ()
 
bool GetSimpleReflection ()
 
bool GetSimpleShadow ()
 
override HPS.Type ObjectType ()
 
void SetOperator (HPS.Operator in_operator)
 
void SetOperators (HPS.Operator[] in_operators)
 
void SetRenderingMode (HPS.Rendering.Mode in_mode)
 
void SetSimpleReflection (bool in_state, float in_percent_offset)
 
void SetSimpleReflection (bool in_state)
 
void SetSimpleShadow (bool in_state, float in_percent_offset)
 
void SetSimpleShadow (bool in_state)
 
void SmoothTransition (HPS.CameraKit in_camera_kit, double in_duration)
 
void SmoothTransition (HPS.CameraKit in_camera_kit)
 
void Update ()
 
void Update (HPS.Window.UpdateType in_type, double in_time_limit)
 
void Update (HPS.Window.UpdateType in_type)
 
HPS.UpdateNotifier UpdateWithNotifier ()
 
HPS.UpdateNotifier UpdateWithNotifier (HPS.Window.UpdateType in_type, double in_time_limit)
 
HPS.UpdateNotifier UpdateWithNotifier (HPS.Window.UpdateType in_type)
 
View (HPS.View that)
 
View (HPS.SprocketControl in_ctrl)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static bool operator!= (HPS.View a, HPS.View b)
 
static bool operator== (HPS.View a, HPS.View 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.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The View class is one of the four core display classes used in a Visualize application. It is meant to be used as part of a display hierarchy along with the Canvas, Layout, and Model objects. The View has a parent Layout and can contain a single Model. The View is meant to represent one particular camera's view of the scene. Like the other three core objects, the View is backed by a HPS.SegmentKey.

Member Function Documentation

◆ AttachModel()

void HPS.View.AttachModel ( HPS.Model  in_model)
inline

Attaches a Model to this View. Only a single Model can be attached to a View at one time. If you attach a Model to a View which already has an attached Model, the new Model will replace the old one.

Parameters
in_modelthe Model to attach to this View

◆ ComputeFitWorldCamera() [1/5]

HPS.View HPS.View.ComputeFitWorldCamera ( out HPS.CameraKit  out_camera)
inline

This method computes a camera to fit the extents of the scene.

Parameters
out_cameraThe camera computed by the fit world routine.

◆ ComputeFitWorldCamera() [2/5]

HPS.View HPS.View.ComputeFitWorldCamera ( HPS.SegmentKey  in_segment,
out HPS.CameraKit  out_camera 
)
inline

This method computes a camera to fit the extents of a segment.

Parameters
in_segmentThe segment used to calculate the new camera.
out_cameraThe camera computed by the fit world routine.

◆ ComputeFitWorldCamera() [3/5]

HPS.View HPS.View.ComputeFitWorldCamera ( HPS.BoundingKit  in_bounding,
out HPS.CameraKit  out_camera 
)
inline

This method computes a camera to fit a bounding.

Parameters
in_boundingThe bounding used to calculate the new camera.
out_cameraThe camera computed by the fit world routine.

◆ ComputeFitWorldCamera() [4/5]

HPS.View HPS.View.ComputeFitWorldCamera ( HPS.SegmentKey  in_segment,
HPS.MatrixKit  in_transform,
out HPS.CameraKit  out_camera 
)
inline

This method computes a camera to fit the extents of a segment.

Parameters
in_segmentThe segment used to calculate the new camera.
in_transformAn optional transform to apply to the segment bounding used to compute the camera. This can be used to ensure that the camera is looking at the geometry in the correct position once any modelling matrices are applied.
out_cameraThe camera computed by the fit world routine.

◆ ComputeFitWorldCamera() [5/5]

HPS.View HPS.View.ComputeFitWorldCamera ( HPS.BoundingKit  in_bounding,
HPS.MatrixKit  in_transform,
out HPS.CameraKit  out_camera 
)
inline

This method computes a camera to fit a bounding.

Parameters
in_boundingThe bounding used to calculate the new camera.
in_transformAn optional transform to apply to the bounding used to compute the camera. This can be used to ensure that the camera is looking at the geometry in the correct position once any modelling matrices are applied.
out_cameraThe camera computed by the fit world routine.

◆ Delete()

void HPS.View.Delete ( )
inline

Deletes this View. If the View has a Model attached, the Model will not be destroyed.

◆ DetachModel()

void HPS.View.DetachModel ( )
inline

Detaches the Model from this View

◆ FitWorld() [1/5]

HPS.View HPS.View.FitWorld ( )
inline

This method automatically adjusts the camera to fit the extents of the scene.

◆ FitWorld() [2/5]

HPS.View HPS.View.FitWorld ( HPS.SegmentKey  in_segment)
inline

This method automatically adjusts the camera to fit the extents of a segment. Note that this method does not take into account any transformations found between in_segment and the View segment. If there might be transforms between in_segment and the View segment, you can use the version of FitWorld which does not require a parameter, or the version of FitWorld which takes both a SegmentKey and a MatrixKit.

Parameters
in_segmentThe segment used to calculate the new camera.

◆ FitWorld() [3/5]

HPS.View HPS.View.FitWorld ( HPS.BoundingKit  in_bounding)
inline

This method automatically adjusts the camera to fit a bounding.

Parameters
in_boundingThe bounding used to calculate the new camera.

◆ FitWorld() [4/5]

HPS.View HPS.View.FitWorld ( HPS.SegmentKey  in_segment,
HPS.MatrixKit  in_transform 
)
inline

This method automatically adjusts the camera to fit the extents of a segment. In the general case, in_transform should be the product of all the MatrixKits found between the View segment and in_segment.

Parameters
in_segmentThe segment used to calculate the new camera.
in_transformAn optional transform to apply to the segment bounding used to compute the camera. This can be used to ensure that the camera is looking at the geometry in the correct position once any modelling matrices are applied.

◆ FitWorld() [5/5]

HPS.View HPS.View.FitWorld ( HPS.BoundingKit  in_bounding,
HPS.MatrixKit  in_transform 
)
inline

This method automatically adjusts the camera to fit a bounding.

Parameters
in_boundingThe bounding used to calculate the new camera.
in_transformAn optional transform to apply to the bounding used to compute the camera. This can be used to ensure that the camera is looking at the geometry in the correct position once any modelling matrices are applied.

◆ GetAnimationControl()

HPS.AnimationControl HPS.View.GetAnimationControl ( )
inline

Gets the AnimationControl that is associated with this View.

◆ GetAttachedModel()

HPS.Model HPS.View.GetAttachedModel ( )
inline

Returns the Model that is attached to this View

◆ GetAttachedModelIncludeLink()

HPS.IncludeKey HPS.View.GetAttachedModelIncludeLink ( )
inline

Returns the IncludeKey associated with this View. The include key links the View with the Model.

◆ GetAxisTriadControl()

HPS.AxisTriadControl HPS.View.GetAxisTriadControl ( )
inline

Gets the AxisTriadControl that is associated with this View.

◆ GetModelOverrideSegmentKey()

HPS.SegmentKey HPS.View.GetModelOverrideSegmentKey ( )
inline

Returns the model override segment. This segment can be used to change attributes affecting the whole model, without affecting the static tree set at the model level.

◆ GetName()

string HPS.View.GetName ( )
inline

Get the name used when creating this View.

◆ GetNavigationCubeControl()

HPS.NavigationCubeControl HPS.View.GetNavigationCubeControl ( )
inline

Gets the NavigationCubeControl that is associated with this View.

◆ GetNavigationKeys()

HPS.Key [] HPS.View.GetNavigationKeys ( )
inline

Gets an array of Keys associated with the Axis Triad and Navigation Cube for this View

◆ GetOperatorControl()

HPS.OperatorControl HPS.View.GetOperatorControl ( )
inline

Gets the OperatorControl that is associated with this View.

◆ GetOwningLayouts()

HPS.Layout [] HPS.View.GetOwningLayouts ( )
inline

Returns an array containing the Layouts this View is included in.

◆ GetPortfolioKey()

HPS.PortfolioKey HPS.View.GetPortfolioKey ( )
inline

Returns the HPS.PortfolioKey associated with this View.

◆ GetRenderingMode()

HPS.Rendering.Mode HPS.View.GetRenderingMode ( )
inline

Gets the rendering mode for this View. A rendering modes enable things like "hidden line" rendering or a particular lighting interpolation algorithm.

◆ GetSegmentKey()

HPS.SegmentKey HPS.View.GetSegmentKey ( )
inline

Each of the four display hierarchy objects (HPS.Canvas, HPS.Layout, HPS.View, HPS.Model) are backed by a HPS.SegmentKey. This function returns the HPS.SegmentKey that is associated with this View.

◆ GetSimpleReflection()

bool HPS.View.GetSimpleReflection ( )
inline

Returns the status of the simple reflection

◆ GetSimpleShadow()

bool HPS.View.GetSimpleShadow ( )
inline

Returns the status of the simple shadows

◆ ObjectType()

override HPS.Type HPS.View.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.

◆ SetOperator()

void HPS.View.SetOperator ( HPS.Operator  in_operator)
inline

Makes an operator active on this View. Assumes control of the memory of the operator.

Parameters
in_operatorthe operator to be made active on this View.

◆ SetOperators()

void HPS.View.SetOperators ( HPS.Operator []  in_operators)
inline

Makes a set of operators active on this View.

Parameters
in_operatorsthe set of operators to be made active on this View

◆ SetRenderingMode()

void HPS.View.SetRenderingMode ( HPS.Rendering.Mode  in_mode)
inline

Sets the rendering mode for this View. A rendering modes enable things like "hidden line" rendering or a particular lighting interpolation algorithm.

See also
Programming Guide section 3.1.

◆ SetSimpleReflection() [1/2]

void HPS.View.SetSimpleReflection ( bool  in_state,
float  in_percent_offset 
)
inline

Turns simple reflection on or off, automatically calculating reflection plane and light direction

Parameters
in_statecontrols whether simple reflection is on or off
in_percent_offsetdistance to add between the model's bounding box and the position of the reflection plane If not specified, it is set to 5%.

◆ SetSimpleReflection() [2/2]

void HPS.View.SetSimpleReflection ( bool  in_state)
inline

Turns simple reflection on or off, automatically calculating reflection plane and light direction

Parameters
in_statecontrols whether simple reflection is on or off

◆ SetSimpleShadow() [1/2]

void HPS.View.SetSimpleShadow ( bool  in_state,
float  in_percent_offset 
)
inline

Turns simple shadows on or off, automatically calculating shadow plane and light direction

Parameters
in_statecontrols whether simple shadows are on or off
in_percent_offsetdistance to add between the model's bounding box and the position of the shadow plane If not specified, it is set to 5%.

◆ SetSimpleShadow() [2/2]

void HPS.View.SetSimpleShadow ( bool  in_state)
inline

Turns simple shadows on or off, automatically calculating shadow plane and light direction

Parameters
in_statecontrols whether simple shadows are on or off

◆ SmoothTransition() [1/2]

void HPS.View.SmoothTransition ( HPS.CameraKit  in_camera_kit,
double  in_duration 
)
inline

Smoothly moves the camera from the current position to the one specified by the user.

Parameters
in_camera_kita camera kit describing the destination camera
in_durationthe duration of the animation, specified in seconds. Defaults to 0.5 seconds.

◆ SmoothTransition() [2/2]

void HPS.View.SmoothTransition ( HPS.CameraKit  in_camera_kit)
inline

Smoothly moves the camera from the current position to the one specified by the user.

Parameters
in_camera_kita camera kit describing the destination camera

◆ Update() [1/3]

void HPS.View.Update ( )
inline

Redraws the View and all Layouts it appears in, including all of its child components.

◆ Update() [2/3]

void HPS.View.Update ( HPS.Window.UpdateType  in_type,
double  in_time_limit 
)
inline

Redraws the View and all Layouts it appears in, including all of its child components using the specified parameters.

Parameters
in_typeone of the enum values specified by HPS.Window.UpdateType
in_time_limitthe maximum amount of time, in seconds, to spend updating.

◆ Update() [3/3]

void HPS.View.Update ( HPS.Window.UpdateType  in_type)
inline

Redraws the View and all Layouts it appears in, including all of its child components using the specified parameters.

Parameters
in_typeone of the enum values specified by HPS.Window.UpdateType

◆ UpdateWithNotifier() [1/3]

HPS.UpdateNotifier HPS.View.UpdateWithNotifier ( )
inline

Redraws the View and all Layouts it appears in, including all of its child components using the default options, and also returns a notifier to facilitate tracking the update progress.

Returns
An UpdateNotifier object used to find out information about the update.

◆ UpdateWithNotifier() [2/3]

HPS.UpdateNotifier HPS.View.UpdateWithNotifier ( HPS.Window.UpdateType  in_type,
double  in_time_limit 
)
inline

Redraws the View and all Layouts it appears in, including all of its child components using the specified, and also returns a notifier to facilitate tracking the update progress.

Parameters
in_typeone of the enum values specified by HPS.Window.UpdateType
in_time_limitthe maximum amount of time, in seconds, to spend updating this HPS.Canvas
Returns
An UpdateNotifier object used to find out information about the update.

◆ UpdateWithNotifier() [3/3]

HPS.UpdateNotifier HPS.View.UpdateWithNotifier ( HPS.Window.UpdateType  in_type)
inline

Redraws the View and all Layouts it appears in, including all of its child components using the specified, and also returns a notifier to facilitate tracking the update progress.

Parameters
in_typeone of the enum values specified by HPS.Window.UpdateType
Returns
An UpdateNotifier object used to find out information about the update.
The documentation for this class was generated from the following file:
  • internals/hps_sprk/source/cs/HPS.View.cs