#include <sprk.h>
|
|
static const HPS::Type | staticType = HPS::Type::CADModel |
| |
|
static const HPS::Type | staticType = HPS::Type::Component |
| |
| static const HPS::Type | staticType = HPS::Type::None |
| |
|
| 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 = 0x00009000,
ComponentType::ExchangeDrawingModel = 0x00009001,
ComponentType::ExchangeDrawingView = 0x00009002,
ComponentType::ExchangeDrawingSheet = 0x00009003,
ComponentType::ExchangeBasicDrawingBlock = 0x00009004,
ComponentType::ExchangeOperatorDrawingBlock = 0x00009005,
ComponentType::ExchangePMIMask = 0x00011000,
ComponentType::ExchangePMI = ExchangePMIMask,
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,
Full,
StandardAndExchange
} |
| |
| 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) |
| |
| template<typename T > |
| static intptr_t | ClassID () |
| |
The CADModel class is a smart pointer. It represents the root Component for a structured file format.
◆ CADModel() [1/5]
| HPS::CADModel::CADModel |
( |
| ) |
|
The default constructor creates an uninitialized CADModel object. The Type() function will return Type::None.
◆ CADModel() [2/5]
| HPS::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 a CADModel object. Otherwise the copy will fail and the resulting CADModel will be invalid.
- Parameters
-
◆ CADModel() [3/5]
| HPS::CADModel::CADModel |
( |
CADModel const & |
in_that | ) |
|
The copy constructor creates a CADModel object that shares the underlying smart-pointer of the source CADModel.
- Parameters
-
◆ CADModel() [4/5]
| HPS::CADModel::CADModel |
( |
CADModel && |
in_that | ) |
|
The move constructor creates a CADModel by transferring the underlying object of the rvalue reference to this CADModel.
- Parameters
-
| in_that | An rvalue reference to a CADModel to take the underlying object from. |
◆ CADModel() [5/5]
| HPS::CADModel::CADModel |
( |
Model const & |
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.
- Parameters
-
◆ ActivateDefaultCapture()
| View HPS::CADModel::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.
- Returns
- A newly created View object corresponding to this Capture.
◆ GetActiveFilters()
| FilterArray HPS::CADModel::GetActiveFilters |
( |
View const & |
in_view | ) |
const |
Get a list of the active filters on the given View.
- Parameters
-
| in_view | The View for which to get the active filters. |
- Returns
- A list of the active filters on the given View.
◆ GetAllCaptures()
| CaptureArray HPS::CADModel::GetAllCaptures |
( |
| ) |
const |
Get a list of all captures from all subcomponents for this CADModel.
- Returns
- A list of all captures from all subcomponents for this CADModel.
◆ GetAllFilters()
| FilterArray HPS::CADModel::GetAllFilters |
( |
| ) |
const |
Get a list of all filters from all subcomponents for this CADModel.
- Returns
- A list of all filters from all subcomponents for this CADModel.
◆ GetComponentFromKey()
| Component HPS::CADModel::GetComponentFromKey |
( |
Key const & |
in_key | ) |
const |
Find the Component associated with the given Key (if any).
- Parameters
-
- Returns
- The Component associated with the given Key (if any).
◆ GetComponentPath() [1/2]
Get the ComponentPath which corresponds to the given KeyPath.
The returned path will contain the Components which occurs along the given KeyPath, up to the CADModel.
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.
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.
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.
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.
- Parameters
-
- Returns
- The ComponentPath corresponding to the given KeyPath.
◆ GetComponentPath() [2/2]
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.
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.
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.
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.
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.
- Parameters
-
- Returns
- The ComponentPath corresponding to the given SelectionItem.
◆ GetModel()
| Model HPS::CADModel::GetModel |
( |
| ) |
const |
◆ ObjectType()
| HPS::Type HPS::CADModel::ObjectType |
( |
| ) |
const |
|
inlinevirtual |
◆ operator=()
The move assignment operator transfers the underlying object of the rvalue reference to this CADModel.
- Parameters
-
| in_that | An rvalue reference to a CADModel to take the underlying object from. |
- Returns
- A reference to this CADModel.
◆ ResetVisibility()
| void HPS::CADModel::ResetVisibility |
( |
Canvas const & |
in_canvas, |
|
|
size_t |
in_layer = 0 |
|
) |
| |
The documentation for this class was generated from the following file:
Public Member Functions inherited from HPS::Component