
Public Member Functions | |
void | Assign (HPS.View in_that) |
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... | |
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. If the View has a Model attached, the Model will not be destroyed. 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. The include key links the View with the Model. 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. This segment can be used to change attributes affecting the whole model, without affecting the static tree set at the model level. 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 HPS.PortfolioKey associated with this View. 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... | |
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... | |
bool | GetSimpleReflection () |
Returns the status of the simple reflection More... | |
bool | GetSimpleShadow () |
Returns the status of the simple shadows More... | |
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 | SetOperator (HPS.Operator in_operator) |
Makes an operator active on this View. Assumes control of the memory of the operator. 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. A rendering modes enable things like "hidden line" rendering or a particular lighting interpolation algorithm. 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) |
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... | |
void | Update () |
Redraws the View and all Layouts it appears in, including all of its child components. More... | |
void | Update (HPS.Window.UpdateType in_type, double in_time_limit) |
Redraws the View and all Layouts it appears in, including all of its child components using the specified parameters. More... | |
void | Update (HPS.Window.UpdateType in_type) |
Redraws the View and all Layouts it appears in, including all of its child components using the specified parameters. More... | |
HPS.UpdateNotifier | UpdateWithNotifier () |
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. More... | |
HPS.UpdateNotifier | UpdateWithNotifier (HPS.Window.UpdateType in_type, double in_time_limit) |
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. More... | |
HPS.UpdateNotifier | UpdateWithNotifier (HPS.Window.UpdateType in_type) |
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. 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. 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... | |
virtual 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... | |
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 | |
![]() | |
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
|
inline |
|
inline |
This method computes a camera to fit the extents of the scene.
- Parameters
-
out_camera The camera computed by the fit world routine.
|
inline |
This method computes a camera to fit the extents of a segment.
- Parameters
-
in_segment The segment used to calculate the new camera. out_camera The camera computed by the fit world routine.
|
inline |
This method computes a camera to fit a bounding.
- Parameters
-
in_bounding The bounding used to calculate the new camera. out_camera The camera computed by the fit world routine.
|
inline |
This method computes a camera to fit the extents of a segment.
- Parameters
-
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. out_camera The camera computed by the fit world routine.
|
inline |
This method computes a camera to fit a bounding.
- Parameters
-
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. out_camera The camera computed by the fit world routine.
|
inline |
|
inline |
This method automatically adjusts the camera to fit the extents of the scene.
|
inline |
This method automatically adjusts the camera to fit the extents of a segment.
- Parameters
-
in_segment The segment used to calculate the new camera.
|
inline |
This method automatically adjusts the camera to fit a bounding.
- Parameters
-
in_bounding The bounding used to calculate the new camera.
|
inline |
This method automatically adjusts the camera to fit the extents of a segment.
- Parameters
-
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.
|
inline |
This method automatically adjusts the camera to fit a bounding.
- Parameters
-
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.
|
inline |
Returns the IncludeKey associated with this View. The include key links the View with the Model.
|
inline |
Gets the AxisTriadControl that is associated with this View.
|
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.
|
inline |
Get the name used when creating this View.
|
inline |
Gets the NavigationCubeControl that is associated with this View.
|
inline |
Gets an array of Keys associated with the Axis Triad and Navigation Cube for this View
|
inline |
Gets the OperatorControl that is associated with this View.
|
inline |
Returns an array containing the Layouts this View is included in.
|
inline |
Returns the HPS.PortfolioKey associated with this View.
|
inline |
Gets the rendering mode for this View. A rendering modes enable things like "hidden line" rendering or a particular lighting interpolation algorithm.
|
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.
|
inline |
Returns the status of the simple reflection
|
inline |
Returns the status of the simple shadows
|
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.
|
inline |
|
inline |
|
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.
|
inline |
Turns simple reflection on or off, automatically calculating reflection plane and light direction
- Parameters
-
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%.
|
inline |
Turns simple reflection on or off, automatically calculating reflection plane and light direction
- Parameters
-
in_state controls whether simple reflection is on or off
|
inline |
Turns simple shadows on or off, automatically calculating shadow plane and light direction
- Parameters
-
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%.
|
inline |
Turns simple shadows on or off, automatically calculating shadow plane and light direction
- Parameters
-
in_state controls whether simple shadows are on or off
|
inline |
Smoothly moves the camera from the current position to the one specified by the user.
- Parameters
-
in_camera_kit a camera kit describing the destination camera in_duration the duration of the animation, specified in seconds. Defaults to 0.5 seconds.
|
inline |
Smoothly moves the camera from the current position to the one specified by the user.
- Parameters
-
in_camera_kit a camera kit describing the destination camera
|
inline |
Redraws the View and all Layouts it appears in, including all of its child components.
|
inline |
Redraws the View and all Layouts it appears in, including all of its child components using the specified parameters.
- Parameters
-
in_type one of the enum values specified by HPS.Window.UpdateType in_time_limit the maximum amount of time, in seconds, to spend updating.
|
inline |
Redraws the View and all Layouts it appears in, including all of its child components using the specified parameters.
- Parameters
-
in_type one of the enum values specified by HPS.Window.UpdateType
|
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 that can be used to find out information about the update.
|
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_type one of the enum values specified by HPS.Window.UpdateType in_time_limit the maximum amount of time, in seconds, to spend updating this HPS.Canvas
- Returns
- An UpdateNotifier object that can be used to find out information about the update.
|
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_type one of the enum values specified by HPS.Window.UpdateType
- Returns
- An UpdateNotifier object that can be 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