Layout
- class HPS.Layout : public HPS.Sprocket
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.
Public Functions
- void Assign (HPS.Layout in_that)
- void AttachViewBack (HPS.View in_view)
Attached a View to this Layout, and places it to the back of the layer list
- Param in_view
The View to be attached to this Layer.
- 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
- void AttachViewFront (HPS.View in_view)
Attached a View to this Layout, and places it to the front of the layer list
- Param in_view
The View to be attached to this Layer.
- 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
- void BringToFront (ulong in_layer)
Brings a Layer to the front of the list, causing to be drawn on top of the other layers.
- Param in_layer
The layer to be moved to the front
- void DetachLayer (ulong in_layer)
Detaches this Layer from this Layout
- Param in_layer
The Layer to detach.
- void DetachView (HPS.View in_view)
Detaches this View from this Layout
- Param in_view
The View to detach.
- override void Dispose ()
- bool Equals (HPS.Layout in_that)
- override bool Equals (Object obj)
- HPS.View GetAttachedView ()
Returns the View assigned to the specified Layer
- Return
The View associated to in_layer.
- HPS.View GetAttachedView (ulong in_layer)
Returns the View assigned to the specified Layer
- Param in_layer
The Layer of interest.
- Return
The View associated to in_layer.
- HPS.IncludeKey GetAttachedViewIncludeLink (ulong in_layer)
Returns the IncludeKey associated with this Layout. The include key links the Layer segment key with the View.
- override int GetHashCode ()
- ulong GetLayerAt (HPS.WindowPoint in_point)
Returns the position within the layer list of the top layer at a specified position
- Param in_point
A point in Window coordinates.
- Return
The position within the layer list of the top layer at position in_point.
- 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.
- HPS.Canvas[] GetOwningCanvases ()
Returns an array containing the Canvas this Layout is included in.
- 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.
- Layout ()
- Layout (HPS.Layout that)
- override HPS.Type ObjectType ()
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).
- Return
The declared type of the object in question, which may differ from the true, underlying type.
- void ReassignLayer (ulong in_layer, HPS.View in_view)
Reassigns a Layer to a different View.
- Param in_layer
The layer to be reassigned.
- Param in_view
The View in_layer will be assigned to.
- void RepositionLayer (ulong in_layer, HPS.Rectangle in_position)
Changes the position of layer with respect to its window.
- Param in_layer
The layer to be repositioned.
- Param in_position
The new position for the layer.
- bool ShowLayerAt (HPS.WindowPoint in_point)
Returns whether a layer is present at the specified position.
- Param in_point
A point in Window coordinates.
- Return
true if a layer is present at in_point, false otherwise.
- void Update ()
Redraws the Layout and all Canvases it appears in, including all of its child components.
- void Update (HPS.Window.UpdateType in_type)
Redraws the Layout and all Canvases it appears in, including all of its child components using the specified parameters.
- Param in_type
one of the enum values specified by HPS.Window.UpdateType
- void Update (HPS.Window.UpdateType in_type, double in_time_limit)
Redraws the Layout and all Canvases it appears in, including all of its child components using the specified parameters.
- Param in_type
one of the enum values specified by HPS.Window.UpdateType
- Param in_time_limit
the maximum amount of time, in seconds, to spend updating.
- HPS.UpdateNotifier UpdateWithNotifier ()
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.
- Return
An UpdateNotifier object used to find out information about the update.
- HPS.UpdateNotifier UpdateWithNotifier (HPS.Window.UpdateType in_type)
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.
- Param in_type
one of the enum values specified by HPS.Window.UpdateType
- Return
An UpdateNotifier object used to find out information about the update.
- HPS.UpdateNotifier UpdateWithNotifier (HPS.Window.UpdateType in_type, double in_time_limit)
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.
- Param in_type
one of the enum values specified by HPS.Window.UpdateType
- Param in_time_limit
the maximum amount of time, in seconds, to spend updating this HPS.Canvas
- Return
An UpdateNotifier object used to find out information about the update.
Public Static Functions
- bool operator!= (HPS.Layout a, HPS.Layout b)
- bool operator== (HPS.Layout a, HPS.Layout b)
