HPS::Model Class Reference

#include <sprk.h>

Inheritance diagram for HPS::Model:

Public Member Functions
void	Assign (Model const &in_that)
Animation	CreateAnimation (const char *in_name)
void	Delete ()
bool	Equals (Model const &in_that) const
AnimationArray const &	GetAnimations ()
HPS::Vector	GetFrontVector ()
HPS::Vector const	GetFrontVector () const
SegmentKey	GetLibraryKey ()
SegmentKey const	GetLibraryKey () const
UTF8	GetName () const
HPS::ViewArray	GetOwningViews ()
HPS::ViewArray const	GetOwningViews () const
PortfolioKey	GetPortfolioKey ()
PortfolioKey const	GetPortfolioKey () const
SegmentKey	GetSegmentKey ()
SegmentKey const	GetSegmentKey () const
HPS::Vector	GetUpVector ()
HPS::Vector const	GetUpVector () const
	Model (Model const &that)
HPS::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 (HPS::Vector const &in_up_vector, HPS::Vector const &in_front_vector)
bool	ShowOrientation (HPS::Vector &out_up_vector, HPS::Vector &out_front_vector) const
void	Update () const
void	Update (HPS::Window::UpdateType in_type, HPS::Time in_time_limit=-1.0) const
UpdateNotifier	UpdateWithNotifier () const
UpdateNotifier	UpdateWithNotifier (HPS::Window::UpdateType in_type, HPS::Time in_time_limit=-1.0) const
Public Member Functions inherited from HPS::Sprocket
	Sprocket (Sprocket &&in_that)
Public Member Functions inherited from HPS::Object
virtual bool	Empty () const
intptr_t	GetClassID () const
intptr_t	GetInstanceID () const
bool	HasType (HPS::Type in_mask) const
	Object (Object const &that)
	Object (Object &&in_that)
Object &	operator= (Object const &other_object)
Object &	operator= (Object &&in_that)
virtual void	Reset ()
virtual HPS::Type	Type () const

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::Model
Static Public Attributes inherited from HPS::Object
static const HPS::Type	staticType = HPS::Type::None

Additional Inherited Members
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

Delete()

void HPS::Model::Delete

(

)

Deletes this Model.

GetAnimations()

AnimationArray const& HPS::Model::GetAnimations

(

)

Get a list of all active Animations (i.e. Animations that have been created and not deleted)

Returns

A list of active Animations.

GetFrontVector()

HPS::Vector HPS::Model::GetFrontVector

(

)

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

GetLibraryKey()

SegmentKey HPS::Model::GetLibraryKey

(

)

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

GetName()

UTF8 HPS::Model::GetName

(

)

const

Get the name used when creating this Model.

GetOwningViews()

HPS::ViewArray HPS::Model::GetOwningViews

(

)

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

GetPortfolioKey()

PortfolioKey HPS::Model::GetPortfolioKey

(

)

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

GetSegmentKey()

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.

GetUpVector()

HPS::Vector HPS::Model::GetUpVector

(

)

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

ObjectType()

HPS::Type HPS::Model::ObjectType ( ) const

inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns

The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS::Object.

SetOrientation()

void HPS::Model::SetOrientation	(	HPS::Vector const &	in_up_vector,
		HPS::Vector const &	in_front_vector
	)

Sets the Model orientation

Parameters

in_up_vector	the vector describing the direction of the top of this Model.
in_front_vector	the vector pointing in the direction of the front of this Model.

ShowOrientation()

bool HPS::Model::ShowOrientation	(	HPS::Vector &	out_up_vector,
		HPS::Vector &	out_front_vector
	)		const

Returns the vectors describing the up and front directions of this Model.

Update() [1/2]

void HPS::Model::Update

(

)

const

Redraws the Model and all Views it appears in, including all of its child components.

Update() [2/2]

void HPS::Model::Update	(	HPS::Window::UpdateType	in_type,
		HPS::Time	in_time_limit = -1.0
	)		const

Redraws the Model and all Views it appears in, including all of its child components using the specified parameters.

Parameters

in_type	one of the enum values specified by HPS::Window::UpdateType
in_time_limit	the maximum amount of time, in seconds, to spend updating.

UpdateWithNotifier() [1/2]

UpdateNotifier HPS::Model::UpdateWithNotifier

(

)

const

Redraws the Model and all Views it appears in, including all of its child components using the default options, and also returns a notifier to facilitate tracking the update progress.

Returns

An UpdateNotifier object used to find out information about the update.

UpdateWithNotifier() [2/2]

UpdateNotifier HPS::Model::UpdateWithNotifier	(	HPS::Window::UpdateType	in_type,
		HPS::Time	in_time_limit = -1.0
	)		const

Redraws the Model and all Views it appears in, including all of its child components using the specified, and also returns a notifier to facilitate tracking the update progress.

Returns

HPS::UpdateNotifier to facilitate tracking the update progress.

Parameters

in_type	one of the enum values specified by HPS::Window::UpdateType
in_time_limit	the maximum amount of time, in seconds, to spend updating this HPS::Canvas

Returns

An UpdateNotifier object used to find out information about the update.

---

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

• include/sprk.h