The Factory class is used to create and Exchange objects which inherit from HPS::Component or one of its subclasses.
More...
|
override void | Dispose () |
|
| Sprocket (HPS.Sprocket in_that) |
|
IntPtr | GetClassID () |
|
| Object (HPS.Object in_that) |
| The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. 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...
|
|
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 bool | Empty () |
| Indicates whether this object has any values set on it. More...
|
|
virtual void | Reset () |
| Resets this object to its initial, uninitialized state. More...
|
|
bool | HasType (HPS.Type in_mask) |
| This function indicates whether this Object has the given Type mask. More...
|
|
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...
|
|
|
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.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.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.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.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 > () |
|
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
enum | UpdateType { Synchronous = 0,
Asynchronous = 1
} |
| The type of update to perform, either synchronous or asynchronous. More...
|
|
HandleRef | cptr |
|
HandleRef | scptr |
|
bool | cMemOwn |
|
The Factory class is used to create and Exchange objects which inherit from HPS::Component or one of its subclasses.
Creates a new Exchange::CADModel.
- Parameters
-
in_model | The Model associated with the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">Exchange::CADModel</ref>. |
in_entity | The <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref> entity associated with the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">Exchange::CADModel</ref>. |
in_owns_entity | Whether the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">Exchange::CADModel</ref> owns the associated A3DAsmModelFile (see the documentation for <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model_1afb206977d12bd43276c94f63c0a9e227" kindref="member">Exchange::CADModel::GetEntityOwnership</ref> for more details). |
Creates a new Exchange::CADModel.
- Parameters
-
in_model | The Model associated with the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">Exchange::CADModel</ref>. |
in_entity | The <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref> entity associated with the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">Exchange::CADModel</ref>. |
Creates a new Exchange::Capture as a subcomponent of a given Component.
- Parameters
-
in_owner | The HPS::Component which owns the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_capture" kindref="compound">Exchange::Capture</ref>. |
in_entity | The <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref> entity associated with the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_capture" kindref="compound">Exchange::Capture</ref>. |
in_is_default | Whether the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_capture" kindref="compound">Exchange::Capture</ref> is the default capture for the <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref>, 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 <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> (or subclass thereof) and this will delete the old default capture on that <ref refid="class_h_p_s_1_1_exchange_1_1_c_a_d_model" kindref="compound">CADModel</ref> if one was present. |
Creates a new Exchange::Capture as a subcomponent of a given Component.
- Parameters
-
in_owner | The HPS::Component which owns the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_capture" kindref="compound">Exchange::Capture</ref>. |
in_entity | The <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref> entity associated with the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_capture" kindref="compound">Exchange::Capture</ref>. |
Creates a new Exchange::Component as a subcomponent of a given Component.
- Parameters
-
in_owner | The HPS::Component which owns the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_component" kindref="compound">Exchange::Component</ref>. |
in_type | The type of <ref refid="class_h_p_s_1_1_exchange_1_1_component" kindref="compound">Exchange::Component</ref> to create. |
in_entity | The <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref> entity associated with the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_component" kindref="compound">Exchange::Component</ref>. |
Creates a new Exchange::Filter as a subcomponent of a given Component.
- Parameters
-
in_owner | The HPS::Component which owns the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_filter" kindref="compound">Exchange::Filter</ref>. |
in_entity | The <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref> entity associated with the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_filter" kindref="compound">Exchange::Filter</ref>. |
Creates a new Exchange::Sheet as a subcomponent of a given Component.
- Parameters
-
in_owner | The HPS::Component which owns the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_sheet" kindref="compound">Exchange::Sheet</ref>. |
in_entity | The <ref refid="class_h_p_s_1_1_exchange" kindref="compound">Exchange</ref> entity associated with the newly created <ref refid="class_h_p_s_1_1_exchange_1_1_sheet" kindref="compound">Exchange::Sheet</ref>. |
The documentation for this class was generated from the following file:
- internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs