Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.Factory Class Reference
Inheritance diagram for HPS.Factory:
HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
Factory (HPS.Factory in_that)
 
- Public Member Functions inherited from HPS.Sprocket
override void Dispose ()
 
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual HPS.Type ObjectType ()
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static HPS.Canvas CreateCanvas (IntPtr in_window_handle, string in_name, HPS.ApplicationWindowOptionsKit in_options)
 
static HPS.Canvas CreateCanvas (IntPtr in_window_handle, string in_name)
 
static HPS.Canvas CreateCanvas (IntPtr in_window_handle)
 
static HPS.Canvas CreateCanvas (string in_name, HPS.StandAloneWindowOptionsKit in_options)
 
static HPS.Canvas CreateCanvas (string in_name)
 
static HPS.Canvas CreateCanvas ()
 
static HPS.Canvas CreateCanvas (HPS.WindowKey in_window_key, HPS.PortfolioKey in_portfolio_key, string in_name)
 
static HPS.Canvas CreateCanvas (HPS.WindowKey in_window_key, HPS.PortfolioKey in_portfolio_key)
 
static HPS.Canvas CreateCanvas (HPS.WindowKey in_window_key)
 
static HPS.Component CreateComponent (HPS.Component in_owner, string in_name)
 
static HPS.Component CreateComponent (HPS.Component in_owner)
 
static HPS.Layout CreateLayout (string in_name)
 
static HPS.Layout CreateLayout ()
 
static HPS.Model CreateModel (string in_name)
 
static HPS.Model CreateModel ()
 
static HPS.View CreateView (string in_name)
 
static HPS.View CreateView ()
 
static HPS.Component DeInstanceComponent (HPS.ComponentPath in_component_path)
 
static HPS.CADModel [] GetCADModels ()
 
static HPS.Canvas [] GetCanvases ()
 
static HPS.Layout [] GetLayouts ()
 
static HPS.Model [] GetModels ()
 
static HPS.View [] GetViews ()
 
- 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

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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

Member Function Documentation

◆ CreateCanvas() [1/9]

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.

◆ CreateCanvas() [2/9]

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.

◆ CreateCanvas() [3/9]

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.

◆ CreateCanvas() [4/9]

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. Note: This is not supported on Android, iOS or macOS as this uses standalone windows and on these operating systems all GUI / windowing is controlled at the application level.
Returns
The newly created Canvas.

◆ CreateCanvas() [5/9]

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.

◆ CreateCanvas() [6/9]

static HPS.Canvas HPS.Factory.CreateCanvas ( )
inlinestatic

Creates a new Canvas.

Returns
The newly created Canvas.

◆ CreateCanvas() [7/9]

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.

◆ CreateCanvas() [8/9]

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.

◆ CreateCanvas() [9/9]

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.

◆ CreateComponent() [1/2]

static HPS.Component HPS.Factory.CreateComponent ( HPS.Component  in_owner,
string  in_name 
)
inlinestatic

Creates a new Component.

Parameters
in_ownerThe owner of the component being created
in_nameAn optional name associated with this Component.
Returns
The newly created Component.

◆ CreateComponent() [2/2]

static HPS.Component HPS.Factory.CreateComponent ( HPS.Component  in_owner)
inlinestatic

Creates a new Component.

Parameters
in_ownerThe owner of the component being created
Returns
The newly created Component.

◆ CreateLayout() [1/2]

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.

◆ CreateLayout() [2/2]

static HPS.Layout HPS.Factory.CreateLayout ( )
inlinestatic

Creates a new Layout.

Returns
The newly created Layout.

◆ CreateModel() [1/2]

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.

◆ CreateModel() [2/2]

static HPS.Model HPS.Factory.CreateModel ( )
inlinestatic

Creates a new Model.

Returns
The newly created Model.

◆ CreateView() [1/2]

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.

◆ CreateView() [2/2]

static HPS.View HPS.Factory.CreateView ( )
inlinestatic

Creates a new View.

Returns
The newly created View.

◆ DeInstanceComponent()

static HPS.Component HPS.Factory.DeInstanceComponent ( HPS.ComponentPath  in_component_path)
inlinestatic

Returns the component at whose level changes can be made without influencing other instances of the same component. The details vary on whether this function operates on Parasolid or Exchange components. See the comments on Exchange.Factory.DeInstanceComponent and Parasolid.Factory.DeInstanceComponent for details.

Parameters
in_component_pathThe ComponentPath to operate on.
Returns
The newly de-instanced Component.

◆ GetCADModels()

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.

◆ GetCanvases()

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.

◆ GetLayouts()

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.

◆ GetModels()

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.

◆ GetViews()

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:
  • internals/hps_sprk/source/cs/HPS.Factory.cs