Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.Canvas Class Reference

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

Inheritance diagram for HPS.Canvas:
HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
 Canvas (HPS.Canvas that)
 
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 Delete ()
 Deletes this Canvas, and the Window that backs it. If the Canvas has Layouts attached, they are not destroyed. More...
 
void Assign (HPS.Canvas in_that)
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.Canvas in_that)
 
string GetName ()
 Get the name used when creating this Canvas. More...
 
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...
 
void DetachLayout ()
 Detaches the Layout from this Canvas. More...
 
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...
 
HPS.View GetFrontView ()
 Views can overlap. This function returns a reference to the frontmost View. 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...
 
HPS.PortfolioKey GetPortfolioKey ()
 Returns the HPS::PortfolioKey associated with this Canvas' SegmentKey. 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 HPS::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 HPS::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 HPS::UpdateNotifier to facilitate tracking the update progress. More...
 
void SetFrameRate (float in_frame_rate)
 Sets the maximum frame rate for this HPS::Canvas in number of frames per second. More...
 
void SetFrameRate ()
 Sets the maximum frame rate for this HPS::Canvas in number of frames per second. More...
 
float GetFrameRate ()
 Returns true if frame rate is active for this HPS::Canvas. More...
 
- Public Member Functions inherited from HPS.Sprocket
override void Dispose ()
 
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object that)
 
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...
 
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
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...
 

Static Public Member Functions

static bool operator== (HPS.Canvas a, HPS.Canvas b)
 
static bool operator!= (HPS.Canvas a, HPS.Canvas b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Sprocket
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 The type of update to perform, either synchronous or asynchronous. More...
 
- Protected Attributes inherited from HPS.Object
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

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

void HPS.Canvas.AttachLayout ( HPS.Layout  in_layout)
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_layoutthe Layout to attach to this HPS::Canvas.
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
in_viewthe View to attach to this HPS::Canvas.
void HPS.Canvas.Delete ( )
inline

Deletes this Canvas, and the Window that backs it. If the Canvas has Layouts attached, they are not destroyed.

void HPS.Canvas.DetachLayout ( )
inline

Detaches the Layout from this Canvas.

HPS.Layout HPS.Canvas.GetAttachedLayout ( )
inline

Returns the Layout that is currently attached to this Canvas.

HPS.IncludeKey HPS.Canvas.GetAttachedLayoutIncludeLink ( )
inline

Returns the IncludeKey that attaches the current layout to this Canvas.

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.
HPS.View HPS.Canvas.GetFrontView ( )
inline

Views can overlap. This function returns a reference to the frontmost View.

string HPS.Canvas.GetName ( )
inline

Get the name used when creating this Canvas.

HPS.PortfolioKey HPS.Canvas.GetPortfolioKey ( )
inline

Returns the HPS::PortfolioKey associated with this Canvas' SegmentKey.

HPS.WindowKey HPS.Canvas.GetWindowKey ( )
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.

override HPS.Type HPS.Canvas.ObjectType ( )
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.

void HPS.Canvas.SetFrameRate ( float  in_frame_rate)
inline

Sets the maximum frame rate for this HPS::Canvas in number of frames per second.

Parameters
in_frame_rateFrame rate in number of frames per second. Pass 0 to disable frame rate.
void HPS.Canvas.SetFrameRate ( )
inline

Sets the maximum frame rate for this HPS::Canvas in number of frames per second.

void HPS.Canvas.Update ( HPS.Sprocket.UpdateType  in_update_type)
inline

Redraws the entire Canvas, including all of its child components.

void HPS.Canvas.Update ( )
inline

Redraws the entire Canvas, including all of its child components.

void HPS.Canvas.Update ( HPS.Window.UpdateControl  in_control,
double  time_limit 
)
inline

Redraws the entire Canvas, including all of its child components using the specified parameters.

Parameters
in_controlone of the enum values specified by HPS::Window::UpdateControl
time_limitthe maximum amount of time, in seconds, to spend updating this HPS::Canvas
void HPS.Canvas.Update ( HPS.Window.UpdateControl  in_control)
inline

Redraws the entire Canvas, including all of its child components using the specified parameters.

Parameters
in_controlone of the enum values specified by HPS::Window::UpdateControl
HPS.UpdateNotifier HPS.Canvas.UpdateWithNotifier ( )
inline

Redraws the entire Canvas, including all of its child components, and also returns an HPS::UpdateNotifier to facilitate tracking the update progress.

HPS.UpdateNotifier HPS.Canvas.UpdateWithNotifier ( HPS.Window.UpdateControl  in_control,
double  time_limit 
)
inline

Redraws the entire Canvas, including all of its child components using the specified parameters, and also returns an HPS::UpdateNotifier to facilitate tracking the update progress.

Parameters
in_controlone of the enum values specified by HPS::Window::UpdateControl
time_limitthe maximum amount of time, in seconds, to spend updating this HPS::Canvas
HPS.UpdateNotifier HPS.Canvas.UpdateWithNotifier ( HPS.Window.UpdateControl  in_control)
inline

Redraws the entire Canvas, including all of its child components using the specified parameters, and also returns an HPS::UpdateNotifier to facilitate tracking the update progress.

Parameters
in_controlone of the enum values specified by HPS::Window::UpdateControl

The documentation for this class was generated from the following file: