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. More...

Public Member Functions | |
void | Assign (HPS.Canvas in_that) |
void | AttachLayout (HPS.Layout in_layout) |
Attaches a layout to this HPS.Canvas. There can only be one layout per HPS.Canvas. If a Layout is already attached to this Canvas, the new Layout will replace the old one. More... | |
void | AttachViewAsLayout (HPS.View in_view) |
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. More... | |
Canvas (HPS.Canvas that) | |
void | Delete () |
Deletes this Canvas, and the Window that backs it. If the Canvas has Layouts attached, they are not destroyed. More... | |
void | DetachLayout () |
Detaches the Layout from this Canvas. More... | |
override void | Dispose () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Canvas in_that) |
HPS.Layout | GetAttachedLayout () |
Returns the Layout that is currently attached to this Canvas. More... | |
HPS.IncludeKey | GetAttachedLayoutIncludeLink () |
Returns the IncludeKey that attaches the current layout to this Canvas. More... | |
float | GetFrameRate () |
Returns true if frame rate is active for this HPS.Canvas. More... | |
HPS.View | GetFrontView () |
Views can overlap. This function returns a reference to the frontmost View. More... | |
override int | GetHashCode () |
string | GetName () |
Get the name used when creating this Canvas. More... | |
HPS.PortfolioKey | GetPortfolioKey () |
Returns the HPS.PortfolioKey associated with this Canvas' SegmentKey. More... | |
HPS.WindowKey | GetWindowKey () |
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 Canvas. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | SetFrameRate (float in_frame_rate) |
Sets the minimum frame rate for this HPS.Canvas in number of frames per second. More... | |
void | SetFrameRate () |
Sets the minimum frame rate for this HPS.Canvas in number of frames per second. More... | |
void | Update () |
Redraws the entire Canvas, including all of its child components using the default options. More... | |
void | Update (HPS.Window.UpdateType in_type, double in_time_limit) |
Redraws the entire Canvas, including all of its child components using the specified parameters. More... | |
void | Update (HPS.Window.UpdateType in_type) |
Redraws the entire Canvas, including all of its child components using the specified parameters. More... | |
HPS.UpdateNotifier | UpdateWithNotifier () |
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. More... | |
HPS.UpdateNotifier | UpdateWithNotifier (HPS.Window.UpdateType in_type, double in_time_limit) |
Redraws the entire Canvas, including all of its child components using the specified parameters, and also returns an More... | |
HPS.UpdateNotifier | UpdateWithNotifier (HPS.Window.UpdateType in_type) |
Redraws the entire Canvas, including all of its child components using the specified parameters, and also returns an More... | |
![]() | |
override void | Dispose () |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.Canvas a, HPS.Canvas b) |
static bool | operator== (HPS.Canvas a, HPS.Canvas b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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.
Member Function Documentation
|
inline |
Attaches a layout to this HPS.Canvas. There can only be one layout per HPS.Canvas. If a Layout is already attached to this Canvas, the new Layout will replace the old one.
- Parameters
-
in_layout the Layout to attach to this HPS.Canvas.
|
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
-
in_view the View to attach to this HPS.Canvas.
|
inline |
|
inline |
|
inline |
Returns the IncludeKey that attaches the current layout to this Canvas.
|
inline |
Returns true if frame rate is active for this HPS.Canvas.
- Returns
- Returns frame rate in number of frames per second.
|
inline |
Views can overlap. This function returns a reference to the frontmost View.
|
inline |
Get the name used when creating this Canvas.
|
inline |
Returns the HPS.PortfolioKey associated with this Canvas' SegmentKey.
|
inline |
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 Canvas.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
|
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.
|
inline |
Sets the minimum frame rate for this HPS.Canvas in number of frames per second.
|
inline |
Redraws the entire Canvas, including all of its child components using the default options.
|
inline |
Redraws the entire Canvas, 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 this HPS.Canvas
|
inline |
Redraws the entire Canvas, including all of its child components using the specified parameters.
- Parameters
-
in_type one of the enum values specified by HPS.Window.UpdateType
|
inline |
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.
|
inline |
Redraws the entire Canvas, including all of its child components using the specified parameters, and also returns an
- 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 that can be used to find out information about the update.
|
inline |
Redraws the entire Canvas, including all of its child components using the specified parameters, and also returns an
- Parameters
-
in_type one of the enum values specified by HPS.Window.UpdateType
- 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