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

Public Member Functions

override void Dispose ()
 
Factory (HPS.Exchange.Factory in_that)
 
- Public Member Functions inherited from HPS.Sprocket
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.Exchange.CADModel CreateCADModel (HPS.Model in_model, IntPtr in_entity, bool in_owns_entity)
 
static HPS.Exchange.CADModel CreateCADModel (HPS.Model in_model, IntPtr in_entity)
 
static HPS.Exchange.CADModel CreateCADModel (HPS.Model in_model)
 
static HPS.Exchange.CADModel CreateCADModel ()
 
static HPS.Exchange.Capture CreateCapture (HPS.Component in_owner, IntPtr in_entity, bool in_is_default)
 
static HPS.Exchange.Capture CreateCapture (HPS.Component in_owner, IntPtr in_entity)
 
static HPS.Exchange.Capture CreateCapture (HPS.Component in_owner)
 
static HPS.Exchange.Component CreateComponent (HPS.Component in_owner, HPS.Component.ComponentType in_type, IntPtr in_entity)
 
static HPS.Exchange.Component CreateComponent (HPS.Component in_owner, HPS.Component.ComponentType in_type)
 
static HPS.Exchange.Filter CreateFilter (HPS.Component in_owner, IntPtr in_entity)
 
static HPS.Exchange.Filter CreateFilter (HPS.Component in_owner)
 
static HPS.Exchange.Sheet CreateSheet (HPS.Component in_owner, IntPtr in_entity)
 
static HPS.Exchange.Sheet CreateSheet (HPS.Component in_owner)
 
static HPS.Exchange.Component DeInstanceComponent (HPS.ComponentPath in_component_path)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

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 Exchange objects which inherit from HPS.Component or one of its subclasses.

Member Function Documentation

◆ CreateCADModel() [1/4]

static HPS.Exchange.CADModel HPS.Exchange.Factory.CreateCADModel ( HPS.Model  in_model,
IntPtr  in_entity,
bool  in_owns_entity 
)
inlinestatic

Creates a new Exchange.CADModel.

Parameters
in_modelThe Model associated with the newly created Exchange.CADModel.
in_entityThe Exchange entity associated with the newly created Exchange.CADModel.
in_owns_entityWhether the newly created Exchange.CADModel owns the associated A3DAsmModelFile (see the documentation for Exchange.CADModel::GetEntityOwnership for more details).

◆ CreateCADModel() [2/4]

static HPS.Exchange.CADModel HPS.Exchange.Factory.CreateCADModel ( HPS.Model  in_model,
IntPtr  in_entity 
)
inlinestatic

Creates a new Exchange.CADModel.

Parameters
in_modelThe Model associated with the newly created Exchange.CADModel.
in_entityThe Exchange entity associated with the newly created Exchange.CADModel.

◆ CreateCADModel() [3/4]

static HPS.Exchange.CADModel HPS.Exchange.Factory.CreateCADModel ( HPS.Model  in_model)
inlinestatic

Creates a new Exchange.CADModel.

Parameters
in_modelThe Model associated with the newly created Exchange.CADModel.

◆ CreateCADModel() [4/4]

static HPS.Exchange.CADModel HPS.Exchange.Factory.CreateCADModel ( )
inlinestatic

Creates a new Exchange.CADModel.

◆ CreateCapture() [1/3]

static HPS.Exchange.Capture HPS.Exchange.Factory.CreateCapture ( HPS.Component  in_owner,
IntPtr  in_entity,
bool  in_is_default 
)
inlinestatic

Creates a new Exchange.Capture as a subcomponent of a given Component.

Parameters
in_ownerThe HPS.Component which owns the newly created Exchange.Capture.
in_entityThe Exchange entity associated with the newly created Exchange.Capture.
in_is_defaultWhether the newly created Exchange.Capture is the default capture for the CADModel, i.e., the capture that will be activated when CADModel.ActivateDefaultCapture is invoked. Note that if one is creating a default capture, the owner must be a CADModel (or subclass thereof) and this will delete the old default capture on that CADModel if one was present.

◆ CreateCapture() [2/3]

static HPS.Exchange.Capture HPS.Exchange.Factory.CreateCapture ( HPS.Component  in_owner,
IntPtr  in_entity 
)
inlinestatic

Creates a new Exchange.Capture as a subcomponent of a given Component.

Parameters
in_ownerThe HPS.Component which owns the newly created Exchange.Capture.
in_entityThe Exchange entity associated with the newly created Exchange.Capture.

◆ CreateCapture() [3/3]

static HPS.Exchange.Capture HPS.Exchange.Factory.CreateCapture ( HPS.Component  in_owner)
inlinestatic

Creates a new Exchange.Capture as a subcomponent of a given Component.

Parameters
in_ownerThe HPS.Component which owns the newly created Exchange.Capture.

◆ CreateComponent() [1/2]

static HPS.Exchange.Component HPS.Exchange.Factory.CreateComponent ( HPS.Component  in_owner,
HPS.Component.ComponentType  in_type,
IntPtr  in_entity 
)
inlinestatic

Creates a new Exchange.Component as a subcomponent of a given Component.

Parameters
in_ownerThe HPS.Component which owns the newly created Exchange.Component.
in_typeThe type of Exchange.Component to create.
in_entityThe Exchange entity associated with the newly created Exchange.Component.

◆ CreateComponent() [2/2]

static HPS.Exchange.Component HPS.Exchange.Factory.CreateComponent ( HPS.Component  in_owner,
HPS.Component.ComponentType  in_type 
)
inlinestatic

Creates a new Exchange.Component as a subcomponent of a given Component.

Parameters
in_ownerThe HPS.Component which owns the newly created Exchange.Component.
in_typeThe type of Exchange.Component to create.

◆ CreateFilter() [1/2]

static HPS.Exchange.Filter HPS.Exchange.Factory.CreateFilter ( HPS.Component  in_owner,
IntPtr  in_entity 
)
inlinestatic

Creates a new Exchange.Filter as a subcomponent of a given Component.

Parameters
in_ownerThe HPS.Component which owns the newly created Exchange.Filter.
in_entityThe Exchange entity associated with the newly created Exchange.Filter.

◆ CreateFilter() [2/2]

static HPS.Exchange.Filter HPS.Exchange.Factory.CreateFilter ( HPS.Component  in_owner)
inlinestatic

Creates a new Exchange.Filter as a subcomponent of a given Component.

Parameters
in_ownerThe HPS.Component which owns the newly created Exchange.Filter.

◆ CreateSheet() [1/2]

static HPS.Exchange.Sheet HPS.Exchange.Factory.CreateSheet ( HPS.Component  in_owner,
IntPtr  in_entity 
)
inlinestatic

Creates a new Exchange.Sheet as a subcomponent of a given Component.

Parameters
in_ownerThe HPS.Component which owns the newly created Exchange.Sheet.
in_entityThe Exchange entity associated with the newly created Exchange.Sheet.

◆ CreateSheet() [2/2]

static HPS.Exchange.Sheet HPS.Exchange.Factory.CreateSheet ( HPS.Component  in_owner)
inlinestatic

Creates a new Exchange.Sheet as a subcomponent of a given Component.

Parameters
in_ownerThe HPS.Component which owns the newly created Exchange.Sheet.

◆ DeInstanceComponent()

static HPS.Exchange.Component HPS.Exchange.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 ComponentPath passed to this function needs to include a component of type Representation Item.

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

The documentation for this class was generated from the following file:
  • internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs