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

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

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

Public Member Functions

override void Dispose ()
 
 Layout (HPS.Layout 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 Layout. If the Layout has Views attached, they are not destroyed. More...
 
void Assign (HPS.Layout in_that)
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.Layout in_that)
 
string GetName ()
 Get the name used when creating this Layout. More...
 
ulong GetLayerCount ()
 Returns the number of Layers currently associated with this Layout More...
 
void AttachViewFront (HPS.View in_view, HPS.Rectangle in_position)
 Attached a View to this Layout, and places it to the front of the layer list More...
 
void AttachViewFront (HPS.View in_view)
 Attached a View to this Layout, and places it to the front of the layer list More...
 
void AttachViewBack (HPS.View in_view, HPS.Rectangle in_position)
 Attached a View to this Layout, and places it to the back of the layer list More...
 
void AttachViewBack (HPS.View in_view)
 Attached a View to this Layout, and places it to the back of the layer list More...
 
void DetachLayer (ulong in_layer)
 Detaches this Layer from this Layout More...
 
void DetachView (HPS.View in_view)
 Detaches this View from this Layout More...
 
void BringToFront (ulong in_layer)
 Brings a Layer to the front of the list, causing to be drawn on top of the other layers. More...
 
void ReassignLayer (ulong in_layer, HPS.View in_view)
 Reassigns a Layer to a different View. More...
 
void RepositionLayer (ulong in_layer, HPS.Rectangle in_position)
 Changes the position of layer with respect to its window. More...
 
HPS.View GetFrontView ()
 Returns the View assigned to the layer shown on top of the window More...
 
HPS.View GetAttachedView (ulong in_layer)
 Returns the View assigned to the specified Layer More...
 
HPS.View GetAttachedView ()
 Returns the View assigned to the specified Layer More...
 
HPS.IncludeKey GetAttachedViewIncludeLink (ulong in_layer)
 Returns the IncludeKey associated with this Layout. The include key links the Layer segment key with the View. More...
 
HPS.SegmentKey GetLayerSegmentKey (ulong in_layer)
 Returns the backing SegmentKey associated with a given layer. The owner of this key is the layout segment key. More...
 
ulong GetLayerAt (HPS.WindowPoint in_point)
 Returns the position within the layer list of the top layer at a specified position More...
 
bool ShowLayerAt (HPS.WindowPoint in_point)
 Returns whether a layer is present at the specified position. More...
 
HPS.SegmentKey GetSegmentKey ()
 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. More...
 
HPS.Canvas[] GetOwningCanvases ()
 Returns an array containing the Canvas this Layout is included in. More...
 
void Update (HPS.Sprocket.UpdateType in_update_type)
 Redraws the subcomponents of this Layout. More...
 
void Update ()
 Redraws the subcomponents of this Layout. More...
 
void Update (HPS.Window.UpdateControl in_control, double time_limit)
 Redraws the subcomponents of this Layout using the specified parameters. More...
 
void Update (HPS.Window.UpdateControl in_control)
 Redraws the subcomponents of this Layout using the specified parameters. 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 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...
 
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.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

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

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 <ref refid="class_h_p_s_1_1_view" kindref="compound">View</ref> to be attached to this Layer.
in_positionA Rectangle describing the position this <ref refid="class_h_p_s_1_1_view" kindref="compound">View</ref> occupies with respect to the window.
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 <ref refid="class_h_p_s_1_1_view" kindref="compound">View</ref> to be attached to this Layer.
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 <ref refid="class_h_p_s_1_1_view" kindref="compound">View</ref> to be attached to this Layer.
in_positionA Rectangle describing the position this <ref refid="class_h_p_s_1_1_view" kindref="compound">View</ref> occupies with respect to the window.
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 <ref refid="class_h_p_s_1_1_view" kindref="compound">View</ref> to be attached to this Layer.
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
void HPS.Layout.Delete ( )
inline

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

void HPS.Layout.DetachLayer ( ulong  in_layer)
inline

Detaches this Layer from this Layout

Parameters
in_layerThe Layer to detach.
void HPS.Layout.DetachView ( HPS.View  in_view)
inline

Detaches this View from this Layout

Parameters
in_viewThe <ref refid="class_h_p_s_1_1_view" kindref="compound">View</ref> to detach.
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.
HPS.View HPS.Layout.GetAttachedView ( )
inline

Returns the View assigned to the specified Layer

Returns
The View associated to in_layer.
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.

HPS.View HPS.Layout.GetFrontView ( )
inline

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

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.
ulong HPS.Layout.GetLayerCount ( )
inline

Returns the number of Layers currently associated with this Layout

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.

string HPS.Layout.GetName ( )
inline

Get the name used when creating this Layout.

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

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

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.

override HPS.Type HPS.Layout.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.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 <ref refid="class_h_p_s_1_1_view" kindref="compound">View</ref> in_layer will be assigned to.
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.
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.
void HPS.Layout.Update ( HPS.Sprocket.UpdateType  in_update_type)
inline

Redraws the subcomponents of this Layout.

void HPS.Layout.Update ( )
inline

Redraws the subcomponents of this Layout.

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

Redraws the subcomponents of this Layout 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 <ref refid="class_h_p_s_1_1_layout" kindref="compound">HPS::Layout</ref>
void HPS.Layout.Update ( HPS.Window.UpdateControl  in_control)
inline

Redraws the subcomponents of this Layout using the specified parameters.

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

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