HPS.Exchange.CADModel Class Reference
Inheritance diagram for HPS.Exchange.CADModel:
HPS.CADModel HPS.Component HPS.Sprocket HPS.Object

Public Member Functions

 CADModel ()
 
 CADModel (HPS.Component in_that)
 
 CADModel (HPS.CADModel in_that)
 
 CADModel (HPS.Exchange.CADModel in_that)
 
override void Dispose ()
 
HPS.Component GetComponentFromEntity (IntPtr in_entity)
 
HPS.Exchange.Configuration [] GetConfigurations ()
 
string [] GetCurrentConfiguration ()
 
bool GetEntityOwnership ()
 
IntPtr GetExchangeEntity ()
 
HPS.Exchange.Sheet [] GetSheets ()
 
void HideAllPMI (HPS.Canvas in_canvas, ulong in_layer)
 
void HideAllPMI (HPS.Canvas in_canvas)
 
override HPS.Type ObjectType ()
 
HPS.Exchange.ReloadNotifier Reload (HPS.Exchange.TessellationOptionsKit in_options, HPS.Exchange.TranslationOptionsKit in_translation_options)
 
HPS.Exchange.ReloadNotifier Reload (HPS.Exchange.TessellationOptionsKit in_options)
 
HPS.Exchange.ReloadNotifier Reload ()
 
bool ReplaceExchangeEntity (HPS.Component in_component, IntPtr in_a3d_entity)
 
void SetAllPMIInFront (bool in_enable, HPS.Canvas in_canvas, ulong in_layer)
 
void SetAllPMIInFront (bool in_enable, HPS.Canvas in_canvas)
 
void ShowAllPMI (HPS.Canvas in_canvas, ulong in_layer)
 
void ShowAllPMI (HPS.Canvas in_canvas)
 
void Tessellate (HPS.Exchange.TessellationOptionsKit in_options)
 
HPS.Exchange.TranslationNotifier Translate (HPS.Exchange.TranslationOptionsKit in_translation_options)
 
- Public Member Functions inherited from HPS.CADModel
HPS.View ActivateDefaultCapture ()
 
 CADModel ()
 
 CADModel (HPS.Component in_that)
 
 CADModel (HPS.CADModel in_that)
 
 CADModel (HPS.Model in_that)
 
HPS.Filter [] GetActiveFilters (HPS.View in_view)
 
HPS.Capture [] GetAllCaptures ()
 
HPS.Filter [] GetAllFilters ()
 
HPS.Component GetComponentFromKey (HPS.Key in_key)
 
HPS.ComponentPath GetComponentPath (HPS.KeyPath in_key_path, HPS.ComponentPath.PathType in_path_type)
 
HPS.ComponentPath GetComponentPath (HPS.KeyPath in_key_path)
 
HPS.ComponentPath GetComponentPath (HPS.SelectionItem in_item, HPS.ComponentPath.PathType in_path_type)
 
HPS.ComponentPath GetComponentPath (HPS.SelectionItem in_item)
 
HPS.Model GetModel ()
 
void ResetVisibility (HPS.Canvas in_canvas, ulong in_layer)
 
void ResetVisibility (HPS.Canvas in_canvas)
 
- Public Member Functions inherited from HPS.Component
void AddKey (HPS.Key in_key)
 
void AddOwner (HPS.Component in_owner, HPS.IncludeKey in_include)
 
void AddOwner (HPS.Component in_owner)
 
void AddReference (HPS.Component in_reference)
 
bool AddTransform (HPS.MatrixKit in_transform)
 
virtual void Assign (HPS.Component in_that)
 
 Component ()
 
 Component (HPS.Component in_that)
 
HPS.Component CopyTo (HPS.Component in_new_owner)
 
void Delete (HPS.Component.DeleteMode mode)
 
void Delete ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Component in_that)
 
void Flush ()
 
HPS.Metadata [] GetAllMetadata ()
 
HPS.Component [] GetAllSubcomponents (HPS.Component.ComponentType in_type)
 
HPS.Component.ComponentType GetComponentType ()
 
override int GetHashCode ()
 
HPS.Key [] GetKeys ()
 
HPS.Metadata GetMetadata (string in_name)
 
string GetName ()
 
HPS.Component [] GetOwners ()
 
HPS.Component [] GetReferences ()
 
HPS.Component [] GetReferrers ()
 
HPS.Component [] GetSubcomponents ()
 
bool HasComponentType (HPS.Component.ComponentType in_mask)
 
bool SetName (string in_new_name)
 
bool SetTransform (HPS.MatrixKit in_transform)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Public Types inherited from HPS.Component
enum  ComponentType : uint {
None = 0x00000000, GenericMask = 0xFFFFF000, ComponentType.ExchangeComponentMask = 0x00001000, ComponentType.ExchangeModelFile = 0x00001001,
ComponentType.ExchangeProductOccurrence = 0x00001002, ComponentType.ExchangePartDefinition = 0x00001003, ComponentType.ExchangeView = 0x00001004, ComponentType.ExchangeFilter = 0x00001005,
ComponentType.ExchangeRepresentationItemMask = 0x00003000, ComponentType.ExchangeRIBRepModel = 0x00003001, ComponentType.ExchangeRICurve = 0x00003002, ComponentType.ExchangeRIDirection = 0x00003003,
ComponentType.ExchangeRIPlane = 0x00003004, ComponentType.ExchangeRIPointSet = 0x00003005, ComponentType.ExchangeRIPolyBRepModel = 0x00003006, ComponentType.ExchangeRIPolyWire = 0x00003007,
ComponentType.ExchangeRISet = 0x00003008, ComponentType.ExchangeRICoordinateSystem = 0x00003009, ComponentType.ExchangeTopologyMask = 0x00005000, ComponentType.ExchangeTopoBody = 0x00005001,
ComponentType.ExchangeTopoConnex = 0x00005002, ComponentType.ExchangeTopoShell = 0x00005003, ComponentType.ExchangeTopoFace = 0x00005004, ComponentType.ExchangeTopoLoop = 0x00005005,
ComponentType.ExchangeTopoCoEdge = 0x00005006, ComponentType.ExchangeTopoEdge = 0x00005007, ComponentType.ExchangeTopoVertex = 0x00005008, ComponentType.ExchangeTopoSingleWireBody = 0x00005009,
ComponentType.ExchangeTopoWireEdge = 0x0000500A, ComponentType.ExchangeDrawingMask = 0x00009000, ComponentType.ExchangeDrawingModel = 0x00009001, ComponentType.ExchangeDrawingView = 0x00009002,
ComponentType.ExchangeDrawingSheet = 0x00009003, ComponentType.ExchangeBasicDrawingBlock = 0x00009004, ComponentType.ExchangeOperatorDrawingBlock = 0x00009005, ComponentType.ExchangePMIMask = 0x00011000,
ComponentType.ExchangePMI = 0x00011000, ComponentType.ExchangePMIText = 0x00011100, ComponentType.ExchangePMIRichText = 0x00011200, ComponentType.ExchangePMIRoughness = 0x00011300,
ComponentType.ExchangePMIGDT = 0x00011400, ComponentType.ExchangePMIDatum = 0x00011500, ComponentType.ExchangePMILineWelding = 0x00011600, ComponentType.ExchangePMISpotWelding = 0x00011700,
ComponentType.ExchangePMIDimension = 0x00011800, ComponentType.ExchangePMIBalloon = 0x00011900, ComponentType.ExchangePMICoordinate = 0x00011A00, ComponentType.ExchangePMIFastener = 0x00011B00,
ComponentType.ExchangePMILocator = 0x00011C00, ComponentType.ExchangePMIMeasurementPoint = 0x00011D00, ComponentType.ParasolidComponentMask = 0x00020000, ComponentType.ParasolidModelFile = 0x00020001,
ComponentType.ParasolidAssembly = 0x00020002, ComponentType.ParasolidInstance = 0x00020003, ComponentType.ParasolidTopologyMask = 0x00060000, ComponentType.ParasolidTopoBody = 0x00060001,
ComponentType.ParasolidTopoRegion = 0x00060002, ComponentType.ParasolidTopoShell = 0x00060003, ComponentType.ParasolidTopoFace = 0x00060004, ComponentType.ParasolidTopoLoop = 0x00060005,
ComponentType.ParasolidTopoFin = 0x00060006, ComponentType.ParasolidTopoEdge = 0x00060007, ComponentType.ParasolidTopoVertex = 0x00060008, ComponentType.DWGComponentMask = 0x00100000,
ComponentType.DWGModelFile = 0x00100001, ComponentType.DWGLayout = 0x00100002, ComponentType.DWGBlockTable = 0x00100003, ComponentType.DWGBlockTableRecord = 0x00100004,
ComponentType.DWGEntity = 0x00100005, ComponentType.DWGLayerTable = 0x00100006, ComponentType.DWGLayer = 0x00100007, ComponentType.UserComponent = 0x01000000
}





 
enum  DeleteMode { Standard = 0, Full = 1, StandardAndExchange = 2 }
 
- Static Public Member Functions inherited from HPS.Component
static HPS.KeyPath [] GetKeyPath (HPS.Component in_component)
 
static HPS.KeyPath [] GetKeyPath (HPS.Component[] in_components)
 
static bool operator!= (HPS.Component a, HPS.Component b)
 
static bool operator== (HPS.Component a, HPS.Component b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The CADModel class is a smart pointer. It represents an A3DAsmModelFile in Exchange. The primary purpose of this class is simply to provide access to the underlying A3DAsmModelFile pointer for use by Exchange library functions.

Constructor & Destructor Documentation

◆ CADModel() [1/4]

HPS.Exchange.CADModel.CADModel ( )
inline

The default constructor creates an uninitialized CADModel object. The Type() function will return Type.None.

◆ CADModel() [2/4]

HPS.Exchange.CADModel.CADModel ( HPS.Component  in_that)
inline

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.

Parameters
in_thatThe source Component to copy.

◆ CADModel() [3/4]

HPS.Exchange.CADModel.CADModel ( HPS.CADModel  in_that)
inline

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.

Parameters
in_thatThe source HPS.CADModel to copy.

◆ CADModel() [4/4]

HPS.Exchange.CADModel.CADModel ( HPS.Exchange.CADModel  in_that)
inline

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.

Parameters
in_thatThe source HPS.CADModel to copy.

Member Function Documentation

◆ GetComponentFromEntity()

HPS.Component HPS.Exchange.CADModel.GetComponentFromEntity ( IntPtr  in_entity)
inline

Gets the Component associated with the given A3DEntity pointer (if any).

Parameters
in_entityThe A3DEntity pointer from which to find the associated Component.
Returns
The Component associated with the given A3DEntity pointer, or an empty component if there is no such Component.

◆ GetConfigurations()

HPS.Exchange.Configuration [] HPS.Exchange.CADModel.GetConfigurations ( )
inline

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.

Returns
The list of configurations for this CADModel.

◆ GetCurrentConfiguration()

string [] HPS.Exchange.CADModel.GetCurrentConfiguration ( )
inline

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.

Returns
The current configuration for this CADModel.

◆ GetEntityOwnership()

bool HPS.Exchange.CADModel.GetEntityOwnership ( )
inline

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.

Returns
Whether this CADModel owns the associated A3DAsmModelFile.

◆ GetExchangeEntity()

IntPtr HPS.Exchange.CADModel.GetExchangeEntity ( )
inline

Gets the A3DEntity pointer corresponding to this Exchange.CADModel.

Returns
The A3DEntity pointer corresponding to this Exchange.CADModel.

◆ HideAllPMI() [1/2]

void HPS.Exchange.CADModel.HideAllPMI ( HPS.Canvas  in_canvas,
ulong  in_layer 
)
inline

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.

Parameters
in_canvasThe Canvas in which to perform the the operation
in_layerThe layer in the Canvas in which to perform the operation.

◆ HideAllPMI() [2/2]

void HPS.Exchange.CADModel.HideAllPMI ( HPS.Canvas  in_canvas)
inline

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.

Parameters
in_canvasThe Canvas in which to perform the the operation

◆ ObjectType()

override HPS.Type HPS.Exchange.CADModel.ObjectType ( )
inlinevirtual

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

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

Reimplemented from HPS.CADModel.

◆ Reload() [1/3]

HPS.Exchange.ReloadNotifier HPS.Exchange.CADModel.Reload ( HPS.Exchange.TessellationOptionsKit  in_options,
HPS.Exchange.TranslationOptionsKit  in_translation_options 
)
inline

Asynchronously reloads this CADModel. This will delete all underlying subcomponents and then reparse the underlying Exchange data.

Parameters
in_optionsThe options to use to generate tessellations for new Components (if necessary).
in_translation_optionsThe 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.

◆ Reload() [2/3]

HPS.Exchange.ReloadNotifier HPS.Exchange.CADModel.Reload ( HPS.Exchange.TessellationOptionsKit  in_options)
inline

Asynchronously reloads this CADModel. This will delete all underlying subcomponents and then reparse the underlying Exchange data.

Parameters
in_optionsThe options to use to generate tessellations for new Components (if necessary).

◆ Reload() [3/3]

HPS.Exchange.ReloadNotifier HPS.Exchange.CADModel.Reload ( )
inline

Asynchronously reloads this CADModel. This will delete all underlying subcomponents and then reparse the underlying Exchange data.

◆ ReplaceExchangeEntity()

bool HPS.Exchange.CADModel.ReplaceExchangeEntity ( HPS.Component  in_component,
IntPtr  in_a3d_entity 
)
inline

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.

Parameters
in_componentThe component whose entity is to be replaced.
in_a3d_entityThe new entity that will be associated with in_component.
Returns
true if the new entity was associated successfully, false otherwise.
See also
Reload

◆ SetAllPMIInFront() [1/2]

void HPS.Exchange.CADModel.SetAllPMIInFront ( bool  in_enable,
HPS.Canvas  in_canvas,
ulong  in_layer 
)
inline

Forces all of the PMI in this CADModel to be rendered in front of the other geometry. contained within this CADModel via ComponentPath calls.

Parameters
in_enableDictates whether the pmi will be forced in front or not.
in_canvasThe Canvas in which to perform the the operation
in_layerThe layer in the Canvas in which to perform the operation.

◆ SetAllPMIInFront() [2/2]

void HPS.Exchange.CADModel.SetAllPMIInFront ( bool  in_enable,
HPS.Canvas  in_canvas 
)
inline

Forces all of the PMI in this CADModel to be rendered in front of the other geometry. contained within this CADModel via ComponentPath calls.

Parameters
in_enableDictates whether the pmi will be forced in front or not.
in_canvasThe Canvas in which to perform the the operation

◆ ShowAllPMI() [1/2]

void HPS.Exchange.CADModel.ShowAllPMI ( HPS.Canvas  in_canvas,
ulong  in_layer 
)
inline

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.

Parameters
in_canvasThe Canvas in which to perform the the operation
in_layerThe layer in the Canvas in which to perform the operation.

◆ ShowAllPMI() [2/2]

void HPS.Exchange.CADModel.ShowAllPMI ( HPS.Canvas  in_canvas)
inline

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.

Parameters
in_canvasThe Canvas in which to perform the the operation

◆ Tessellate()

void HPS.Exchange.CADModel.Tessellate ( HPS.Exchange.TessellationOptionsKit  in_options)
inline

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.

Parameters
in_optionsThe options to use to generate the new tessellation for this CADModel

◆ Translate()

HPS.Exchange.TranslationNotifier HPS.Exchange.CADModel.Translate ( HPS.Exchange.TranslationOptionsKit  in_translation_options)
inline

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.

Parameters
in_translation_optionsOptions used during the translation.
Returns
An TranslationNotifier object that can be used to query the import progress and status.

The documentation for this class was generated from the following file:
  • internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs