Factory

class HPS.Factory : public HPS.Sprocket

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

Public Functions

override void Dispose ()

Factory (HPS.Factory in_that)

Public Static Functions

HPS.Canvas CreateCanvas ()

Creates a new Canvas.

Return

The newly created Canvas.

HPS.Canvas CreateCanvas (HPS.WindowKey in_window_key)

Creates a new Canvas.

Param in_window_key

The window key associated with this Canvas.

Return

The newly created Canvas.

HPS.Canvas CreateCanvas (HPS.WindowKey in_window_key, HPS.PortfolioKey in_portfolio_key)

Creates a new Canvas.

Param in_window_key

The window key associated with this Canvas.

Param in_portfolio_key

Key to the portfolio to be associated with this Canvas.

Return

The newly created Canvas.

HPS.Canvas CreateCanvas (HPS.WindowKey in_window_key, HPS.PortfolioKey in_portfolio_key, string in_name)

Creates a new Canvas.

Param in_window_key

The window key associated with this Canvas.

Param in_portfolio_key

Key to the portfolio to be associated with this Canvas.

Param in_name

An optional name associated with this Canvas.

Return

The newly created Canvas.

HPS.Canvas CreateCanvas (IntPtr in_window_handle)

Creates a new Canvas.

Param in_window_handle

The window handle associated with this Canvas.

Return

The newly created Canvas.

HPS.Canvas CreateCanvas (IntPtr in_window_handle, string in_name)

Creates a new Canvas.

Param in_window_handle

The window handle associated with this Canvas.

Param in_name

An optional name associated with this Canvas.

Return

The newly created Canvas.

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

Creates a new Canvas.

Param in_window_handle

The window handle associated with this Canvas.

Param in_name

An optional name associated with this Canvas.

Param in_options

An ApplicationWindowOptionsKit used to specify the driver to be used by the canvas, and whether it will support anti-aliasing.

Return

The newly created Canvas.

HPS.Canvas CreateCanvas (string in_name)

Creates a new Canvas.

Param in_name

An optional name associated with this Canvas.

Return

The newly created Canvas.

HPS.Canvas CreateCanvas (string in_name, HPS.StandAloneWindowOptionsKit in_options)

Creates a new Canvas.

Param in_name

An optional name associated with this Canvas.

Param in_options

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

Return

The newly created Canvas.

HPS.Component CreateComponent (HPS.Component in_owner)

Creates a new Component.

Param in_owner

The owner of the component being created

Return

The newly created Component.

HPS.Component CreateComponent (HPS.Component in_owner, string in_name)

Creates a new Component.

Param in_owner

The owner of the component being created

Param in_name

An optional name associated with this Component.

Return

The newly created Component.

HPS.Layout CreateLayout ()

Creates a new Layout.

Return

The newly created Layout.

HPS.Layout CreateLayout (string in_name)

Creates a new Layout.

Param in_name

An optional name associated with this Layout.

Return

The newly created Layout.

HPS.Model CreateModel ()

Creates a new Model.

Return

The newly created Model.

HPS.Model CreateModel (string in_name)

Creates a new Model.

Param in_name

An optional name associated with this Model.

Return

The newly created Model.

HPS.View CreateView ()

Creates a new View.

Return

The newly created View.

HPS.View CreateView (string in_name)

Creates a new View.

Param in_name

An optional name associated with this View.

Return

The newly created View.

HPS.Component DeInstanceComponent (HPS.ComponentPath in_component_path)

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.

Param in_component_path

The ComponentPath to operate on.

Return

The newly de-instanced Component.

HPS.CADModel[] GetCADModels ()

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

Return

A list of active CADModels.

HPS.Canvas[] GetCanvases ()

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

Return

A list of active Canvases.

HPS.Layout[] GetLayouts ()

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

Return

A list of active Layouts.

HPS.Model[] GetModels ()

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

Return

A list of active Models.

HPS.View[] GetViews ()

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

Return

A list of active Views.