REFERENCE MANUAL
#include <sprk.h>
Public Member Functions | |
void | Assign (Layout const &in_that) |
void | AttachViewBack (View const &in_view, Rectangle const &in_position=Rectangle(-1.0f, 1.0f,-1.0f, 1.0f)) |
void | AttachViewFront (View const &in_view, Rectangle const &in_position=Rectangle(-1.0f, 1.0f,-1.0f, 1.0f)) |
void | BringToFront (size_t in_layer) |
void | Delete () |
void | DetachLayer (size_t in_layer) |
void | DetachView (View const &in_view) |
bool | Equals (Layout const &in_that) const |
View | GetAttachedView (size_t in_layer=0) const |
IncludeKey | GetAttachedViewIncludeLink (size_t in_layer) const |
View | GetFrontView () const |
size_t | GetLayerAt (WindowPoint const &in_point) const |
size_t | GetLayerCount () const |
UTF8 | GetName () const |
CanvasArray | GetOwningCanvases () |
CanvasArray const | GetOwningCanvases () const |
Rectangle | GetPosition (size_t in_layer) const |
SegmentKey | GetSegmentKey () |
SegmentKey const | GetSegmentKey () const |
Layout (Layout const &that) | |
Type | ObjectType () const |
bool | operator!= (Layout const &in_that) const |
Layout & | operator= (Layout const &in_that) |
bool | operator== (Layout const &in_that) const |
void | ReassignLayer (size_t in_layer, View in_view) |
void | RepositionLayer (size_t in_layer, Rectangle const &in_position) |
bool | ShowLayerAt (WindowPoint const &in_point) const |
void | Update (Sprocket::UpdateType in_update_type=Sprocket::UpdateType::Asynchronous) const |
void | Update (Window::UpdateControl const in_control, Time const time_limit=-1.) const |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
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 SegmentKey.
void Layout::BringToFront | ( | size_t | in_layer | ) |
Brings a Layer to the front of the list, causing to be drawn on top of the other layers.
in_layer | The layer to be moved to the front |
void Layout::Delete | ( | ) |
void Layout::DetachLayer | ( | size_t | in_layer | ) |
Detaches this Layer from this Layout
in_layer | The Layer to detach. |
void Layout::DetachView | ( | View const & | in_view | ) |
View Layout::GetAttachedView | ( | size_t | in_layer = 0 | ) | const |
IncludeKey Layout::GetAttachedViewIncludeLink | ( | size_t | in_layer | ) | const |
Returns the IncludeKey associated with this Layout. The include key links the Layout with the View.
View Layout::GetFrontView | ( | ) | const |
Returns the View assigned to the layer shown on top of the window
CanvasArray Layout::GetOwningCanvases | ( | ) |
Rectangle Layout::GetPosition | ( | size_t | in_layer | ) | const |
Returns the position assigned to the specified Layer
in_layer | The layer of interest. |
SegmentKey Layout::GetSegmentKey | ( | ) |
Each of the four display hierarchy objects (Canvas, Layout, View, Model) are backed by a SegmentKey. This function returns the SegmentKey that is associated with this Layout.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
void Layout::ReassignLayer | ( | size_t | in_layer, |
View | in_view | ||
) |
void Layout::RepositionLayer | ( | size_t | in_layer, |
Rectangle const & | in_position | ||
) |
Changes the position of layer with respect to its window.
in_layer | The layer to be repositioned. |
in_position | The new position for the layer. |
void Layout::Update | ( | Sprocket::UpdateType | in_update_type = Sprocket::UpdateType::Asynchronous | ) | const |
Redraws the subcomponents of this Layout.
void Layout::Update | ( | Window::UpdateControl const | in_control, |
Time const | time_limit = -1. |
||
) | const |
Redraws the subcomponents of this Layout using the specified parameters.
in_control | one of the enum values specified by Window::UpdateControl |
time_limit | the maximum amount of time, in seconds, to spend updating this Layout |