Public Member Functions | List of all members
HPS::Model Class Reference

#include <sprk.h>

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

Public Member Functions

 Model (Model const &that)
 
HPS::Type ObjectType () const
 
void Delete ()
 
Modeloperator= (Model const &in_that)
 
void Assign (Model const &in_that)
 
bool Equals (Model const &in_that) const
 
bool operator!= (Model const &in_that) const
 
bool operator== (Model const &in_that) const
 
UTF8 GetName () const
 
SegmentKey GetSegmentKey ()
 
SegmentKey const GetSegmentKey () const
 
SegmentKey GetLibraryKey ()
 
SegmentKey const GetLibraryKey () const
 
PortfolioKey GetPortfolioKey ()
 
PortfolioKey const GetPortfolioKey () const
 
HPS::Vector GetUpVector ()
 
HPS::Vector const GetUpVector () const
 
HPS::Vector GetFrontVector ()
 
HPS::Vector const GetFrontVector () const
 
HPS::ViewArray GetOwningViews ()
 
HPS::ViewArray const GetOwningViews () const
 
void SetOrientation (HPS::Vector &in_up_vector, HPS::Vector &in_front_vector)
 
bool ShowOrientation (HPS::Vector &out_up_vector, HPS::Vector &out_front_vector)
 
void Update (HPS::Sprocket::UpdateType in_update_type=Sprocket::UpdateType::Asynchronous) const
 
void Update (HPS::Window::UpdateControl const in_control, HPS::Time const time_limit=-1.) const
 
- Public Member Functions inherited from HPS::Sprocket
 Sprocket (HPS::Sprocket const &in_that)=default
 
 Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
 Object (Object const &that)
 
Objectoperator= (Object const &other_object)
 
 Object (Object &&in_that)
 
Objectoperator= (Object &&in_that)
 
HPS::Type Type () const
 
virtual bool Empty () const
 
virtual void Reset ()
 
bool HasType (HPS::Type in_mask) const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 

Additional Inherited Members

- Public Types inherited from HPS::Sprocket
enum  UpdateType { Synchronous, Asynchronous }
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

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

Deletes this Model.

HPS::Vector HPS::Model::GetFrontVector ( )

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

SegmentKey HPS::Model::GetLibraryKey ( )

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

UTF8 HPS::Model::GetName ( ) const

Get the name used when creating this Model.

HPS::ViewArray HPS::Model::GetOwningViews ( )

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

PortfolioKey HPS::Model::GetPortfolioKey ( )

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

SegmentKey HPS::Model::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 HPS::Model::GetUpVector ( )

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

HPS::Type HPS::Model::ObjectType ( ) const
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 
)

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 ( HPS::Vector out_up_vector,
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 = Sprocket::UpdateType::Asynchronous) const

Redraws this Model.

void HPS::Model::Update ( HPS::Window::UpdateControl const  in_control,
HPS::Time const  time_limit = -1. 
) const

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

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