HPS::Exchange::Component

class HPS.Exchange.Component : public HPS.Component 

The Component class is a smart pointer. It represents a variety of Exchange components. The primary purpose of this class is simply to provide access to the underlying A3DEntity pointer for use by Exchange library functions.

Subclassed by HPS.Exchange.ProductOccurrence, HPS.Exchange.Sheet

Public Functions

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.

Param in_transform: The transform to apply to this component.
Return: true if transform was applied correctly, false otherwise.

Component (): The default constructor creates an uninitialized Exchange.Component object. The Type() function will return Type.None.

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.

Param in_that: The source Component to copy.

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.

Param in_that: The source Component to copy.

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.

See: Reload

Param in_new_owner: The component which will be the owner of the newly created component.
Return: The newly created component.

override void Dispose ()

IntPtr GetExchangeEntity ()

Gets the A3DEntity pointer corresponding to this ExchangeComponent.

Return: The A3DEntity pointer corresponding to this ExchangeComponent.

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).

Return: The declared type of the object in question, which may differ from the true, underlying type.

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.

Return: A ReloadNotifier object that can be used to query the reload progress and status.

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.

Param in_tessellation_options: The options to use to generate tessellations for new Components (if necessary).
Return: A ReloadNotifier object that can be used to query the reload progress and status.

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.

Param in_tessellation_options: The options to use to generate tessellations for new Components (if necessary).
Param in_translation_options: The options to use for translation from Exchange BRep to Parasolid. This option only applies if a file was loaded via the ExchangeParasolid module and there are components underlying this component that need to be translated to Parasolid.
Return: A ReloadNotifier object that can be used to query the reload progress and status.

bool SetName (string in_new_name)

Rename this component in the PRC.

Param in_new_name: The new name of the A3DEntity.
Return: true if the name was set successfully, false otherwise.

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.

Param in_transform: The transform to apply to this component.
Return: true if transform was applied correctly, false otherwise.

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.

Param in_options: The options to use to generate the new tessellation for this Component.

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.

Param in_units: The units for the representation item
Param in_translation_options: Options used during the translation.
Return: A TranslationNotifier object that can be used to query the translation progress and status.