|
| CADModel () |
| The default constructor creates an uninitialized CADModel object. The Type() function will return Type.None. More...
|
|
| CADModel (HPS.Component in_that) |
| This constructor creates a CADModel 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.CADModel object. Otherwise the copy will fail and the resulting Exchange.CADModel will be invalid. More...
|
|
| CADModel (HPS.CADModel in_that) |
| This constructor creates an Exchange.CADModel object that shares the underlying smart-pointer of the source HPS.CADModel. The copy will only be successful if the source component is really an upcast of an Exchange.CADModel object. Otherwise the copy will fail and the resulting Exchange.CADModel will be invalid. More...
|
|
| CADModel (HPS.Exchange.CADModel in_that) |
| This constructor creates an Exchange.CADModel object that shares the underlying smart-pointer of the source HPS.CADModel. The copy will only be successful if the source component is really an upcast of an Exchange.CADModel object. Otherwise the copy will fail and the resulting Exchange.CADModel will be invalid. More...
|
|
override void | Dispose () |
|
HPS.Component | GetComponentFromEntity (IntPtr in_entity) |
| Gets the Component associated with the given A3DEntity pointer (if any). More...
|
|
HPS.Exchange.Configuration[] | GetConfigurations () |
| Gets a list of configurations for this CADModel (if any). Only formats which support the concept of configurations can return a non-empty array, and only files of those formats which contain configurations will return a non-empty array. More...
|
|
string[] | GetCurrentConfiguration () |
| Gets the current configuration for this CADModel if it exists. Only formats which support the concept of configurations can have a current configuration, and only files of those formats which contain configurations will have a current configuration. More...
|
|
bool | GetEntityOwnership () |
| Whether this CADModel owns the associated A3DAsmModelFile or not. If this CADModel owns the associated A3DAsmModelFile, when it is deleted (via Exchange.CADModel.Delete), it will delete not only the associated Visualize components, segments and geometry but also the A3DAsmModelFile via A3DAsmModelFileDelete. If this CADModel does not own the associated A3DAsmModelFile, when it is deleted, it will only delete the associated Visualize components, segments and geometry, but not the A3DAsmModelFile. It will be up to the user to ensure the A3DAsmModelFile is deleted to reclaim any memory it has allocated in this case. More...
|
|
IntPtr | GetExchangeEntity () |
| Gets the A3DEntity pointer corresponding to this Exchange.CADModel. More...
|
|
HPS.Exchange.Sheet[] | GetSheets () |
|
void | HideAllPMI (HPS.Canvas in_canvas, ulong in_layer) |
| Forces the visibility of all PMI off in the given Canvas and layer. This will undo any hides, shows, isolates, or other highlights performed on PMI components contained within this CADModel via ComponentPath calls. More...
|
|
void | HideAllPMI (HPS.Canvas in_canvas) |
| Forces the visibility of all PMI off in the given Canvas and layer. This will undo any hides, shows, isolates, or other highlights performed on PMI components contained within this CADModel via ComponentPath calls. More...
|
|
override HPS.Type | ObjectType () |
|
HPS.Exchange.ReloadNotifier | Reload (HPS.Exchange.TessellationOptionsKit in_options, HPS.Exchange.TranslationOptionsKit in_translation_options) |
| Asynchronously reloads this CADModel. This will delete all underlying subcomponents and then reparse the underlying Exchange data. More...
|
|
HPS.Exchange.ReloadNotifier | Reload (HPS.Exchange.TessellationOptionsKit in_options) |
| Asynchronously reloads this CADModel. This will delete all underlying subcomponents and then reparse the underlying Exchange data. More...
|
|
HPS.Exchange.ReloadNotifier | Reload () |
| Asynchronously reloads this CADModel. This will delete all underlying subcomponents and then reparse the underlying Exchange data. More...
|
|
bool | ReplaceExchangeEntity (HPS.Component in_component, IntPtr in_a3d_entity) |
| Replace the Exchange entity associated with the provided component. You are required to sync the HPS model tree with the PRC structures after calling this via Reload. More...
|
|
void | SetAllPMIInFront (bool in_enable, HPS.Canvas in_canvas, ulong in_layer) |
| Forces all of the PMI in this CADModel to be rendered in front of the other geometry. contained within this CADModel via ComponentPath calls. More...
|
|
void | SetAllPMIInFront (bool in_enable, HPS.Canvas in_canvas) |
| Forces all of the PMI in this CADModel to be rendered in front of the other geometry. contained within this CADModel via ComponentPath calls. More...
|
|
void | ShowAllPMI (HPS.Canvas in_canvas, ulong in_layer) |
| Forces the visibility of all PMI on in the given Canvas and layer. This will undo any hides, shows, isolates, or other highlights performed on PMI components contained within this CADModel via ComponentPath calls. More...
|
|
void | ShowAllPMI (HPS.Canvas in_canvas) |
| Forces the visibility of all PMI on in the given Canvas and layer. This will undo any hides, shows, isolates, or other highlights performed on PMI components contained within this CADModel via ComponentPath calls. More...
|
|
void | Tessellate (HPS.Exchange.TessellationOptionsKit in_options) |
| Re-tessellate the given CADModel with the provided options. Tessellation occurs at the representation item level in Exchange. All representation items underneath this CADModel 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.TranslationOptionsKit in_translation_options) |
| Asynchronously translates this CADModel into an array of Parasolid parts, using the options provided. A valid Parasolid session is required for this function to succeed. If this CADModel was imported in tessellation only mode an empty Parasolid assembly will be returned. More...
|
|
HPS.View | ActivateDefaultCapture () |
| Creates a new View object corresponding to the default capture for this CADModel. The View object that is returned will have the corresponding visibility settings, material settings, transformation settings, and camera for the default capture set on it. More...
|
|
| CADModel () |
| The default constructor creates an uninitialized CADModel object. The Type() function will return Type.None. More...
|
|
| CADModel (HPS.Component in_that) |
| This constructor creates a CADModel 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 a CADModel object. Otherwise the copy will fail and the resulting CADModel will be invalid. More...
|
|
| CADModel (HPS.CADModel in_that) |
| The copy constructor creates a CADModel object that shares the underlying smart-pointer of the source CADModel. More...
|
|
| CADModel (HPS.Model in_that) |
| This constructor creates a CADModel object that is associated with the given Model. This will throw an exception if the given Model is not associated with a CADModel. More...
|
|
HPS.Filter[] | GetActiveFilters (HPS.View in_view) |
| Get a list of the active filters on the given View. More...
|
|
HPS.Capture[] | GetAllCaptures () |
| Get a list of all captures from all subcomponents for this CADModel. More...
|
|
HPS.Filter[] | GetAllFilters () |
| Get a list of all filters from all subcomponents for this CADModel. More...
|
|
HPS.Component | GetComponentFromKey (HPS.Key in_key) |
| Find the Component associated with the given Key (if any). More...
|
|
HPS.ComponentPath | GetComponentPath (HPS.KeyPath in_key_path, HPS.ComponentPath.PathType in_path_type) |
| Get the ComponentPath which corresponds to the given KeyPath. <linebreak><linebreak> The returned path will contain the Components which occurs along the given KeyPath, up to the CADModel. <linebreak><linebreak> If the path type requested is Unique, Components associated with keys which are implicitly along the key path will be included in the returned path, provided they can be determined unambiguously. <linebreak><linebreak> If the path type requested is Complete, all Components associated with keys which are implicitly along the path will be included in the returned path, if an entry cannot be determined unambiguously, it will be filled with the first eligible component found. <linebreak><linebreak> Example: a component with two owners will select the first owner out of the two, if the key path does not specify which of the two owners to consider, when using a Complete path type. It will instead not include any of the two owners when using Unique path type. <linebreak><linebreak> This function will throw an InvalidSpecificationException if the provided key path does not proceed from leaf to root. An error will be logged if the key path is ambiguous, and only components associated with the explicit keys in the key path will be returned in this case. More...
|
|
HPS.ComponentPath | GetComponentPath (HPS.KeyPath in_key_path) |
| Get the ComponentPath which corresponds to the given KeyPath. <linebreak><linebreak> The returned path will contain the Components which occurs along the given KeyPath, up to the CADModel. <linebreak><linebreak> If the path type requested is Unique, Components associated with keys which are implicitly along the key path will be included in the returned path, provided they can be determined unambiguously. <linebreak><linebreak> If the path type requested is Complete, all Components associated with keys which are implicitly along the path will be included in the returned path, if an entry cannot be determined unambiguously, it will be filled with the first eligible component found. <linebreak><linebreak> Example: a component with two owners will select the first owner out of the two, if the key path does not specify which of the two owners to consider, when using a Complete path type. It will instead not include any of the two owners when using Unique path type. <linebreak><linebreak> This function will throw an InvalidSpecificationException if the provided key path does not proceed from leaf to root. An error will be logged if the key path is ambiguous, and only components associated with the explicit keys in the key path will be returned in this case. More...
|
|
HPS.ComponentPath | GetComponentPath (HPS.SelectionItem in_item, HPS.ComponentPath.PathType in_path_type) |
| Get the ComponentPath which corresponds to the given SelectionItem. The returned path will be the Component associated with each key which occurs along the KeyPath associated with the SelectionItem, up to the CADModel. <linebreak><linebreak> If the path type requested is Unique, Components associated with keys which are implicitly along the key path will be included in the returned path, provided they can be determined unambiguously. <linebreak><linebreak> If the path type requested is Complete, all Components associated with keys which are implicitly along the path will be included in the returned path, if an entry cannot be determined unambiguously, it will be filled with the first eligible component found. <linebreak><linebreak> Example: a component with two owners will select the first owner out of the two, if the key path associated with the selection path does not specify which of the two owners to consider, when using a Complete path type. It will instead not include any of the two owners when using Unique path type. <linebreak><linebreak> This function will throw an InvalidSpecificationException if the provided key path does not proceed from leaf to root. An error will be logged if the key path is ambiguous, and only components associated with the explicit keys in the key path will be returned in this case. More...
|
|
HPS.ComponentPath | GetComponentPath (HPS.SelectionItem in_item) |
| Get the ComponentPath which corresponds to the given SelectionItem. The returned path will be the Component associated with each key which occurs along the KeyPath associated with the SelectionItem, up to the CADModel. <linebreak><linebreak> If the path type requested is Unique, Components associated with keys which are implicitly along the key path will be included in the returned path, provided they can be determined unambiguously. <linebreak><linebreak> If the path type requested is Complete, all Components associated with keys which are implicitly along the path will be included in the returned path, if an entry cannot be determined unambiguously, it will be filled with the first eligible component found. <linebreak><linebreak> Example: a component with two owners will select the first owner out of the two, if the key path associated with the selection path does not specify which of the two owners to consider, when using a Complete path type. It will instead not include any of the two owners when using Unique path type. <linebreak><linebreak> This function will throw an InvalidSpecificationException if the provided key path does not proceed from leaf to root. An error will be logged if the key path is ambiguous, and only components associated with the explicit keys in the key path will be returned in this case. More...
|
|
HPS.Model | GetModel () |
| Get the Model associated with this CADModel. More...
|
|
void | ResetVisibility (HPS.Canvas in_canvas, ulong in_layer) |
| Resets the visibility in the view specified by the given Canvas and layer. This will undo any hides, shows or isolates performed on components contained within this CADModel via ComponentPath calls. More...
|
|
void | ResetVisibility (HPS.Canvas in_canvas) |
| Resets the visibility in the view specified by the given Canvas and layer. This will undo any hides, shows or isolates performed on components contained within this CADModel via ComponentPath calls. 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) |
|
void | Delete () |
|
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 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 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...
|
|