REFERENCE MANUAL
The Canvas class is one of the four core display classes used in a Visualize application. More...
Public Member Functions | |
void | Assign (HPS.Canvas in_that) |
void | AttachLayout (HPS.Layout in_layout) |
Attaches a layout to this Canvas. More... | |
void | AttachViewAsLayout (HPS.View in_view) |
Attaches a View to this Canvas using an implicit Layout that convers the whole window. More... | |
Canvas (HPS.Canvas that) | |
void | Delete () |
Deletes this Canvas, and the Window that backs it. 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 Canvas. More... | |
HPS.View | GetFrontView () |
Views can overlap. More... | |
override int | GetHashCode () |
string | GetName () |
Get the name used when creating this Canvas. More... | |
HPS.PortfolioKey | GetPortfolioKey () |
Returns the PortfolioKey associated with this Canvas' SegmentKey. More... | |
HPS.WindowKey | GetWindowKey () |
Each of the four display hierarchy objects (Canvas, Layout, View, Model) are backed by a SegmentKey. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | SetFrameRate (float in_frame_rate) |
Sets the maximum frame rate for this Canvas in number of frames per second. More... | |
void | SetFrameRate () |
Sets the maximum frame rate for this Canvas in number of frames per second. More... | |
void | Update (HPS.Sprocket.UpdateType in_update_type) |
Redraws the entire Canvas, including all of its child components. More... | |
void | Update () |
Redraws the entire Canvas, including all of its child components. More... | |
void | Update (HPS.Window.UpdateControl in_control, double time_limit) |
Redraws the entire Canvas, including all of its child components using the specified parameters. More... | |
void | Update (HPS.Window.UpdateControl in_control) |
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, and also returns an UpdateNotifier to facilitate tracking the update progress. More... | |
HPS.UpdateNotifier | UpdateWithNotifier (HPS.Window.UpdateControl in_control, double time_limit) |
Redraws the entire Canvas, including all of its child components using the specified parameters, and also returns an UpdateNotifier to facilitate tracking the update progress. More... | |
HPS.UpdateNotifier | UpdateWithNotifier (HPS.Window.UpdateControl in_control) |
Redraws the entire Canvas, including all of its child components using the specified parameters, and also returns an UpdateNotifier to facilitate tracking the update progress. 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. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. 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 | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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 WindowKey.
void HPS.Canvas.AttachLayout | ( | HPS.Layout | in_layout | ) |
void HPS.Canvas.AttachViewAsLayout | ( | HPS.View | in_view | ) |
void HPS.Canvas.Delete | ( | ) |
HPS.Layout HPS.Canvas.GetAttachedLayout | ( | ) |
HPS.IncludeKey HPS.Canvas.GetAttachedLayoutIncludeLink | ( | ) |
Returns the IncludeKey that attaches the current layout to this Canvas.
float HPS.Canvas.GetFrameRate | ( | ) |
Returns true if frame rate is active for this Canvas.
HPS.View HPS.Canvas.GetFrontView | ( | ) |
Views can overlap.
This function returns a reference to the frontmost View.
string HPS.Canvas.GetName | ( | ) |
Get the name used when creating this Canvas.
HPS.PortfolioKey HPS.Canvas.GetPortfolioKey | ( | ) |
Returns the PortfolioKey associated with this Canvas' SegmentKey.
HPS.WindowKey HPS.Canvas.GetWindowKey | ( | ) |
Each of the four display hierarchy objects (Canvas, Layout, View, Model) are backed by a SegmentKey.
This function returns the SegmentKey that is associated with this Canvas.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.Canvas.SetFrameRate | ( | float | in_frame_rate | ) |
Sets the maximum frame rate for this Canvas in number of frames per second.
in_frame_rate | Frame rate in number of frames per second. Pass 0 to disable frame rate. |
void HPS.Canvas.SetFrameRate | ( | ) |
Sets the maximum frame rate for this Canvas in number of frames per second.
void HPS.Canvas.Update | ( | HPS.Sprocket.UpdateType | in_update_type | ) |
Redraws the entire Canvas, including all of its child components.
void HPS.Canvas.Update | ( | ) |
Redraws the entire Canvas, including all of its child components.
void HPS.Canvas.Update | ( | HPS.Window.UpdateControl | in_control, |
double | time_limit | ||
) |
Redraws the entire Canvas, including all of its child components using the specified parameters.
in_control | one of the enum values specified by Window::UpdateControl |
time_limit | the maximum amount of time, in seconds, to spend updating this <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> |
void HPS.Canvas.Update | ( | HPS.Window.UpdateControl | in_control | ) |
Redraws the entire Canvas, including all of its child components using the specified parameters.
in_control | one of the enum values specified by Window::UpdateControl |
HPS.UpdateNotifier HPS.Canvas.UpdateWithNotifier | ( | ) |
Redraws the entire Canvas, including all of its child components, and also returns an UpdateNotifier to facilitate tracking the update progress.
HPS.UpdateNotifier HPS.Canvas.UpdateWithNotifier | ( | HPS.Window.UpdateControl | in_control, |
double | time_limit | ||
) |
Redraws the entire Canvas, including all of its child components using the specified parameters, and also returns an UpdateNotifier to facilitate tracking the update progress.
in_control | one of the enum values specified by Window::UpdateControl |
time_limit | the maximum amount of time, in seconds, to spend updating this <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> |
HPS.UpdateNotifier HPS.Canvas.UpdateWithNotifier | ( | HPS.Window.UpdateControl | in_control | ) |
Redraws the entire Canvas, including all of its child components using the specified parameters, and also returns an UpdateNotifier to facilitate tracking the update progress.
in_control | one of the enum values specified by Window::UpdateControl |