REFERENCE MANUAL
#include <sprk.h>
Public Member Functions | |
void | Assign (Model const &in_that) |
void | Delete () |
bool | Equals (Model const &in_that) const |
Vector | GetFrontVector () |
Vector const | GetFrontVector () const |
SegmentKey | GetLibraryKey () |
SegmentKey const | GetLibraryKey () const |
UTF8 | GetName () const |
ViewArray | GetOwningViews () |
ViewArray const | GetOwningViews () const |
PortfolioKey | GetPortfolioKey () |
PortfolioKey const | GetPortfolioKey () const |
SegmentKey | GetSegmentKey () |
SegmentKey const | GetSegmentKey () const |
Vector | GetUpVector () |
Vector const | GetUpVector () const |
Model (Model const &that) | |
Type | ObjectType () const |
bool | operator!= (Model const &in_that) const |
Model & | operator= (Model const &in_that) |
bool | operator== (Model const &in_that) const |
void | SetOrientation (Vector &in_up_vector, Vector &in_front_vector) |
bool | ShowOrientation (Vector &out_up_vector, Vector &out_front_vector) |
void | Update (Sprocket::UpdateType in_update_type=Sprocket::UpdateType::Asynchronous) const |
void | Update (Window::UpdateControl const in_control, Time const time_limit=-1.) const |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () 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 SegmentKey.
void Model::Delete | ( | ) |
Deletes this Model.
Vector Model::GetFrontVector | ( | ) |
Returns an Vector pointing in the direction of the front of this Model.
SegmentKey Model::GetLibraryKey | ( | ) |
Returns the LibraryKey associated with this Model.
ViewArray Model::GetOwningViews | ( | ) |
Returns an array containing the Views this Model is included in.
PortfolioKey Model::GetPortfolioKey | ( | ) |
Returns the PortfolioKey associated with this Model's SegmentKey.
SegmentKey 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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
Returns the vectors describing the up and front directions of this Model.
void Model::Update | ( | Sprocket::UpdateType | in_update_type = Sprocket::UpdateType::Asynchronous | ) | const |
Redraws this Model.
void Model::Update | ( | Window::UpdateControl const | in_control, |
Time const | time_limit = -1. |
||
) | const |
Redraws this Model using parameters that you specify.
in_control | one of the enum values specified by Window::UpdateControl |
time_limit | the maximum amount of time, in seconds, to spend updating this Model |