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

Public Member Functions

void Assign (HPS.Model in_that)
 
void Delete ()
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Model in_that)
 
HPS.Vector GetFrontVector ()
 
override int GetHashCode ()
 
HPS.SegmentKey GetLibraryKey ()
 
string GetName ()
 
HPS.View [] GetOwningViews ()
 
HPS.PortfolioKey GetPortfolioKey ()
 
HPS.SegmentKey GetSegmentKey ()
 
HPS.Vector GetUpVector ()
 
 Model (HPS.Model that)
 
override HPS.Type ObjectType ()
 
void SetOrientation (HPS.Vector in_up_vector, HPS.Vector in_front_vector)
 
bool ShowOrientation (out HPS.Vector out_up_vector, out HPS.Vector out_front_vector)
 
void Update ()
 
void Update (HPS.Window.UpdateType in_type, double in_time_limit)
 
void Update (HPS.Window.UpdateType in_type)
 
HPS.UpdateNotifier UpdateWithNotifier ()
 
HPS.UpdateNotifier UpdateWithNotifier (HPS.Window.UpdateType in_type, double in_time_limit)
 
HPS.UpdateNotifier UpdateWithNotifier (HPS.Window.UpdateType in_type)
 
- 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 ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

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

◆ Delete()

void HPS.Model.Delete ( )
inline

Deletes this Model.

◆ GetFrontVector()

HPS.Vector HPS.Model.GetFrontVector ( )
inline

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

◆ GetLibraryKey()

HPS.SegmentKey HPS.Model.GetLibraryKey ( )
inline

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

◆ GetName()

string HPS.Model.GetName ( )
inline

Get the name used when creating this Model.

◆ GetOwningViews()

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

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

◆ GetPortfolioKey()

HPS.PortfolioKey HPS.Model.GetPortfolioKey ( )
inline

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

◆ GetSegmentKey()

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.

◆ GetUpVector()

HPS.Vector HPS.Model.GetUpVector ( )
inline

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

◆ ObjectType()

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

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

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

Reimplemented from HPS.Object.

◆ SetOrientation()

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.

◆ ShowOrientation()

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.

◆ Update() [1/3]

void HPS.Model.Update ( )
inline

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

◆ Update() [2/3]

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.

◆ Update() [3/3]

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

◆ UpdateWithNotifier() [1/3]

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.

◆ UpdateWithNotifier() [2/3]

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.

◆ UpdateWithNotifier() [3/3]

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