HPS.Model
- class HPS.Model : public HPS.Sprocket
The Model 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 View objects. The parent of the Model is the View. The Model is meant to represent a segment which contains a geometric model. Like the other three core objects, the Model is backed by a HPS.SegmentKey.
Public Functions
- HPS.Animation[] GetAnimations ()
Get a list of all active Animations (i.e. Animations that have been created and not deleted)
- Return
A list of active Animations.
- HPS.Vector GetFrontVector ()
Returns an HPS.Vector pointing in the direction of the front of this Model.
- HPS.SegmentKey GetLibraryKey ()
Returns the HPS.LibraryKey associated with this HPS.Model.
- HPS.PortfolioKey GetPortfolioKey ()
Returns the HPS.PortfolioKey associated with this Model’s HPS.SegmentKey.
- 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 HPS.Model.
- HPS.Vector GetUpVector ()
Returns an HPS.Vector pointing in the direction of the top of this Model.
- override HPS.Type ObjectType ()
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).
- Return
The declared type of the object in question, which may differ from the true, underlying type.
- void SetOrientation (HPS.Vector in_up_vector, HPS.Vector in_front_vector)
Sets the Model orientation
- bool ShowOrientation (out HPS.Vector out_up_vector, out HPS.Vector out_front_vector)
Returns the vectors describing the up and front directions of this Model.
- void Update ()
Redraws the Model and all Views it appears in, including all of its child components.
- void Update (HPS.Window.UpdateType in_type)
Redraws the Model and all Views it appears in, including all of its child components using the specified parameters.
- Param in_type
one of the enum values specified by HPS.Window.UpdateType
- void Update (HPS.Window.UpdateType in_type, double in_time_limit)
Redraws the Model and all Views it appears in, including all of its child components using the specified parameters.
- Param in_type
one of the enum values specified by HPS.Window.UpdateType
- Param in_time_limit
the maximum amount of time, in seconds, to spend updating.
- HPS.UpdateNotifier UpdateWithNotifier ()
Redraws the Model and all Views it appears in, including all of its child components using the default options, and also returns a notifier to facilitate tracking the update progress.
- Return
An UpdateNotifier object used to find out information about the update.
- HPS.UpdateNotifier UpdateWithNotifier (HPS.Window.UpdateType in_type)
Redraws the Model and all Views it appears in, including all of its child components using the specified, and also returns a notifier to facilitate tracking the update progress.
- Param in_type
one of the enum values specified by HPS.Window.UpdateType
- Return
An UpdateNotifier object used to find out information about the update.
- HPS.UpdateNotifier UpdateWithNotifier (HPS.Window.UpdateType in_type, double in_time_limit)
Redraws the Model and all Views it appears in, including all of its child components using the specified, and also returns a notifier to facilitate tracking the update progress.
- Param in_type
one of the enum values specified by HPS.Window.UpdateType
- Param in_time_limit
the maximum amount of time, in seconds, to spend updating this HPS.Canvas
- Return
An UpdateNotifier object used to find out information about the update.