REFERENCE MANUAL
The View class is one of the four core display classes used in a Visualize application. More...
Public Member Functions | |
void | Assign (HPS.View in_that) |
void | AttachModel (HPS.Model in_model) |
Attaches a Model to 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... | |
void | Delete () |
Deletes this View. More... | |
void | DetachModel () |
Detaches the Model from this View More... | |
override void | Dispose () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.View in_that) |
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... | |
HPS.Model | GetAttachedModel () |
Returns the Model that is attached to this View More... | |
HPS.IncludeKey | GetAttachedModelIncludeLink () |
Returns the IncludeKey associated with this View. More... | |
HPS.AxisTriadControl | GetAxisTriadControl () |
Gets the AxisTriadControl that is associated with this View. More... | |
override int | GetHashCode () |
HPS.SegmentKey | GetModelOverrideSegmentKey () |
Returns the model override segment. More... | |
string | GetName () |
Get the name used when creating this View. More... | |
HPS.NavigationCubeControl | GetNavigationCubeControl () |
Gets the NavigationCubeControl that is associated with this View. More... | |
HPS.Key[] | GetNavigationKeys () |
Gets an array of Keys associated with the Axis Triad and Navigation Cube for this View More... | |
HPS.OperatorControl | GetOperatorControl () |
Gets the OperatorControl that is associated with this View. More... | |
HPS.Layout[] | GetOwningLayouts () |
Returns an array containing the Layouts this View is included in. More... | |
HPS.PortfolioKey | GetPortfolioKey () |
Returns the PortfolioKey associated with this View. More... | |
HPS.Rendering.Mode | GetRenderingMode () |
Gets the rendering mode for this View. More... | |
HPS.SegmentKey | GetSegmentKey () |
Each of the four display hierarchy objects (Canvas, Layout, View, Model) are backed by a SegmentKey. More... | |
bool | GetSimpleReflection () |
bool | GetSimpleShadow () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | SetOperator (HPS.Operator in_operator) |
Makes an operator active on this View. More... | |
void | SetOperators (HPS.Operator[] in_operators) |
Makes a set of operators active on this View. More... | |
void | SetRenderingMode (HPS.Rendering.Mode in_mode) |
Sets the rendering mode for this View. 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... | |
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... | |
void | SmoothTransition (HPS.CameraKit in_camera_kit, double in_duration) |
void | SmoothTransition (HPS.CameraKit in_camera_kit) |
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... | |
View (HPS.View that) | |
View (HPS.SprocketControl in_ctrl) | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. 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 string | GetHideStyleName () |
static string | GetShowStyleName () |
static bool | operator!= (HPS.View a, HPS.View b) |
static bool | operator== (HPS.View a, HPS.View b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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 SegmentKey.
void HPS.View.AttachModel | ( | HPS.Model | in_model | ) |
HPS.View HPS.View.ComputeFitWorldCamera | ( | out HPS.CameraKit | out_camera | ) |
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 | ||
) |
This method computes a camera to fit the extents of a segment.
in_segment | The segment used to calculate the new camera. |
HPS.View HPS.View.ComputeFitWorldCamera | ( | HPS.BoundingKit | in_bounding, |
out HPS.CameraKit | out_camera | ||
) |
This method computes a camera to fit a bounding.
in_bounding | The 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 | ||
) |
This method computes a camera to fit the extents of a segment.
in_segment | The segment used to calculate the new camera. |
in_transform | An 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 | ||
) |
This method computes a camera to fit a bounding.
in_bounding | The bounding used to calculate the new camera. |
in_transform | An 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 | ( | ) |
HPS.View HPS.View.FitWorld | ( | ) |
This method automatically adjusts the camera to fit the extents of the scene.
HPS.View HPS.View.FitWorld | ( | HPS.SegmentKey | in_segment | ) |
This method automatically adjusts the camera to fit the extents of a segment.
in_segment | The segment used to calculate the new camera. |
HPS.View HPS.View.FitWorld | ( | HPS.BoundingKit | in_bounding | ) |
This method automatically adjusts the camera to fit a bounding.
in_bounding | The bounding used to calculate the new camera. |
HPS.View HPS.View.FitWorld | ( | HPS.SegmentKey | in_segment, |
HPS.MatrixKit | in_transform | ||
) |
This method automatically adjusts the camera to fit the extents of a segment.
in_segment | The segment used to calculate the new camera. |
in_transform | An 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 | ||
) |
This method automatically adjusts the camera to fit a bounding.
in_bounding | The bounding used to calculate the new camera. |
in_transform | An 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.IncludeKey HPS.View.GetAttachedModelIncludeLink | ( | ) |
Returns the IncludeKey associated with this View.
HPS.AxisTriadControl HPS.View.GetAxisTriadControl | ( | ) |
Gets the AxisTriadControl that is associated with this View.
HPS.SegmentKey HPS.View.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.
string HPS.View.GetName | ( | ) |
Get the name used when creating this View.
HPS.NavigationCubeControl HPS.View.GetNavigationCubeControl | ( | ) |
Gets the NavigationCubeControl that is associated with this View.
HPS.Key [] HPS.View.GetNavigationKeys | ( | ) |
Gets an array of Keys associated with the Axis Triad and Navigation Cube for this View
HPS.OperatorControl HPS.View.GetOperatorControl | ( | ) |
Gets the OperatorControl that is associated with this View.
HPS.Layout [] HPS.View.GetOwningLayouts | ( | ) |
Returns an array containing the Layouts this View is included in.
HPS.PortfolioKey HPS.View.GetPortfolioKey | ( | ) |
Returns the PortfolioKey associated with this View.
HPS.Rendering.Mode HPS.View.GetRenderingMode | ( | ) |
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 | ( | ) |
Each of the four display hierarchy objects (Canvas, Layout, View, Model) are backed by a SegmentKey.
This function returns the SegmentKey that is associated with this View.
|
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.
void HPS.View.SetOperator | ( | HPS.Operator | in_operator | ) |
void HPS.View.SetOperators | ( | HPS.Operator[] | in_operators | ) |
void HPS.View.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.
Programming Guide section 1.1.3.
void HPS.View.SetSimpleReflection | ( | bool | in_state, |
float | in_percent_offset | ||
) |
Turns simple reflection on or off, automatically calculating reflection plane and light direction
in_state | controls whether simple reflection is on or off |
in_percent_offset | distance 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 | ) |
Turns simple reflection on or off, automatically calculating reflection plane and light direction
in_state | controls whether simple reflection is on or off |
void HPS.View.SetSimpleShadow | ( | bool | in_state, |
float | in_percent_offset | ||
) |
Turns simple shadows on or off, automatically calculating shadow plane and light direction
in_state | controls whether simple shadows are on or off |
in_percent_offset | distance 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 | ) |
Turns simple shadows on or off, automatically calculating shadow plane and light direction
in_state | controls whether simple shadows are on or off |
void HPS.View.Update | ( | HPS.Window.UpdateControl | in_control, |
double | time_limit | ||
) |
Redraws the Model in this View using parameters that you specify.
in_control | one of the enum values specified by Window::UpdateControl |
time_limit | the maximum amount of time, in seconds, to spend updating this <ref refid="class_h_p_s_1_1_view" kindref="compound">View</ref> |
void HPS.View.Update | ( | HPS.Window.UpdateControl | in_control | ) |
Redraws the Model in this View using parameters that you specify.
in_control | one of the enum values specified by Window::UpdateControl |