Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.View Class Reference

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

Inheritance diagram for HPS.View:
HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
 View (HPS.View that)
 
 View (HPS.SprocketControl in_ctrl)
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Delete ()
 Deletes this View. If the View has a Model attached, the Model will not be destroyed. More...
 
void Assign (HPS.View in_that)
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.View in_that)
 
string GetName ()
 Get the name used when creating this View. More...
 
HPS.View ComputeFitWorldCamera (out HPS.CameraKit out_camera)
 This method computes a camera to fit the extents of the scene. More...
 
HPS.View ComputeFitWorldCamera (HPS.SegmentKey in_segment, out HPS.CameraKit out_camera)
 This method computes a camera to fit the extents of a segment. More...
 
HPS.View ComputeFitWorldCamera (HPS.BoundingKit in_bounding, out HPS.CameraKit out_camera)
 This method computes a camera to fit a bounding. More...
 
HPS.View ComputeFitWorldCamera (HPS.SegmentKey in_segment, HPS.MatrixKit in_transform, out HPS.CameraKit out_camera)
 This method computes a camera to fit the extents of a segment. More...
 
HPS.View ComputeFitWorldCamera (HPS.BoundingKit in_bounding, HPS.MatrixKit in_transform, out HPS.CameraKit out_camera)
 This method computes a camera to fit a bounding. More...
 
HPS.View FitWorld ()
 This method automatically adjusts the camera to fit the extents of the scene. More...
 
HPS.View FitWorld (HPS.SegmentKey in_segment)
 This method automatically adjusts the camera to fit the extents of a segment. More...
 
HPS.View FitWorld (HPS.BoundingKit in_bounding)
 This method automatically adjusts the camera to fit a bounding. More...
 
HPS.View FitWorld (HPS.SegmentKey in_segment, HPS.MatrixKit in_transform)
 This method automatically adjusts the camera to fit the extents of a segment. More...
 
HPS.View FitWorld (HPS.BoundingKit in_bounding, HPS.MatrixKit in_transform)
 This method automatically adjusts the camera to fit a bounding. More...
 
void AttachModel (HPS.Model in_model)
 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. More...
 
void DetachModel ()
 Detaches the Model from this View More...
 
HPS.Model GetAttachedModel ()
 Returns the Model that is attached to this View More...
 
HPS.IncludeKey GetAttachedModelIncludeLink ()
 Returns the IncludeKey associated with this View. The include key links the View with the Model. More...
 
void SetRenderingMode (HPS.Rendering.Mode in_mode)
 Sets the rendering mode for this View. A rendering modes enable things like "hidden line" rendering or a particular lighting interpolation algorithm. More...
 
HPS.Rendering.Mode GetRenderingMode ()
 Gets the rendering mode for this View. A rendering modes enable things like "hidden line" rendering or a particular lighting interpolation algorithm. More...
 
void SetOperators (HPS.Operator[] in_operators)
 Makes a set of operators active on this View. More...
 
void SetOperator (HPS.Operator in_operator)
 Makes an operator active on this View. Assumes control of the memory of the operator. More...
 
HPS.OperatorControl GetOperatorControl ()
 Gets the OperatorControl that is associated with this View. More...
 
HPS.NavigationCubeControl GetNavigationCubeControl ()
 Gets the NavigationCubeControl that is associated with this View. More...
 
HPS.AxisTriadControl GetAxisTriadControl ()
 Gets the AxisTriadControl that is associated with this View. More...
 
HPS.SegmentKey GetSegmentKey ()
 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. More...
 
HPS.SegmentKey GetModelOverrideSegmentKey ()
 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. More...
 
HPS.PortfolioKey GetPortfolioKey ()
 Returns the HPS::PortfolioKey associated with this View. More...
 
void SetSimpleShadow (bool in_state, float in_percent_offset)
 Turns simple shadows on or off, automatically calculating shadow plane and light direction More...
 
void SetSimpleShadow (bool in_state)
 Turns simple shadows on or off, automatically calculating shadow plane and light direction More...
 
bool GetSimpleShadow ()
 Returns the status of the simple shadows More...
 
void SetSimpleReflection (bool in_state, float in_percent_offset)
 Turns simple reflection on or off, automatically calculating reflection plane and light direction More...
 
void SetSimpleReflection (bool in_state)
 Turns simple reflection on or off, automatically calculating reflection plane and light direction More...
 
bool GetSimpleReflection ()
 Returns the status of the simple reflection More...
 
void Update (HPS.Sprocket.UpdateType in_update_type)
 Redraws the Model in this View. More...
 
void Update ()
 Redraws the Model in this View. More...
 
void Update (HPS.Window.UpdateControl in_control, double time_limit)
 Redraws the Model in this View using parameters that you specify. More...
 
void Update (HPS.Window.UpdateControl in_control)
 Redraws the Model in this View using parameters that you specify. More...
 
void SmoothTransition (HPS.CameraKit in_camera_kit, double in_duration)
 Smoothly moves the camera from the current position to the one specified by the user. More...
 
void SmoothTransition (HPS.CameraKit in_camera_kit)
 Smoothly moves the camera from the current position to the one specified by the user. More...
 
HPS.Key[] GetNavigationKeys ()
 Gets an array of Keys associated with the Axis Triad and Navigation Cube for this View More...
 
HPS.Layout[] GetOwningLayouts ()
 Returns an array containing the Layouts this View is included in. More...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object that)
 
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...
 
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 

Static Public Member Functions

static bool operator== (HPS.View a, HPS.View b)
 
static bool operator!= (HPS.View a, HPS.View b)
 
static string GetHideStyleName ()
 
static string GetShowStyleName ()
 
- 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

- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 The type of update to perform, either synchronous or asynchronous. More...
 
- Protected Attributes inherited from HPS.Object
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

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

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
HPS.View HPS.View.ComputeFitWorldCamera ( out HPS.CameraKit  out_camera)
inline

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

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.
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.
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.
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.
void HPS.View.Delete ( )
inline

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

void HPS.View.DetachModel ( )
inline

Detaches the Model from this View

HPS.View HPS.View.FitWorld ( )
inline

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

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

This method automatically adjusts the camera to fit the extents of a segment.

Parameters
in_segmentThe segment used to calculate the new camera.
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.
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.

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.
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.
HPS.Model HPS.View.GetAttachedModel ( )
inline

Returns the Model that is attached to this View

HPS.IncludeKey HPS.View.GetAttachedModelIncludeLink ( )
inline

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

HPS.AxisTriadControl HPS.View.GetAxisTriadControl ( )
inline

Gets the AxisTriadControl that is associated with this View.

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.

string HPS.View.GetName ( )
inline

Get the name used when creating this View.

HPS.NavigationCubeControl HPS.View.GetNavigationCubeControl ( )
inline

Gets the NavigationCubeControl that is associated with this View.

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

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

HPS.OperatorControl HPS.View.GetOperatorControl ( )
inline

Gets the OperatorControl that is associated with this View.

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

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

HPS.PortfolioKey HPS.View.GetPortfolioKey ( )
inline

Returns the HPS::PortfolioKey associated with this View.

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.

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.

bool HPS.View.GetSimpleReflection ( )
inline

Returns the status of the simple reflection

bool HPS.View.GetSimpleShadow ( )
inline

Returns the status of the simple shadows

override HPS.Type HPS.View.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

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

Programming Guide section 1.1.3.

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%.
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
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%.
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
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.
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
void HPS.View.Update ( HPS.Sprocket.UpdateType  in_update_type)
inline

Redraws the Model in this View.

void HPS.View.Update ( )
inline

Redraws the Model in this View.

void HPS.View.Update ( HPS.Window.UpdateControl  in_control,
double  time_limit 
)
inline

Redraws the Model in this View using parameters that you specify.

Parameters
in_controlone of the enum values specified by HPS::Window::UpdateControl
time_limitthe maximum amount of time, in seconds, to spend updating this View
void HPS.View.Update ( HPS.Window.UpdateControl  in_control)
inline

Redraws the Model in this View using parameters that you specify.

Parameters
in_controlone of the enum values specified by HPS::Window::UpdateControl

The documentation for this class was generated from the following file: