< Home

< Table of Contents

REFERENCE MANUAL

Canvas Class Reference

#include <sprk.h>

Inheritance diagram for Canvas:
Sprocket Object

Public Member Functions

void Assign (Canvas const &in_that)
 
void AttachLayout (Layout const &in_layout)
 
void AttachViewAsLayout (View const &in_view)
 
 Canvas (Canvas const &that)
 
void Delete ()
 
void DetachLayout ()
 
bool Equals (Canvas const &in_that) const
 
Layout GetAttachedLayout () const
 
IncludeKey GetAttachedLayoutIncludeLink () const
 
float GetFrameRate () const
 
View GetFrontView () const
 
UTF8 GetName () const
 
PortfolioKey const GetPortfolioKey () const
 
PortfolioKey GetPortfolioKey ()
 
WindowKey const GetWindowKey () const
 
WindowKey GetWindowKey ()
 
Type ObjectType () const
 
bool operator!= (Canvas const &in_that) const
 
Canvasoperator= (Canvas const &in_that)
 
bool operator== (Canvas const &in_that) const
 
void SetFrameRate (float in_frame_rate=20)
 
void Update (Sprocket::UpdateType in_update_type=Sprocket::UpdateType::Asynchronous) const
 
void Update (Window::UpdateControl const in_control, Time const time_limit=-1.) const
 
UpdateNotifier UpdateWithNotifier () const
 
UpdateNotifier UpdateWithNotifier (Window::UpdateControl const in_control, Time const time_limit=-1.) const
 
- Public Member Functions inherited from Sprocket
 Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (Type in_mask) const
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
Type Type () const
 

Additional Inherited Members

- Public Types inherited from Sprocket
enum  UpdateType { Synchronous, Asynchronous }
 
- Static Public Member Functions inherited from Object
template<typename T >
static intptr_t ClassID ()
 

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

Member Function Documentation

void Canvas::AttachLayout ( Layout const &  in_layout)

Attaches a layout to this Canvas. There can only be one layout per 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 Canvas.
void Canvas::AttachViewAsLayout ( View const &  in_view)

Attaches a View to this 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 Canvas.
void Canvas::Delete ( )

Deletes this Canvas, and the Window that backs it. If the Canvas has Layouts attached, they are not destroyed.

void Canvas::DetachLayout ( )

Detaches the Layout from this Canvas.

Layout Canvas::GetAttachedLayout ( ) const

Returns the Layout that is currently attached to this Canvas.

IncludeKey Canvas::GetAttachedLayoutIncludeLink ( ) const

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

float Canvas::GetFrameRate ( ) const

Returns true if frame rate is active for this Canvas.

Returns
Returns frame rate in number of frames per second.
View Canvas::GetFrontView ( ) const

Views can overlap. This function returns a reference to the frontmost View.

UTF8 Canvas::GetName ( ) const

Get the name used when creating this Canvas.

PortfolioKey Canvas::GetPortfolioKey ( )

Returns the PortfolioKey associated with this Canvas' SegmentKey.

WindowKey Canvas::GetWindowKey ( )

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

Type Canvas::ObjectType ( ) const
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 Object.

void Canvas::SetFrameRate ( float  in_frame_rate = 20)

Sets the maximum frame rate for this Canvas in number of frames per second.

Parameters
in_frame_rateFrame rate in number of frames per second. Pass 0 to disable frame rate.
void Canvas::Update ( Sprocket::UpdateType  in_update_type = Sprocket::UpdateType::Asynchronous) const

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

void Canvas::Update ( Window::UpdateControl const  in_control,
Time const  time_limit = -1. 
) const

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

Parameters
in_controlone of the enum values specified by Window::UpdateControl
time_limitthe maximum amount of time, in seconds, to spend updating this Canvas
UpdateNotifier Canvas::UpdateWithNotifier ( ) const

Redraws the entire Canvas, including all of its child components, and also returns an UpdateNotifier to facilitate tracking the update progress.

UpdateNotifier Canvas::UpdateWithNotifier ( Window::UpdateControl const  in_control,
Time const  time_limit = -1. 
) const

Redraws the entire Canvas, including all of its child components using the specified parameters, and also returns an UpdateNotifier to facilitate tracking the update progress.

Parameters
in_controlone of the enum values specified by Window::UpdateControl
time_limitthe maximum amount of time, in seconds, to spend updating this Canvas

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