#include <sprk_exchange.h>

Public Member Functions | |
CADModel () | |
CADModel (Component const &in_that) | |
CADModel (HPS::CADModel const &in_that) | |
CADModel (Exchange::CADModel const &in_that) | |
CADModel (Exchange::CADModel &&in_that) | |
HPS::Component | GetComponentFromEntity (A3DEntity *in_entity) const |
ConfigurationArray | GetConfigurations () const |
UTF8Array | GetCurrentConfiguration () const |
bool | GetEntityOwnership () const |
A3DEntity * | GetExchangeEntity () const |
SheetArray | GetSheets () const |
void | HideAllPMI (Canvas &in_canvas, size_t in_layer=0) |
HPS::Type | ObjectType () const |
CADModel & | operator= (Exchange::CADModel &&in_that) |
ReloadNotifier | Reload (TessellationOptionsKit const &in_options=TessellationOptionsKit(), TranslationOptionsKit const &in_translation_options=TranslationOptionsKit()) |
void | ShowAllPMI (Canvas &in_canvas, size_t in_layer=0) |
void | Tessellate (TessellationOptionsKit const &in_options) |
TranslationNotifier | Translate (TranslationOptionsKit const &in_translation_options) |
![]() | |
View | ActivateDefaultCapture () |
CADModel () | |
CADModel (Component const &in_that) | |
CADModel (CADModel const &in_that) | |
CADModel (CADModel &&in_that) | |
CADModel (Model const &in_that) | |
FilterArray | GetActiveFilters (View const &in_view) const |
CaptureArray | GetAllCaptures () const |
FilterArray | GetAllFilters () const |
Component | GetComponentFromKey (Key const &in_key) const |
ComponentPath | GetComponentPath (KeyPath const &in_key_path) const |
ComponentPath | GetComponentPath (SelectionItem const &in_item) const |
Model | GetModel () const |
CADModel & | operator= (CADModel &&in_that) |
void | ResetVisibility (Canvas &in_canvas, size_t in_layer=0) |
![]() | |
void | AddKey (Key const &in_key) |
void | AddOwner (Component &in_owner, IncludeKey const &in_include=IncludeKey()) |
void | AddReference (Component &in_reference) |
virtual void | Assign (Component const &in_that) |
Component () | |
Component (Component const &in_that) | |
Component (Component &&in_that) | |
void | Delete () |
bool | Equals (Component const &in_that) const |
void | Flush () |
MetadataArray | GetAllMetadata () const |
ComponentArray | GetAllSubcomponents (ComponentType in_type) const |
ComponentType | GetComponentType () const |
KeyArray | GetKeys () const |
Metadata | GetMetadata (char const *in_name) const |
UTF8 | GetName () const |
ComponentArray | GetOwners () const |
ComponentArray | GetReferences () const |
ComponentArray | GetReferrers () const |
ComponentArray | GetSubcomponents () const |
bool | HasComponentType (ComponentType in_mask) const |
bool | operator!= (Component const &in_that) const |
Component & | operator= (Component const &in_that) |
Component & | operator= (Component &&in_that) |
bool | operator== (Component const &in_that) const |
virtual | ~Component () |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
virtual HPS::Type | Type () const |
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
HPS::Exchange::CADModel::CADModel | ( | ) |
HPS::Exchange::CADModel::CADModel | ( | Component const & | 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.
- Parameters
-
in_that The source Component to copy.
HPS::Exchange::CADModel::CADModel | ( | HPS::CADModel const & | 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.
- Parameters
-
in_that The source HPS::CADModel to copy.
HPS::Exchange::CADModel::CADModel | ( | Exchange::CADModel const & | in_that | ) |
The copy constructor creates an Exchange::CADModel object that shares the underlying smart-pointer of the source Exchange::CADModel.
- Parameters
-
in_that The source Exchange::CADModel to copy.
HPS::Exchange::CADModel::CADModel | ( | Exchange::CADModel && | in_that | ) |
The move constructor creates an Exchange::CADModel by transferring the underlying object of the rvalue reference to this Exchange::CADModel.
- Parameters
-
in_that An rvalue reference to an Exchange::CADModel to take the underlying object from.
Member Function Documentation
HPS::Component HPS::Exchange::CADModel::GetComponentFromEntity | ( | A3DEntity * | in_entity | ) | const |
ConfigurationArray HPS::Exchange::CADModel::GetConfigurations | ( | ) | const |
UTF8Array HPS::Exchange::CADModel::GetCurrentConfiguration | ( | ) | const |
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.
bool HPS::Exchange::CADModel::GetEntityOwnership | ( | ) | const |
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.
A3DEntity* HPS::Exchange::CADModel::GetExchangeEntity | ( | ) | const |
Gets the A3DEntity pointer corresponding to this Exchange::CADModel.
- Returns
- The A3DEntity pointer corresponding to this Exchange::CADModel.
void HPS::Exchange::CADModel::HideAllPMI | ( | Canvas & | in_canvas, |
size_t | in_layer = 0 |
||
) |
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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::CADModel.
CADModel& HPS::Exchange::CADModel::operator= | ( | Exchange::CADModel && | in_that | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this Exchange::CADModel.
- Parameters
-
in_that An rvalue reference to an Exchange::CADModel to take the underlying object from.
- Returns
- A reference to this Exchange::CADModel.
ReloadNotifier HPS::Exchange::CADModel::Reload | ( | TessellationOptionsKit const & | in_options = TessellationOptionsKit() , |
TranslationOptionsKit const & | in_translation_options = TranslationOptionsKit() |
||
) |
Asynchronously reloads this CADModel. This will delete all underlying subcomponents and then reparse the underlying Exchange data.
- Parameters
-
in_options The options to use to generate tessellations for new Components (if necessary). 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.
void HPS::Exchange::CADModel::ShowAllPMI | ( | Canvas & | in_canvas, |
size_t | in_layer = 0 |
||
) |
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.
void HPS::Exchange::CADModel::Tessellate | ( | TessellationOptionsKit const & | 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.
- Parameters
-
in_options The options to use to generate the new tessellation for this CADModel
TranslationNotifier HPS::Exchange::CADModel::Translate | ( | TranslationOptionsKit const & | 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.
- Parameters
-
in_translation_options Options 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:
- include/sprk_exchange.h