API Search || Global Search

More...

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

Public Member Functions

void Assign (HPS.Model in_that)
 
void Delete ()
 Deletes this Model. More...
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Model in_that)
 
HPS.Vector GetFrontVector ()
 Returns an HPS.Vector pointing in the direction of the front of this Model. More...
 
override int GetHashCode ()
 
HPS.SegmentKey GetLibraryKey ()
 Returns the HPS.LibraryKey associated with this HPS.Model. More...
 
string GetName ()
 Get the name used when creating this Model. More...
 
HPS.View[] GetOwningViews ()
 Returns an array containing the Views this Model is included in. More...
 
HPS.PortfolioKey GetPortfolioKey ()
 Returns the HPS.PortfolioKey associated with this Model's HPS.SegmentKey. 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 HPS.Model. More...
 
HPS.Vector GetUpVector ()
 Returns an HPS.Vector pointing in the direction of the top of this Model. More...
 
 Model (HPS.Model that)
 
override HPS.Type ObjectType ()
 
void SetOrientation (HPS.Vector in_up_vector, HPS.Vector in_front_vector)
 Sets the Model orientation More...
 
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. More...
 
void Update ()
 Redraws the Model and all Views it appears in, including all of its child components. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
- Public Member Functions inherited from HPS.Sprocket
override void Dispose ()
 
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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 bool operator!= (HPS.Model a, HPS.Model b)
 
static bool operator== (HPS.Model a, HPS.Model 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.Sprocket
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 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.

Member Function Documentation

void HPS.Model.Delete ( )
inline

Deletes this Model.

HPS.Vector HPS.Model.GetFrontVector ( )
inline

Returns an HPS.Vector pointing in the direction of the front of this Model.

HPS.SegmentKey HPS.Model.GetLibraryKey ( )
inline

Returns the HPS.LibraryKey associated with this HPS.Model.

string HPS.Model.GetName ( )
inline

Get the name used when creating this Model.

HPS.View [] HPS.Model.GetOwningViews ( )
inline

Returns an array containing the Views this Model is included in.

HPS.PortfolioKey HPS.Model.GetPortfolioKey ( )
inline

Returns the HPS.PortfolioKey associated with this Model's HPS.SegmentKey.

HPS.SegmentKey HPS.Model.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 HPS.Model.

HPS.Vector HPS.Model.GetUpVector ( )
inline

Returns an HPS.Vector pointing in the direction of the top of this Model.

void HPS.Model.SetOrientation ( HPS.Vector  in_up_vector,
HPS.Vector  in_front_vector 
)
inline

Sets the Model orientation

Parameters
in_up_vectorthe vector describing the direction of the top of this Model.
in_front_vectorthe vector pointing in the direction of the front of this Model.
bool HPS.Model.ShowOrientation ( out HPS.Vector  out_up_vector,
out HPS.Vector  out_front_vector 
)
inline

Returns the vectors describing the up and front directions of this Model.

void HPS.Model.Update ( )
inline

Redraws the Model and all Views it appears in, including all of its child components.

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

Redraws the Model and all Views 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.
void HPS.Model.Update ( HPS.Window.UpdateType  in_type)
inline

Redraws the Model and all Views 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
HPS.UpdateNotifier HPS.Model.UpdateWithNotifier ( )
inline

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.

Returns
An UpdateNotifier object that can be used to find out information about the update.
HPS.UpdateNotifier HPS.Model.UpdateWithNotifier ( HPS.Window.UpdateType  in_type,
double  in_time_limit 
)
inline

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.

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 that can be used to find out information about the update.
HPS.UpdateNotifier HPS.Model.UpdateWithNotifier ( HPS.Window.UpdateType  in_type)
inline

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.

Parameters
in_typeone 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.Model.cs