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

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

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

Public Member Functions

override void Dispose ()
 
- 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 that)
 
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 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...
 
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 HPS.Canvas[] GetCanvases ()
 Get a list of all active Canvases (i.e. Canvases that have been created and not deleted) More...
 
static HPS.Layout[] GetLayouts ()
 Get a list of all active Layouts (i.e. Layouts that have been created and not deleted) More...
 
static HPS.View[] GetViews ()
 Get a list of all active Views (i.e. Views that have been created and not deleted) More...
 
static HPS.Model[] GetModels ()
 Get a list of all active Models (i.e. Models that have been created and not deleted) More...
 
static HPS.CADModel[] GetCADModels ()
 Get a list of all active CADModels (i.e. CADModels that have been created and not deleted) More...
 
static HPS.Canvas CreateCanvas (IntPtr in_window_handle, string in_name, HPS.ApplicationWindowOptionsKit in_options)
 Creates a new Canvas. More...
 
static HPS.Canvas CreateCanvas (IntPtr in_window_handle, string in_name)
 Creates a new Canvas. More...
 
static HPS.Canvas CreateCanvas (IntPtr in_window_handle)
 Creates a new Canvas. More...
 
static HPS.Canvas CreateCanvas (string in_name, HPS.StandAloneWindowOptionsKit in_options)
 Creates a new Canvas. More...
 
static HPS.Canvas CreateCanvas (string in_name)
 Creates a new Canvas. More...
 
static HPS.Canvas CreateCanvas ()
 Creates a new Canvas. More...
 
static HPS.Canvas CreateCanvas (HPS.WindowKey in_window_key, HPS.PortfolioKey in_portfolio_key, string in_name)
 Creates a new Canvas. More...
 
static HPS.Canvas CreateCanvas (HPS.WindowKey in_window_key, HPS.PortfolioKey in_portfolio_key)
 Creates a new Canvas. More...
 
static HPS.Canvas CreateCanvas (HPS.WindowKey in_window_key)
 Creates a new Canvas. More...
 
static HPS.Layout CreateLayout (string in_name)
 Creates a new Layout. More...
 
static HPS.Layout CreateLayout ()
 Creates a new Layout. More...
 
static HPS.View CreateView (string in_name)
 Creates a new View. More...
 
static HPS.View CreateView ()
 Creates a new View. More...
 
static HPS.Model CreateModel (string in_name)
 Creates a new Model. More...
 
static HPS.Model CreateModel ()
 Creates a new Model. More...
 
- 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 Factory class is used to create and query Sprocket objects.

Member Function Documentation

static HPS.Canvas HPS.Factory.CreateCanvas ( IntPtr  in_window_handle,
string  in_name,
HPS.ApplicationWindowOptionsKit  in_options 
)
inlinestatic

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 HPS.Canvas HPS.Factory.CreateCanvas ( IntPtr  in_window_handle,
string  in_name 
)
inlinestatic

Creates a new Canvas.

Parameters
in_window_handleThe window handle associated with this Canvas.
in_nameAn optional name associated with this Canvas.
Returns
The newly created Canvas.
static HPS.Canvas HPS.Factory.CreateCanvas ( IntPtr  in_window_handle)
inlinestatic

Creates a new Canvas.

Parameters
in_window_handleThe window handle associated with this Canvas.
Returns
The newly created Canvas.
static HPS.Canvas HPS.Factory.CreateCanvas ( string  in_name,
HPS.StandAloneWindowOptionsKit  in_options 
)
inlinestatic

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 HPS.Canvas HPS.Factory.CreateCanvas ( string  in_name)
inlinestatic

Creates a new Canvas.

Parameters
in_nameAn optional name associated with this Canvas.
Returns
The newly created Canvas.
static HPS.Canvas HPS.Factory.CreateCanvas ( )
inlinestatic

Creates a new Canvas.

Returns
The newly created Canvas.
static HPS.Canvas HPS.Factory.CreateCanvas ( HPS.WindowKey  in_window_key,
HPS.PortfolioKey  in_portfolio_key,
string  in_name 
)
inlinestatic

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 HPS.Canvas HPS.Factory.CreateCanvas ( HPS.WindowKey  in_window_key,
HPS.PortfolioKey  in_portfolio_key 
)
inlinestatic

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.
Returns
The newly created Canvas.
static HPS.Canvas HPS.Factory.CreateCanvas ( HPS.WindowKey  in_window_key)
inlinestatic

Creates a new Canvas.

Parameters
in_window_keyThe window key associated with this Canvas.
Returns
The newly created Canvas.
static HPS.Layout HPS.Factory.CreateLayout ( string  in_name)
inlinestatic

Creates a new Layout.

Parameters
in_nameAn optional name associated with this Layout.
Returns
The newly created Layout.
static HPS.Layout HPS.Factory.CreateLayout ( )
inlinestatic

Creates a new Layout.

Returns
The newly created Layout.
static HPS.Model HPS.Factory.CreateModel ( string  in_name)
inlinestatic

Creates a new Model.

Parameters
in_nameAn optional name associated with this Model.
Returns
The newly created Model.
static HPS.Model HPS.Factory.CreateModel ( )
inlinestatic

Creates a new Model.

Returns
The newly created Model.
static HPS.View HPS.Factory.CreateView ( string  in_name)
inlinestatic

Creates a new View.

Parameters
in_nameAn optional name associated with this View.
Returns
The newly created View.
static HPS.View HPS.Factory.CreateView ( )
inlinestatic

Creates a new View.

Returns
The newly created View.
static HPS.CADModel [] HPS.Factory.GetCADModels ( )
inlinestatic

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

Returns
A list of active CADModels.
static HPS.Canvas [] HPS.Factory.GetCanvases ( )
inlinestatic

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

Returns
A list of active Canvases.
static HPS.Layout [] HPS.Factory.GetLayouts ( )
inlinestatic

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

Returns
A list of active Layouts.
static HPS.Model [] HPS.Factory.GetModels ( )
inlinestatic

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

Returns
A list of active Models.
static HPS.View [] HPS.Factory.GetViews ( )
inlinestatic

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: