< Home

< Table of Contents

REFERENCE MANUAL

Factory Class Reference

#include <sprk.h>

Inheritance diagram for Factory:
Sprocket Object

Static Public Member Functions

static Canvas CreateCanvas (WindowHandle in_window_handle, char const *in_name="", ApplicationWindowOptionsKit const &in_options=ApplicationWindowOptionsKit())
 
static Canvas CreateCanvas (char const *in_name="", StandAloneWindowOptionsKit const &in_options=StandAloneWindowOptionsKit())
 
static Canvas CreateCanvas (WindowKey const &in_window_key, PortfolioKey const &in_portfolio_key=PortfolioKey(), char const *in_name="")
 
static Layout CreateLayout (char const *in_name="")
 
static Model CreateModel (char const *in_name="")
 
static View CreateView (char const *in_name="")
 
static CADModelArray GetCADModels ()
 
static CanvasArray GetCanvases ()
 
static LayoutArray GetLayouts ()
 
static ModelArray GetModels ()
 
static ViewArray GetViews ()
 
- Static Public Member Functions inherited from Object
template<typename T >
static intptr_t ClassID ()
 

Additional Inherited Members

- Public Types inherited from Sprocket
enum  UpdateType { Synchronous, Asynchronous }
 
- 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)
 
virtual Type ObjectType () const
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
Type Type () const
 

Detailed Description

The Factory class is used to create and query Sprocket objects.

Member Function Documentation

static Canvas Factory::CreateCanvas ( WindowHandle  in_window_handle,
char const *  in_name = "",
ApplicationWindowOptionsKit const &  in_options = ApplicationWindowOptionsKit() 
)
static

Creates a new Canvas.

Parameters
in_window_handleThe window handle associated with this Canvas.
in_nameAn optional name associated with this Canvas.
in_optionsAn ApplicationWindowOptionsKit used to specify the driver to be used by the canvas, and whether it will support anti-aliasing.
Returns
The newly created Canvas.
static Canvas Factory::CreateCanvas ( char const *  in_name = "",
StandAloneWindowOptionsKit const &  in_options = StandAloneWindowOptionsKit() 
)
static

Creates a new Canvas.

Parameters
in_nameAn optional name associated with this Canvas.
in_optionsAn StandAloneWindowOptionsKit used to specify the driver to be used by the canvas, and whether it will support anti-aliasing.
Returns
The newly created Canvas.
static Canvas Factory::CreateCanvas ( WindowKey const &  in_window_key,
PortfolioKey const &  in_portfolio_key = PortfolioKey(),
char const *  in_name = "" 
)
static

Creates a new Canvas.

Parameters
in_window_keyThe window key associated with this Canvas.
in_portfolio_keyKey to the portfolio to be associated with this Canvas.
in_nameAn optional name associated with this Canvas.
Returns
The newly created Canvas.
static Layout Factory::CreateLayout ( char const *  in_name = "")
static

Creates a new Layout.

Parameters
in_nameAn optional name associated with this Layout.
Returns
The newly created Layout.
static Model Factory::CreateModel ( char const *  in_name = "")
static

Creates a new Model.

Parameters
in_nameAn optional name associated with this Model.
Returns
The newly created Model.
static View Factory::CreateView ( char const *  in_name = "")
static

Creates a new View.

Parameters
in_nameAn optional name associated with this View.
Returns
The newly created View.
static CADModelArray Factory::GetCADModels ( )
static

Get a list of all active CADModels (i.e. CADModels that have been created and not deleted)

Returns
A list of active CADModels.
static CanvasArray Factory::GetCanvases ( )
static

Get a list of all active Canvases (i.e. Canvases that have been created and not deleted)

Returns
A list of active Canvases.
static LayoutArray Factory::GetLayouts ( )
static

Get a list of all active Layouts (i.e. Layouts that have been created and not deleted)

Returns
A list of active Layouts.
static ModelArray Factory::GetModels ( )
static

Get a list of all active Models (i.e. Models that have been created and not deleted)

Returns
A list of active Models.
static ViewArray Factory::GetViews ( )
static

Get a list of all active Views (i.e. Views that have been created and not deleted)

Returns
A list of active Views.

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