#include <sprk.h>
|
static const HPS::Type | staticType = HPS::Type::Canvas |
|
static const HPS::Type | staticType = HPS::Type::None |
|
|
template<typename T > |
static intptr_t | ClassID () |
|
The Canvas 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 Layout, View, and Model objects. The Canvas is the top-level object of the hierarchy and roughly correlates to a window. The Canvas is backed by an HPS::WindowKey.
◆ AttachLayout()
void HPS::Canvas::AttachLayout |
( |
Layout const & |
in_layout | ) |
|
◆ AttachViewAsLayout()
void HPS::Canvas::AttachViewAsLayout |
( |
View const & |
in_view | ) |
|
◆ Delete()
void HPS::Canvas::Delete |
( |
| ) |
|
Deletes this Canvas, and the Window that backs it. If the Canvas has Layouts attached, they are not destroyed.
◆ DetachLayout()
void HPS::Canvas::DetachLayout |
( |
| ) |
|
◆ GetAttachedLayout()
Layout HPS::Canvas::GetAttachedLayout |
( |
| ) |
const |
Returns the Layout that is currently attached to this Canvas.
◆ GetAttachedLayoutIncludeLink()
IncludeKey HPS::Canvas::GetAttachedLayoutIncludeLink |
( |
| ) |
const |
◆ GetFrameRate()
float HPS::Canvas::GetFrameRate |
( |
| ) |
const |
Returns frame rate as a float value for this HPS::Canvas.
- Returns
- Returns frame rate in number of frames per second.
◆ GetFrontView()
View HPS::Canvas::GetFrontView |
( |
| ) |
const |
Views can overlap. This function returns a reference to the frontmost View.
◆ GetName()
UTF8 HPS::Canvas::GetName |
( |
| ) |
const |
Get the name used when creating this Canvas.
◆ GetPortfolioKey()
◆ GetWindowKey()
◆ ObjectType()
HPS::Type HPS::Canvas::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.
◆ SetFrameRate()
void HPS::Canvas::SetFrameRate |
( |
float |
in_frame_rate = 20 | ) |
|
Sets the minimum frame rate for this HPS::Canvas in number of frames per second.
- Parameters
-
in_frame_rate | Frame rate in number of frames per second. Pass 0 to disable frame rate. |
◆ Update() [1/2]
void HPS::Canvas::Update |
( |
| ) |
const |
Redraws the entire Canvas, including all of its child components using the default options.
◆ Update() [2/2]
Redraws the entire Canvas, including all of its child components using the specified parameters.
- Parameters
-
◆ UpdateWithNotifier() [1/2]
Redraws the entire Canvas, 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 entire Canvas, including all of its child components using the specified parameters, and also returns an
- 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: