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

Public Member Functions

void Assign (HPS.Canvas in_that)
 
void AttachLayout (HPS.Layout in_layout)
 
void AttachViewAsLayout (HPS.View in_view)
 
 Canvas (HPS.Canvas that)
 
void Delete ()
 
void DetachLayout ()
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Canvas in_that)
 
HPS.Layout GetAttachedLayout ()
 
HPS.IncludeKey GetAttachedLayoutIncludeLink ()
 
float GetFrameRate ()
 
HPS.View GetFrontView ()
 
override int GetHashCode ()
 
string GetName ()
 
HPS.PortfolioKey GetPortfolioKey ()
 
HPS.WindowKey GetWindowKey ()
 
override HPS.Type ObjectType ()
 
void SetFrameRate (float in_frame_rate)
 
void SetFrameRate ()
 
void Update ()
 
void Update (HPS.Window.UpdateType in_type, double in_time_limit)
 
void Update (HPS.Window.UpdateType in_type)
 
HPS.UpdateNotifier UpdateWithNotifier ()
 
HPS.UpdateNotifier UpdateWithNotifier (HPS.Window.UpdateType in_type, double in_time_limit)
 
HPS.UpdateNotifier UpdateWithNotifier (HPS.Window.UpdateType in_type)
 
- Public Member Functions inherited from HPS.Sprocket
override void Dispose ()
 
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

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

- Protected Attributes inherited from HPS.Object
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

◆ AttachLayout()

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.

◆ 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
in_viewthe View to attach to this HPS.Canvas.

◆ 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

Detaches the Layout from this Canvas.

◆ GetAttachedLayout()

HPS.Layout HPS.Canvas.GetAttachedLayout ( )
inline

Returns the Layout that is currently attached to this Canvas.

◆ GetAttachedLayoutIncludeLink()

HPS.IncludeKey HPS.Canvas.GetAttachedLayoutIncludeLink ( )
inline

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

◆ GetFrameRate()

float HPS.Canvas.GetFrameRate ( )
inline

Returns frame rate as a float value for this HPS.Canvas.

Returns
Returns frame rate in number of frames per second.

◆ GetFrontView()

HPS.View HPS.Canvas.GetFrontView ( )
inline

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()

HPS.PortfolioKey HPS.Canvas.GetPortfolioKey ( )
inline

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

◆ GetWindowKey()

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.

◆ 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_rateFrame 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]

void HPS.Canvas.Update ( HPS.Window.UpdateType  in_type,
double  in_time_limit 
)
inline

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

Parameters
in_typeone of the enum values specified by HPS.Window.UpdateType
in_time_limitthe maximum amount of time, in seconds, to spend updating this HPS.Canvas

◆ Update() [3/3]

void HPS.Canvas.Update ( HPS.Window.UpdateType  in_type)
inline

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

Parameters
in_typeone of the enum values specified by HPS.Window.UpdateType

◆ UpdateWithNotifier() [1/3]

HPS.UpdateNotifier HPS.Canvas.UpdateWithNotifier ( )
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.

◆ UpdateWithNotifier() [2/3]

HPS.UpdateNotifier HPS.Canvas.UpdateWithNotifier ( HPS.Window.UpdateType  in_type,
double  in_time_limit 
)
inline

Redraws the entire Canvas, including all of its child components using the specified parameters, and also returns an

Parameters
in_typeone of the enum values specified by HPS.Window.UpdateType
in_time_limitthe 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.

◆ UpdateWithNotifier() [3/3]

HPS.UpdateNotifier HPS.Canvas.UpdateWithNotifier ( HPS.Window.UpdateType  in_type)
inline

Redraws the entire Canvas, including all of its child components using the specified parameters, and also returns an

Parameters
in_typeone 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