#include <sprk.h>

Inheritance diagram for HPS::Factory:

Static Public Member Functions
static Canvas	CreateCanvas (HPS::WindowHandle in_window_handle, char const *in_name="", HPS::ApplicationWindowOptionsKit const &in_options=HPS::ApplicationWindowOptionsKit())

static Canvas	CreateCanvas (char const *in_name="", HPS::StandAloneWindowOptionsKit const &in_options=HPS::StandAloneWindowOptionsKit())

static Canvas	CreateCanvas (HPS::WindowKey const &in_window_key, HPS::PortfolioKey const &in_portfolio_key=HPS::PortfolioKey(), char const *in_name="")

static Component	CreateComponent (Component const &in_owner, 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 Component	DeInstanceComponent (ComponentPath const &in_component_path)

static CADModelArray	GetCADModels ()

static CanvasArray	GetCanvases ()

static LayoutArray	GetLayouts ()

static ModelArray	GetModels ()

static ViewArray	GetViews ()

Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t	ClassID ()

Additional Inherited Members
Public Member Functions inherited from HPS::Sprocket
	Sprocket (Sprocket &&in_that)

Public Member Functions inherited from HPS::Object
virtual bool	Empty () const

intptr_t	GetClassID () const

intptr_t	GetInstanceID () const

bool	HasType (HPS::Type in_mask) const

	Object (Object const &that)

	Object (Object &&in_that)

virtual HPS::Type	ObjectType () const

Object &	operator= (Object const &other_object)

Object &	operator= (Object &&in_that)

virtual void	Reset ()

virtual HPS::Type	Type () const

Static Public Attributes inherited from HPS::Object
static const HPS::Type	staticType = HPS::Type::None

Detailed Description

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

Member Function Documentation

◆ CreateCanvas() [1/3]

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

static

Creates a new Canvas.

Parameters

in_window_handle	The window handle associated with this Canvas.
in_name	An optional name associated with this Canvas.
in_options	An 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/3]

static Canvas HPS::Factory::CreateCanvas	(	char const *	in_name = `""`,
		HPS::StandAloneWindowOptionsKit const &	in_options = `HPS::StandAloneWindowOptionsKit()`
	)

static

Creates a new Canvas.

Parameters

in_name	An optional name associated with this Canvas.
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.

Returns: The newly created Canvas.

◆ CreateCanvas() [3/3]

static Canvas HPS::Factory::CreateCanvas	(	HPS::WindowKey const &	in_window_key,
		HPS::PortfolioKey const &	in_portfolio_key = `HPS::PortfolioKey()`,
		char const *	in_name = `""`
	)

static

Creates a new Canvas.

Parameters

in_window_key	The window key associated with this Canvas.
in_portfolio_key	Key to the portfolio to be associated with this Canvas.
in_name	An optional name associated with this Canvas.

Returns: The newly created Canvas.

◆ CreateComponent()

static Component HPS::Factory::CreateComponent	(	Component const &	in_owner,
		char const *	in_name = `""`
	)

static

Creates a new Component.

Parameters

in_owner	The owner of the component being created
in_name	An optional name associated with this Component.

Returns: The newly created Component.

◆ CreateLayout()

static Layout HPS::Factory::CreateLayout ( char const * in_name = "" )

static

Creates a new Layout.

Parameters

in_name An optional name associated with this Layout.

Returns: The newly created Layout.

◆ CreateModel()

static Model HPS::Factory::CreateModel ( char const * in_name = "" )

static

Creates a new Model.

Parameters

in_name An optional name associated with this Model.

Returns: The newly created Model.

◆ CreateView()

static View HPS::Factory::CreateView ( char const * in_name = "" )

static

Creates a new View.

Parameters

in_name An optional name associated with this View.

Returns: The newly created View.

◆ DeInstanceComponent()

static Component HPS::Factory::DeInstanceComponent ( ComponentPath const & in_component_path )

static

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_path The ComponentPath to operate on.

Returns: The newly de-instanced Component.

◆ GetCADModels()

static CADModelArray HPS::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.

◆ GetCanvases()

static CanvasArray HPS::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.

◆ GetLayouts()

static LayoutArray HPS::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.

◆ GetModels()

static ModelArray HPS::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.

◆ GetViews()

static ViewArray HPS::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:

include/sprk.h

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateCanvas() [1/3]

◆ CreateCanvas() [2/3]

◆ CreateCanvas() [3/3]

◆ CreateComponent()

◆ CreateLayout()

◆ CreateModel()

◆ CreateView()

◆ DeInstanceComponent()

◆ GetCADModels()

◆ GetCanvases()

◆ GetLayouts()

◆ GetModels()

◆ GetViews()