Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.Model Class Reference

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

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

Public Member Functions

override void Dispose ()
 
 Model (HPS.Model that)
 
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 Delete ()
 Deletes this Model. More...
 
void Assign (HPS.Model in_that)
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.Model in_that)
 
string GetName ()
 Get the name used when creating this Model. 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.SegmentKey GetLibraryKey ()
 Returns the HPS::LibraryKey associated with this HPS::Model. More...
 
HPS.PortfolioKey GetPortfolioKey ()
 Returns the HPS::PortfolioKey associated with this Model's HPS::SegmentKey. More...
 
HPS.Vector GetUpVector ()
 Returns an HPS::Vector pointing in the direction of the top of this Model. More...
 
HPS.Vector GetFrontVector ()
 Returns an HPS::Vector pointing in the direction of the front of this Model. More...
 
HPS.View[] GetOwningViews ()
 Returns an array containing the Views this Model is included in. More...
 
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 (HPS.Sprocket.UpdateType in_update_type)
 Redraws this Model. More...
 
void Update ()
 Redraws this Model. More...
 
void Update (HPS.Window.UpdateControl in_control, double time_limit)
 Redraws this Model using parameters that you specify. More...
 
void Update (HPS.Window.UpdateControl in_control)
 Redraws this Model using parameters that you specify. More...
 
- Public Member Functions inherited from HPS.Sprocket
override void Dispose ()
 
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object that)
 
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...
 
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
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...
 

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

- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 The type of update to perform, either synchronous or asynchronous. More...
 
- Protected Attributes inherited from HPS.Object
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

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.

override HPS.Type HPS.Model.ObjectType ( )
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.

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 ( HPS.Sprocket.UpdateType  in_update_type)
inline

Redraws this Model.

void HPS.Model.Update ( )
inline

Redraws this Model.

void HPS.Model.Update ( HPS.Window.UpdateControl  in_control,
double  time_limit 
)
inline

Redraws this Model using parameters that you specify.

Parameters
in_controlone of the enum values specified by HPS::Window::UpdateControl
time_limitthe maximum amount of time, in seconds, to spend updating this Model
void HPS.Model.Update ( HPS.Window.UpdateControl  in_control)
inline

Redraws this Model using parameters that you specify.

Parameters
in_controlone of the enum values specified by HPS::Window::UpdateControl

The documentation for this class was generated from the following file: