The Factory class is used to create and Exchange objects which inherit from HPS::Component or one of its subclasses. More...

Public Member Functions | |
override void | Dispose () |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
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... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
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 void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
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... | |
Static Public Member Functions | |
static HPS.Exchange.CADModel | CreateCADModel (HPS.Model in_model, IntPtr in_entity, bool in_owns_entity) |
Creates a new Exchange::CADModel. More... | |
static HPS.Exchange.CADModel | CreateCADModel (HPS.Model in_model, IntPtr in_entity) |
Creates a new Exchange::CADModel. More... | |
static HPS.Exchange.CADModel | CreateCADModel (HPS.Model in_model) |
Creates a new Exchange::CADModel. More... | |
static HPS.Exchange.CADModel | CreateCADModel () |
Creates a new Exchange::CADModel. More... | |
static HPS.Exchange.Capture | CreateCapture (HPS.Component in_owner, IntPtr in_entity, bool in_is_default) |
Creates a new Exchange::Capture as a subcomponent of a given Component. More... | |
static HPS.Exchange.Capture | CreateCapture (HPS.Component in_owner, IntPtr in_entity) |
Creates a new Exchange::Capture as a subcomponent of a given Component. More... | |
static HPS.Exchange.Capture | CreateCapture (HPS.Component in_owner) |
Creates a new Exchange::Capture as a subcomponent of a given Component. More... | |
static HPS.Exchange.Component | CreateComponent (HPS.Component in_owner, HPS.Component.ComponentType in_type, IntPtr in_entity) |
Creates a new Exchange::Component as a subcomponent of a given Component. More... | |
static HPS.Exchange.Component | CreateComponent (HPS.Component in_owner, HPS.Component.ComponentType in_type) |
Creates a new Exchange::Component as a subcomponent of a given Component. More... | |
static HPS.Exchange.Filter | CreateFilter (HPS.Component in_owner, IntPtr in_entity) |
Creates a new Exchange::Filter as a subcomponent of a given Component. More... | |
static HPS.Exchange.Filter | CreateFilter (HPS.Component in_owner) |
Creates a new Exchange::Filter as a subcomponent of a given Component. More... | |
static HPS.Exchange.Sheet | CreateSheet (HPS.Component in_owner, IntPtr in_entity) |
Creates a new Exchange::Sheet as a subcomponent of a given Component. More... | |
static HPS.Exchange.Sheet | CreateSheet (HPS.Component in_owner) |
Creates a new Exchange::Sheet as a subcomponent of a given Component. More... | |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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
|
inlinestatic |
Creates a new Exchange::CADModel.
- Parameters
-
in_model The Model associated with the newly created Exchange::CADModel. in_entity The Exchange entity associated with the newly created Exchange::CADModel. in_owns_entity Whether the newly created Exchange::CADModel owns the associated A3DAsmModelFile (see the documentation for Exchange::CADModel::GetEntityOwnership for more details).
|
inlinestatic |
Creates a new Exchange::CADModel.
- Parameters
-
in_model The Model associated with the newly created Exchange::CADModel. in_entity The Exchange entity associated with the newly created Exchange::CADModel.
|
inlinestatic |
Creates a new Exchange::CADModel.
- Parameters
-
in_model The Model associated with the newly created Exchange::CADModel.
|
inlinestatic |
Creates a new Exchange::CADModel.
|
inlinestatic |
Creates a new Exchange::Capture as a subcomponent of a given Component.
- Parameters
-
in_owner The HPS::Component which owns the newly created Exchange::Capture. in_entity The Exchange entity associated with the newly created Exchange::Capture. in_is_default Whether 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.
|
inlinestatic |
Creates a new Exchange::Capture as a subcomponent of a given Component.
- Parameters
-
in_owner The HPS::Component which owns the newly created Exchange::Capture. in_entity The Exchange entity associated with the newly created Exchange::Capture.
|
inlinestatic |
Creates a new Exchange::Capture as a subcomponent of a given Component.
- Parameters
-
in_owner The HPS::Component which owns the newly created Exchange::Capture.
|
inlinestatic |
Creates a new Exchange::Component as a subcomponent of a given Component.
- Parameters
-
in_owner The HPS::Component which owns the newly created Exchange::Component. in_type The type of Exchange::Component to create. in_entity The Exchange entity associated with the newly created Exchange::Component.
|
inlinestatic |
Creates a new Exchange::Component as a subcomponent of a given Component.
- Parameters
-
in_owner The HPS::Component which owns the newly created Exchange::Component. in_type The type of Exchange::Component to create.
|
inlinestatic |
Creates a new Exchange::Filter as a subcomponent of a given Component.
- Parameters
-
in_owner The HPS::Component which owns the newly created Exchange::Filter. in_entity The Exchange entity associated with the newly created Exchange::Filter.
|
inlinestatic |
Creates a new Exchange::Filter as a subcomponent of a given Component.
- Parameters
-
in_owner The HPS::Component which owns the newly created Exchange::Filter.
|
inlinestatic |
Creates a new Exchange::Sheet as a subcomponent of a given Component.
- Parameters
-
in_owner The HPS::Component which owns the newly created Exchange::Sheet. in_entity The Exchange entity associated with the newly created Exchange::Sheet.
|
inlinestatic |
Creates a new Exchange::Sheet as a subcomponent of a given Component.
- Parameters
-
in_owner The HPS::Component which owns the newly created Exchange::Sheet.
The documentation for this class was generated from the following file:
- internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs