|
override void | Dispose () |
|
override bool | Equals (System.Object obj) |
|
bool | Equals (HPS.Exchange.ProductOccurrence in_kit) |
| Check if the source ProductOccurrence is equivalent to this ProductOccurrence. More...
|
|
override int | GetHashCode () |
|
HPS.Exchange.LoadStatus | GetLoadStatus () |
| Gets the load status for this product occurrence. This is primarily relevant for product occurrences coming from formats that support incremental loading. For product occurrences coming from formats that don't support incremental loading, it can provide information about which product occurrences contain no data or could not be loaded (e.g., if there are missing files in an assembly), however, such product occurrences are still not capable of being incrementally loaded. More...
|
|
bool | IsExternalData () |
| This function will check if the A3DEntity under the HPS.Exchange.Component from where we call it is an External Data Product Occurrence or not. More...
|
|
override HPS.Type | ObjectType () |
| This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object). More...
|
|
| ProductOccurrence () |
| The default constructor creates an empty ProductOccurrence object. More...
|
|
| ProductOccurrence (HPS.Component in_that) |
| This constructor creates a ProductOccurrence object that shares the underlying smart-pointer of the source Component. The copy will only be successful if the source component is really an upcast of an Exchange.ProductOccurrence object. Otherwise the copy will fail and the resulting Exchange.ProductOccurrence will be invalid. More...
|
|
| ProductOccurrence (HPS.Exchange.Component in_that) |
| This constructor creates a ProductOccurrence object that shares the underlying smart-pointer of the source Component. The copy will only be successful if the source component is really an upcast of an Exchange.ProductOccurrence object. Otherwise the copy will fail and the resulting Exchange.ProductOccurrence will be invalid. More...
|
|
| ProductOccurrence (HPS.Exchange.ProductOccurrence in_sheet) |
| The copy constructor creates a new ProductOccurrence object that contains the same settings as the source ProductOccurrence. More...
|
|
void | Unload (HPS.Exchange.UnloadMode in_mode) |
| Unloads this product occurrence. This will remove the underlying data from Exchange for this component and potentially also the corresponding component objects depending on the specified UnloadMode. This operation can only be performed for product occurrence components coming from file formats that support incremental loading (see ImportMode.Incremental). If you try to unload a product occurrence coming from a format that does not support incremental loading, an exception will be thrown. More...
|
|
void | Unload () |
| Unloads this product occurrence. This will remove the underlying data from Exchange for this component and potentially also the corresponding component objects depending on the specified UnloadMode. This operation can only be performed for product occurrence components coming from file formats that support incremental loading (see ImportMode.Incremental). If you try to unload a product occurrence coming from a format that does not support incremental loading, an exception will be thrown. More...
|
|
bool | AddTransform (HPS.MatrixKit in_transform) |
| Appends a transform to the underlying PRC data associated with this component. Only components of type ExchangeProductOccurrence, or components that have the type ExchangeRepresentationItemMask can have transforms applied to them. Additionally, AddTransform does not work on Exchange models which have a Drawing structure to them. This would include CATDrawing files and 2D DWG files loaded through Exchange. Any attempt to use this function on those models will produce a warning. More...
|
|
| Component () |
| The default constructor creates an uninitialized Exchange.Component object. The Type() function will return Type.None. More...
|
|
| Component (HPS.Component in_that) |
| This constructor creates an Exchange.Component object that shares the underlying smart-pointer of the source Component. The copy will only be successful if the source component is really an upcast of an Exchange.Component object. Otherwise the copy will fail and the resulting Exchange.Component will be invalid. More...
|
|
| Component (HPS.Exchange.Component in_that) |
| This constructor creates an Exchange.Component object that shares the underlying smart-pointer of the source Component. The copy will only be successful if the source component is really an upcast of an Exchange.Component object. Otherwise the copy will fail and the resulting Exchange.Component will be invalid. More...
|
|
HPS.Component | CopyTo (HPS.Component in_new_owner) |
| Create a copy of this component under another component. This function will create a copy of the A3DEntity underlying this component and put it under the Exchange entity associated with the new owner. It will also create a new component, the keys associated to it and include those keys under the new owner. You are required to sync the HPS model tree with the PRC structures after calling this via Reload. More...
|
|
IntPtr | GetExchangeEntity () |
| Gets the A3DEntity pointer corresponding to this ExchangeComponent. More...
|
|
HPS.Exchange.ReloadNotifier | Reload (HPS.Exchange.TessellationOptionsKit in_tessellation_options, HPS.Exchange.TranslationOptionsKit in_translation_options) |
| Asynchronously reloads this component. This will delete all underlying subcomponents and then reparse the underlying Exchange data. This function should be invoked on the Component corresponding to an entity which was edited or a Component above such a Component. More...
|
|
HPS.Exchange.ReloadNotifier | Reload (HPS.Exchange.TessellationOptionsKit in_tessellation_options) |
| Asynchronously reloads this component. This will delete all underlying subcomponents and then reparse the underlying Exchange data. This function should be invoked on the Component corresponding to an entity which was edited or a Component above such a Component. More...
|
|
HPS.Exchange.ReloadNotifier | Reload () |
| Asynchronously reloads this component. This will delete all underlying subcomponents and then reparse the underlying Exchange data. This function should be invoked on the Component corresponding to an entity which was edited or a Component above such a Component. More...
|
|
bool | SetName (string in_new_name) |
| Rename this component in the PRC. More...
|
|
bool | SetTransform (HPS.MatrixKit in_transform) |
| Applies a transform to the underlying PRC data associated with this component, replacing any transform currently set on it. Only components of type ExchangeProductOccurrence, or components that have the type ExchangeRepresentationItemMask can have transforms applied to them. Additionally, SetTransform does not work on Exchange models which have a Drawing structure to them. This would include CATDrawing files and 2D DWG files loaded through Exchange. Any attempt to use this function on those models will produce a warning. More...
|
|
void | Tessellate (HPS.Exchange.TessellationOptionsKit in_options) |
| Re-tessellate the given Component with the provided options. Tessellation occurs at the representation item level in Exchange, so calling this function on Component objects below that level will have no effect. If this function is invoked on Component objects above that level, e.g., at the product occurrence level, all representation items underneath that Component will be re-tessellated with the provided options. Additionally, only components for which there is BRep data can the tessellation be regenerated. More...
|
|
HPS.Exchange.TranslationNotifier | Translate (HPS.Exchange.Units in_units, HPS.Exchange.TranslationOptionsKit in_translation_options) |
| Asynchronously translates this component into an array of Parasolid parts, using the options provided. A valid Parasolid session is required for this function to succeed. The component has to be a Representation Item for this function to succeed. More...
|
|
void | AddKey (HPS.Key in_key) |
| Adds a key to be associated with this Component. This will additionally ensure this key can be used to find this Component via CADModel.GetComponentFromKey on the owning CADModel. In general, this will either be a SegmentKey or a GeometryKey (or a subclass thereof), but it may also be an IncludeKey, which is necessary for an instanced Component. If an IncludeKey is associated with this Component, the underlying target of the include will be associated with this Component, though the include will be stored as well to determine things like the associated KeyPath correctly. More...
|
|
void | AddOwner (HPS.Component in_owner, HPS.IncludeKey in_include) |
| Adds an owner to this Component. This is intended to facilitate adding additional owners to an instanced Component, and allows specifying the associated IncludeKey for the additional owner. It is possible to add an owner without adding an IncludeKey, and, if desired, add the IncludeKey separately via AddKey. More...
|
|
void | AddOwner (HPS.Component in_owner) |
| Adds an owner to this Component. This is intended to facilitate adding additional owners to an instanced Component, and allows specifying the associated IncludeKey for the additional owner. It is possible to add an owner without adding an IncludeKey, and, if desired, add the IncludeKey separately via AddKey. More...
|
|
void | AddReference (HPS.Component in_reference) |
| Adds a Component as a reference to this Component. More...
|
|
bool | AddTransform (HPS.MatrixKit in_transform) |
| Appends a transform to the underlying PRC or Parasolid data associated with this component. More...
|
|
virtual void | Assign (HPS.Component in_that) |
| Share the underlying smart-pointer of the Component source. More...
|
|
| Component () |
| The default constructor creates an uninitialized Component object. The Type() function will return Type.None. More...
|
|
| Component (HPS.Component in_that) |
| The copy constructor creates a Component object that shares the underlying smart-pointer of the source Component. More...
|
|
HPS.Component | CopyTo (HPS.Component in_new_owner) |
| Creates a deep copy of this component under another component. Please note how entity copying is handled for each type of entity: More...
|
|
void | Delete (HPS.Component.DeleteMode mode) |
| The behavior of the Delete function varies according to the type of object it's being called on. More...
|
|
void | Delete () |
| The behavior of the Delete function varies according to the type of object it's being called on. More...
|
|
override bool | Equals (System.Object obj) |
|
bool | Equals (HPS.Component in_that) |
| Check if the source Component points to the same underlying impl as this Component. More...
|
|
void | Flush () |
| Removes all references to the underlying subcomponents, but leaves this Component around. If a subcomponent of the component being flushed has multiple owners, the flush will simply remove the reference to that subcomponent. If a subcomponent of the component being flushed has only one owner (the component being flushed), that subcomponent will be deleted. Any handles to the deleted components will become invalid. More...
|
|
HPS.Metadata [] | GetAllMetadata () |
| Get all Metadata objects associated with this Component. More...
|
|
HPS.Component [] | GetAllSubcomponents (HPS.Component.ComponentType in_type) |
| Gets all components under this Component that have the specified ComponentType mask. This will examine this subcomponents of this Component, the subcomponents of the subcomponents, and so on. More...
|
|
HPS.Component.ComponentType | GetComponentType () |
| Gets the specific format-dependent type this Component represents. More...
|
|
override int | GetHashCode () |
|
HPS.Key [] | GetKeys () |
| Get the underlying keys (if any) which represent this Component. Generally this will either be a segment or geometry key. More...
|
|
HPS.Metadata | GetMetadata (string in_name) |
| Get the single Metadata object with the given name associated with this Component (if present). More...
|
|
string | GetName () |
| Gets the name for this Component. This is a convenience function equivalent to getting the "Name" metadata for this Component. If a Component does not have a name, an empty UTF8 object will be returned. More...
|
|
HPS.Component [] | GetOwners () |
| Get the Component objects (if any) which "own" this Component. Generally this will be a single element or no elements for a root component. It is possible for there to be multiple owners of a Component if it is instanced (i.e., it may have both a prototype and a containing Component). More...
|
|
HPS.Component [] | GetReferences () |
| Get the Component objects (if any) which are referenced by this Component. These are Component objects which are associated with this Component, but not "owned" by this Component, and would not be deleted if this Component is deleted (though the reference relationship will be removed). More...
|
|
HPS.Component [] | GetReferrers () |
| Gets the Component objects which refer to this Component (if any). These relationships are defined in the original CAD file and can be arbitrarily assigned between Components. <linebreak><linebreak> For the Exchange implementation of the Component hierarchy, Referrers will typically indicate which PMI elements refer to the Component being inspected. More...
|
|
HPS.Component [] | GetSubcomponents () |
| Get the subcomponent objects (if any) owned or referenced by this Component. These Component objects would be deleted if this Component is deleted. More...
|
|
bool | HasComponentType (HPS.Component.ComponentType in_mask) |
| This function indicates whether this Component has the given ComponentType mask. More...
|
|
bool | SetName (string in_new_name) |
| Sets the name for this component. More...
|
|
bool | SetTransform (HPS.MatrixKit in_transform) |
| Applies a transform to the underlying PRC or Parasolid data associated with this component, replacing any transforms currently set on it. More...
|
|
| Sprocket (HPS.Sprocket in_that) |
|
virtual bool | Empty () |
| Indicates whether this object has any values set on it. More...
|
|
IntPtr | GetClassID () |
|
IntPtr | GetInstanceID () |
| Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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 void | Reset () |
| Resets this object to its initial, uninitialized state. More...
|
|
virtual 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...
|
|