#include <sprk.h>
|
static const HPS::Type | staticType = HPS::Type::Model |
|
static const HPS::Type | staticType = HPS::Type::None |
|
|
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.
◆ Delete()
void HPS::Model::Delete |
( |
| ) |
|
◆ GetFrontVector()
Returns an HPS::Vector pointing in the direction of the front of this 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()
◆ GetSegmentKey()
◆ 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()
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()
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]
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]
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 that can be used to find out information about the update.
◆ UpdateWithNotifier() [2/2]
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
-
- Returns
- An UpdateNotifier object that can be used to find out information about the update.
The documentation for this class was generated from the following file: