|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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 |
( |
HPS.Layout |
in_layout | ) |
|
|
inline |
◆ AttachViewAsLayout()
void HPS.Canvas.AttachViewAsLayout |
( |
HPS.View |
in_view | ) |
|
|
inline |
Attaches a View to this HPS.Canvas using an implicit Layout that convers the whole window. If a Layout is already attached to this Canvas, the new Layout will replace the old one.
- Parameters
-
◆ Delete()
void HPS.Canvas.Delete |
( |
| ) |
|
|
inline |
Deletes this Canvas, and the Window that backs it. If the Canvas has Layouts attached, they are not destroyed.
◆ DetachLayout()
void HPS.Canvas.DetachLayout |
( |
| ) |
|
|
inline |
◆ GetAttachedLayout()
Returns the Layout that is currently attached to this Canvas.
◆ GetAttachedLayoutIncludeLink()
◆ GetFrameRate()
float HPS.Canvas.GetFrameRate |
( |
| ) |
|
|
inline |
Returns true if frame rate is active for this HPS.Canvas.
- Returns
- Returns frame rate in number of frames per second.
◆ GetFrontView()
Views can overlap. This function returns a reference to the frontmost View.
◆ GetName()
string HPS.Canvas.GetName |
( |
| ) |
|
|
inline |
Get the name used when creating this Canvas.
◆ GetPortfolioKey()
◆ GetWindowKey()
◆ ObjectType()
override HPS.Type HPS.Canvas.ObjectType |
( |
| ) |
|
|
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() [1/2]
void HPS.Canvas.SetFrameRate |
( |
float |
in_frame_rate | ) |
|
|
inline |
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. |
◆ SetFrameRate() [2/2]
void HPS.Canvas.SetFrameRate |
( |
| ) |
|
|
inline |
Sets the minimum frame rate for this HPS.Canvas in number of frames per second.
◆ Update() [1/3]
void HPS.Canvas.Update |
( |
| ) |
|
|
inline |
Redraws the entire Canvas, including all of its child components using the default options.
◆ Update() [2/3]
Redraws the entire Canvas, including all of its child components using the specified parameters.
- Parameters
-
◆ Update() [3/3]
Redraws the entire Canvas, including all of its child components using the specified parameters.
- Parameters
-
◆ UpdateWithNotifier() [1/3]
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/3]
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.
◆ UpdateWithNotifier() [3/3]
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:
- internals/hps_sprk/source/cs/HPS.Canvas.cs