Inheritance diagram for HPS.CADModel:
HPS.Component HPS.Sprocket HPS.Object HPS.DWG.CADModel HPS.Exchange.CADModel HPS.Parasolid.CADModel

Public Member Functions

HPS.View ActivateDefaultCapture ()
 
 CADModel ()
 
 CADModel (HPS.Component in_that)
 
 CADModel (HPS.CADModel in_that)
 
 CADModel (HPS.Model in_that)
 
override void Dispose ()
 
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 ()
 
override HPS.Type ObjectType ()
 
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 void Dispose ()
 
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)
 
override HPS.Type ObjectType ()
 
bool SetName (string in_new_name)
 
bool SetTransform (HPS.MatrixKit in_transform)
 
- Public Member Functions inherited from HPS.Sprocket
override void Dispose ()
 
 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.Component
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Sprocket
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 the root Component for a structured file format.

Constructor & Destructor Documentation

◆ CADModel() [1/4]

HPS.CADModel.CADModel ( )
inline

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

◆ CADModel() [2/4]

HPS.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 a CADModel object. Otherwise the copy will fail and the resulting CADModel will be invalid.

Parameters
in_thatThe source Component to copy.

◆ CADModel() [3/4]

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

The copy constructor creates a CADModel object that shares the underlying smart-pointer of the source CADModel.

Parameters
in_thatThe source CADModel to copy.

◆ CADModel() [4/4]

HPS.CADModel.CADModel ( HPS.Model  in_that)
inline

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
in_thatThe source Model to use to find the associated CADModel.

Member Function Documentation

◆ ActivateDefaultCapture()

HPS.View HPS.CADModel.ActivateDefaultCapture ( )
inline

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

HPS.Filter [] HPS.CADModel.GetActiveFilters ( HPS.View  in_view)
inline

Get a list of the active filters on the given View.

Parameters
in_viewThe View for which to get the active filters.
Returns
A list of the active filters on the given View.

◆ GetAllCaptures()

HPS.Capture [] HPS.CADModel.GetAllCaptures ( )
inline

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

HPS.Filter [] HPS.CADModel.GetAllFilters ( )
inline

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

HPS.Component HPS.CADModel.GetComponentFromKey ( HPS.Key  in_key)
inline

Find the Component associated with the given Key (if any).

Parameters
in_keyThe Key from which to find the associated Component.
Returns
The Component associated with the given Key (if any).

◆ GetComponentPath() [1/4]

HPS.ComponentPath HPS.CADModel.GetComponentPath ( HPS.KeyPath  in_key_path,
HPS.ComponentPath.PathType  in_path_type 
)
inline

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
in_key_pathThe KeyPath for which to compute the corresponding ComponentPath.
in_path_typeThe type of ComponentPath returned by this function.
Returns
The ComponentPath corresponding to the given KeyPath.

◆ GetComponentPath() [2/4]

HPS.ComponentPath HPS.CADModel.GetComponentPath ( HPS.KeyPath  in_key_path)
inline

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
in_key_pathThe KeyPath for which to compute the corresponding ComponentPath.
Returns
The ComponentPath corresponding to the given KeyPath.

◆ GetComponentPath() [3/4]

HPS.ComponentPath HPS.CADModel.GetComponentPath ( HPS.SelectionItem  in_item,
HPS.ComponentPath.PathType  in_path_type 
)
inline

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
in_itemThe SelectionItem for which to compute the corresponding ComponentPath.
in_path_typeThe type of ComponentPath returned by this function.
Returns
The ComponentPath corresponding to the given SelectionItem.

◆ GetComponentPath() [4/4]

HPS.ComponentPath HPS.CADModel.GetComponentPath ( HPS.SelectionItem  in_item)
inline

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
in_itemThe SelectionItem for which to compute the corresponding ComponentPath.
Returns
The ComponentPath corresponding to the given SelectionItem.

◆ GetModel()

HPS.Model HPS.CADModel.GetModel ( )
inline

Get the Model associated with this CADModel.

Returns
The Model associated with this CADModel.

◆ ObjectType()

override HPS.Type HPS.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.Object.

Reimplemented in HPS.Parasolid.CADModel, HPS.Exchange.CADModel, and HPS.DWG.CADModel.

◆ ResetVisibility() [1/2]

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

Resets the visibility in the view specified by the given Canvas and layer. This will undo any hides, shows or isolates performed on components contained within this CADModel via ComponentPath calls.

Parameters
in_canvasThe Canvas in which to perform the the visibility reset.
in_layerThe layer in the Canvas in which to perform the visibility reset.
See also
ComponentPath.Hide
ComponentPath.Show
ComponentPath.Isolate

◆ ResetVisibility() [2/2]

void HPS.CADModel.ResetVisibility ( HPS.Canvas  in_canvas)
inline

Resets the visibility in the view specified by the given Canvas and layer. This will undo any hides, shows or isolates performed on components contained within this CADModel via ComponentPath calls.

Parameters
in_canvasThe Canvas in which to perform the the visibility reset.
See also
ComponentPath.Hide
ComponentPath.Show
ComponentPath.Isolate

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