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

Public Member Functions

void Assign (HPS.Layout in_that)
 
void AttachViewBack (HPS.View in_view, HPS.Rectangle in_position)
 
void AttachViewBack (HPS.View in_view)
 
void AttachViewFront (HPS.View in_view, HPS.Rectangle in_position)
 
void AttachViewFront (HPS.View in_view)
 
void BringToFront (ulong in_layer)
 
void Delete ()
 
void DetachLayer (ulong in_layer)
 
void DetachView (HPS.View in_view)
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Layout in_that)
 
HPS.View GetAttachedView (ulong in_layer)
 
HPS.View GetAttachedView ()
 
HPS.IncludeKey GetAttachedViewIncludeLink (ulong in_layer)
 
HPS.View GetFrontView ()
 
override int GetHashCode ()
 
ulong GetLayerAt (HPS.WindowPoint in_point)
 
ulong GetLayerCount ()
 
HPS.SegmentKey GetLayerSegmentKey (ulong in_layer)
 
string GetName ()
 
HPS.Canvas [] GetOwningCanvases ()
 
HPS.SegmentKey GetSegmentKey ()
 
 Layout (HPS.Layout that)
 
override HPS.Type ObjectType ()
 
void ReassignLayer (ulong in_layer, HPS.View in_view)
 
void RepositionLayer (ulong in_layer, HPS.Rectangle in_position)
 
bool ShowLayerAt (HPS.WindowPoint in_point)
 
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.Layout a, HPS.Layout b)
 
static bool operator== (HPS.Layout a, HPS.Layout 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 Layout 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 Canvas, View, and Model objects. The parent of the Layout is the Canvas, and a Layout can have multiple Views. The Layout is meant to describe the way the Views are presented in the Canvas. Like the other three core objects, the Layout is backed by a HPS.SegmentKey.

Member Function Documentation

◆ AttachViewBack() [1/2]

void HPS.Layout.AttachViewBack ( HPS.View  in_view,
HPS.Rectangle  in_position 
)
inline

Attached a View to this Layout, and places it to the back of the layer list

Parameters
in_viewThe View to be attached to this Layer.
in_positionA Rectangle describing the position this View occupies with respect to the window.

◆ AttachViewBack() [2/2]

void HPS.Layout.AttachViewBack ( HPS.View  in_view)
inline

Attached a View to this Layout, and places it to the back of the layer list

Parameters
in_viewThe View to be attached to this Layer.

◆ AttachViewFront() [1/2]

void HPS.Layout.AttachViewFront ( HPS.View  in_view,
HPS.Rectangle  in_position 
)
inline

Attached a View to this Layout, and places it to the front of the layer list

Parameters
in_viewThe View to be attached to this Layer.
in_positionA Rectangle describing the position this View occupies with respect to the window.

◆ AttachViewFront() [2/2]

void HPS.Layout.AttachViewFront ( HPS.View  in_view)
inline

Attached a View to this Layout, and places it to the front of the layer list

Parameters
in_viewThe View to be attached to this Layer.

◆ BringToFront()

void HPS.Layout.BringToFront ( ulong  in_layer)
inline

Brings a Layer to the front of the list, causing to be drawn on top of the other layers.

Parameters
in_layerThe layer to be moved to the front

◆ Delete()

void HPS.Layout.Delete ( )
inline

Deletes this Layout. If the Layout has Views attached, they are not destroyed.

◆ DetachLayer()

void HPS.Layout.DetachLayer ( ulong  in_layer)
inline

Detaches this Layer from this Layout

Parameters
in_layerThe Layer to detach.

◆ DetachView()

void HPS.Layout.DetachView ( HPS.View  in_view)
inline

Detaches this View from this Layout

Parameters
in_viewThe View to detach.

◆ GetAttachedView() [1/2]

HPS.View HPS.Layout.GetAttachedView ( ulong  in_layer)
inline

Returns the View assigned to the specified Layer

Parameters
in_layerThe Layer of interest.
Returns
The View associated to in_layer.

◆ GetAttachedView() [2/2]

HPS.View HPS.Layout.GetAttachedView ( )
inline

Returns the View assigned to the specified Layer

Returns
The View associated to in_layer.

◆ GetAttachedViewIncludeLink()

HPS.IncludeKey HPS.Layout.GetAttachedViewIncludeLink ( ulong  in_layer)
inline

Returns the IncludeKey associated with this Layout. The include key links the Layer segment key with the View.

◆ GetFrontView()

HPS.View HPS.Layout.GetFrontView ( )
inline

Returns the View assigned to the layer shown on top of the window

◆ GetLayerAt()

ulong HPS.Layout.GetLayerAt ( HPS.WindowPoint  in_point)
inline

Returns the position within the layer list of the top layer at a specified position

Parameters
in_pointA point in Window coordinates.
Returns
The position within the layer list of the top layer at position in_point.

◆ GetLayerCount()

ulong HPS.Layout.GetLayerCount ( )
inline

Returns the number of Layers currently associated with this Layout

◆ GetLayerSegmentKey()

HPS.SegmentKey HPS.Layout.GetLayerSegmentKey ( ulong  in_layer)
inline

Returns the backing SegmentKey associated with a given layer. The owner of this key is the layout segment key.

◆ GetName()

string HPS.Layout.GetName ( )
inline

Get the name used when creating this Layout.

◆ GetOwningCanvases()

HPS.Canvas [] HPS.Layout.GetOwningCanvases ( )
inline

Returns an array containing the Canvas this Layout is included in.

◆ GetSegmentKey()

HPS.SegmentKey HPS.Layout.GetSegmentKey ( )
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 HPS.Layout.

◆ ObjectType()

override HPS.Type HPS.Layout.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.

◆ ReassignLayer()

void HPS.Layout.ReassignLayer ( ulong  in_layer,
HPS.View  in_view 
)
inline

Reassigns a Layer to a different View.

Parameters
in_layerThe layer to be reassigned.
in_viewThe View in_layer will be assigned to.

◆ RepositionLayer()

void HPS.Layout.RepositionLayer ( ulong  in_layer,
HPS.Rectangle  in_position 
)
inline

Changes the position of layer with respect to its window.

Parameters
in_layerThe layer to be repositioned.
in_positionThe new position for the layer.

◆ ShowLayerAt()

bool HPS.Layout.ShowLayerAt ( HPS.WindowPoint  in_point)
inline

Returns whether a layer is present at the specified position.

Parameters
in_pointA point in Window coordinates.
Returns
true if a layer is present at in_point, false otherwise.

◆ Update() [1/3]

void HPS.Layout.Update ( )
inline

Redraws the Layout and all Canvases it appears in, including all of its child components.

◆ Update() [2/3]

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

Redraws the Layout and all Canvases it appears in, 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.

◆ Update() [3/3]

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

Redraws the Layout and all Canvases it appears in, 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.Layout.UpdateWithNotifier ( )
inline

Redraws the Layout and all Canvases it appears in, 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.Layout.UpdateWithNotifier ( HPS.Window.UpdateType  in_type,
double  in_time_limit 
)
inline

Redraws the Layout and all Canvases it appears in, including all of its child components using the specified, and also returns a notifier to facilitate tracking the update progress.

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.Layout.UpdateWithNotifier ( HPS.Window.UpdateType  in_type)
inline

Redraws the Layout and all Canvases it appears in, including all of its child components using the specified, and also returns a notifier to facilitate tracking the update progress.

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