#include <sprk.h>
Public Member Functions | |
Model (Model const &that) | |
HPS::Type | ObjectType () const |
void | Delete () |
Model & | operator= (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 |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
Object & | operator= (Object const &other_object) |
Object (Object &&in_that) | |
Object & | operator= (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 | |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
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.
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.
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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::Object.
void HPS::Model::SetOrientation | ( | HPS::Vector & | in_up_vector, |
HPS::Vector & | in_front_vector | ||
) |
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.
in_control | one of the enum values specified by HPS::Window::UpdateControl |
time_limit | the maximum amount of time, in seconds, to spend updating this Model |