Public Member Functions | List of all members
HPS::Exchange::CADModel Class Reference

#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::CADModel:
HPS::CADModel HPS::Component HPS::Sprocket HPS::Object

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::Type ObjectType () const
 
CADModeloperator= (Exchange::CADModel const &in_that)=default
 
CADModeloperator= (Exchange::CADModel &&in_that)
 
A3DEntity * GetExchangeEntity () const
 
bool GetEntityOwnership () const
 
UTF8Array GetCurrentConfiguration () const
 
ConfigurationArray GetConfigurations () const
 
SheetArray GetSheets () const
 
TranslationNotifier Translate (TranslationOptionsKit const &in_translation_options)
 
ReloadNotifier Reload (TessellationOptionsKit const &in_options=TessellationOptionsKit())
 
- Public Member Functions inherited from HPS::CADModel
 CADModel ()
 
 CADModel (Component const &in_that)
 
 CADModel (CADModel const &in_that)
 
 CADModel (CADModel &&in_that)
 
 CADModel (Model const &in_that)
 
CADModeloperator= (CADModel const &in_that)=default
 
CADModeloperator= (CADModel &&in_that)
 
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
 
FilterArray GetAllFilters () const
 
CaptureArray GetAllCaptures () const
 
FilterArray GetActiveFilters (View const &in_view) const
 
View ActivateDefaultCapture ()
 
void ResetVisibility (Canvas &in_canvas, size_t in_layer=0)
 
- Public Member Functions inherited from HPS::Component
 Component ()
 
 Component (Component const &in_that)
 
 Component (Component &&in_that)
 
virtual ~Component ()
 
Componentoperator= (Component const &in_that)
 
Componentoperator= (Component &&in_that)
 
virtual void Assign (Component const &in_that)
 
bool Equals (Component const &in_that) const
 
bool operator!= (Component const &in_that) const
 
bool operator== (Component const &in_that) const
 
ComponentType GetComponentType () const
 
bool HasComponentType (ComponentType in_mask) const
 
void AddKey (Key const &in_key)
 
KeyArray GetKeys () const
 
void AddOwner (Component &in_owner, IncludeKey const &in_include=IncludeKey())
 
ComponentArray GetOwners () const
 
ComponentArray GetSubcomponents () const
 
ComponentArray GetAllSubcomponents (ComponentType in_type) const
 
void AddReference (Component &in_reference)
 
ComponentArray GetReferrers () const
 
ComponentArray GetReferences () const
 
MetadataArray GetAllMetadata () const
 
Metadata GetMetadata (char const *in_name) const
 
UTF8 GetName () const
 
void Delete ()
 
void Flush ()
 
- Public Member Functions inherited from HPS::Sprocket
 Sprocket (HPS::Sprocket const &in_that)=default
 
 Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
 Object (Object const &that)
 
Objectoperator= (Object const &other_object)
 
 Object (Object &&in_that)
 
Objectoperator= (Object &&in_that)
 
HPS::Type Type () const
 
virtual bool Empty () const
 
virtual void Reset ()
 
bool HasType (HPS::Type in_mask) const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 

Additional Inherited Members

- Public Types inherited from HPS::Component
enum  ComponentType : uint32_t {
  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 = 0x00006000, ComponentType::ExchangeDrawingModel = 0x00006001, ComponentType::ExchangeDrawingView = 0x00006002,
  ComponentType::ExchangeDrawingSheet = 0x00006003, ComponentType::ExchangeBasicDrawingBlock = 0x00006004, ComponentType::ExchangeOperatorDrawingBlock = 0x00006005, ComponentType::ExchangePMIMask = 0x00009000,
  ComponentType::ExchangePMI = ExchangePMIMask, ComponentType::ExchangePMIText = 0x00009100, ComponentType::ExchangePMIRichText = 0x00009200, ComponentType::ExchangePMIRoughness = 0x00009300,
  ComponentType::ExchangePMIGDT = 0x00009400, ComponentType::ExchangePMIDatum = 0x00009500, ComponentType::ExchangePMILineWelding = 0x00009600, ComponentType::ExchangePMISpotWelding = 0x00009700,
  ComponentType::ExchangePMIDimension = 0x00009800, ComponentType::ExchangePMIBalloon = 0x00009900, ComponentType::ExchangePMICoordinate = 0x00009a00, ComponentType::ExchangePMIFastener = 0x00009b00,
  ComponentType::ExchangePMILocator = 0x00009c00, ComponentType::ExchangePMIMeasurementPoint = 0x00009d00, ComponentType::ParasolidComponentMask = 0x00010000, ComponentType::ParasolidModelFile = 0x00010001,
  ComponentType::ParasolidAssembly = 0x00010002, ComponentType::ParasolidTopologyMask = 0x00050000, ComponentType::ParasolidTopoBody = 0x00050001, ComponentType::ParasolidTopoRegion = 0x00050002,
  ComponentType::ParasolidTopoShell = 0x00050003, ComponentType::ParasolidTopoFace = 0x00050004, ComponentType::ParasolidTopoLoop = 0x00050005, ComponentType::ParasolidTopoFin = 0x00050006,
  ComponentType::ParasolidTopoEdge = 0x00050007, ComponentType::ParasolidTopoVertex = 0x00050008, ComponentType::DWGComponentMask = 0x00100000, ComponentType::DWGModelFile = 0x00100001,
  ComponentType::DWGLayout = 0x00100002, ComponentType::DWGBlockTable = 0x00100003, ComponentType::DWGBlockTableRecord = 0x00100004, ComponentType::DWGEntity = 0x00100005,
  ComponentType::DWGLayerTable = 0x00100006, ComponentType::DWGLayer = 0x00100007
}
 
- Public Types inherited from HPS::Sprocket
enum  UpdateType { Synchronous, Asynchronous }
 
- Static Public Member Functions inherited from HPS::Component
static KeyPathArray GetKeyPath (Component const &in_component)
 
static KeyPathArray GetKeyPath (size_t in_count, Component const in_components[])
 
static KeyPathArray GetKeyPath (ComponentArray const &in_components)
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

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

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

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_thatThe 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_thatThe 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_thatThe 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_thatAn rvalue reference to an Exchange::CADModel to take the underlying object from.

Member Function Documentation

ConfigurationArray HPS::Exchange::CADModel::GetConfigurations ( ) const

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.
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.
HPS::Type HPS::Exchange::CADModel::ObjectType ( ) const
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_thatAn 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())

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