< Home

< Table of Contents

REFERENCE MANUAL

HPS.Model Class Reference

The Model class is one of the four core display classes used in a Visualize application. 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 Vector pointing in the direction of the front of this Model. More...
 
override int GetHashCode ()
 
HPS.SegmentKey GetLibraryKey ()
 Returns the LibraryKey associated with this 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 PortfolioKey associated with this Model's SegmentKey. More...
 
HPS.SegmentKey GetSegmentKey ()
 Each of the four display hierarchy objects (Canvas, Layout, View, Model) are backed by a SegmentKey. More...
 
HPS.Vector GetUpVector ()
 Returns an Vector pointing in the direction of the top of this Model. More...
 
 Model (HPS.Model that)
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. 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
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. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. 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 }
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

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

Member Function Documentation

void HPS.Model.Delete ( )

Deletes this Model.

HPS.Vector HPS.Model.GetFrontVector ( )

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

HPS.SegmentKey HPS.Model.GetLibraryKey ( )

Returns the LibraryKey associated with this Model.

string HPS.Model.GetName ( )

Get the name used when creating this Model.

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

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

HPS.PortfolioKey HPS.Model.GetPortfolioKey ( )

Returns the PortfolioKey associated with this Model's SegmentKey.

HPS.SegmentKey HPS.Model.GetSegmentKey ( )

Each of the four display hierarchy objects (Canvas, Layout, View, Model) are backed by a SegmentKey.

This function returns the SegmentKey that is associated with this Model.

HPS.Vector HPS.Model.GetUpVector ( )

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

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

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 
)

Sets the Model orientation

Parameters
in_up_vectorthe vector describing the direction of the top of this <ref refid="class_h_p_s_1_1_model" kindref="compound">Model</ref>.
in_front_vectorthe vector pointing in the direction of the front of this <ref refid="class_h_p_s_1_1_model" kindref="compound">Model</ref>.
bool HPS.Model.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 HPS.Model.Update ( HPS.Sprocket.UpdateType  in_update_type)

Redraws this Model.

void HPS.Model.Update ( )

Redraws this Model.

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

Redraws this Model using parameters that you specify.

Parameters
in_controlone of the enum values specified by Window::UpdateControl
time_limitthe maximum amount of time, in seconds, to spend updating this <ref refid="class_h_p_s_1_1_model" kindref="compound">Model</ref>
void HPS.Model.Update ( HPS.Window.UpdateControl  in_control)

Redraws this Model using parameters that you specify.

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

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