API Search || Global Search

More...

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 ()
 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. More...
 
 CADModel ()
 The default constructor creates an uninitialized CADModel object. The Type() function will return Type.None. More...
 
 CADModel (HPS.Component 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. More...
 
 CADModel (HPS.CADModel in_that)
 The copy constructor creates a CADModel object that shares the underlying smart-pointer of the source CADModel. More...
 
 CADModel (HPS.Model 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. More...
 
override void Dispose ()
 
HPS.Filter[] GetActiveFilters (HPS.View in_view)
 Get a list of the active filters on the given View. More...
 
HPS.Capture[] GetAllCaptures ()
 Get a list of all captures from all subcomponents for this CADModel. More...
 
HPS.Filter[] GetAllFilters ()
 Get a list of all filters from all subcomponents for this CADModel. More...
 
HPS.Component GetComponentFromKey (HPS.Key in_key)
 Find the Component associated with the given Key (if any). More...
 
HPS.ComponentPath GetComponentPath (HPS.KeyPath in_key_path, HPS.ComponentPath.PathType in_path_type)
 Get the ComponentPath which corresponds to the given KeyPath. <linebreak><linebreak> The returned path will contain the Components which occurs along the given KeyPath, up to the CADModel. <linebreak><linebreak> 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. <linebreak><linebreak> 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. <linebreak><linebreak> 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. <linebreak><linebreak> 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. More...
 
HPS.ComponentPath GetComponentPath (HPS.KeyPath in_key_path)
 Get the ComponentPath which corresponds to the given KeyPath. <linebreak><linebreak> The returned path will contain the Components which occurs along the given KeyPath, up to the CADModel. <linebreak><linebreak> 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. <linebreak><linebreak> 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. <linebreak><linebreak> 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. <linebreak><linebreak> 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. More...
 
HPS.ComponentPath GetComponentPath (HPS.SelectionItem in_item, HPS.ComponentPath.PathType in_path_type)
 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. <linebreak><linebreak> 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. <linebreak><linebreak> 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. <linebreak><linebreak> 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. <linebreak><linebreak> 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. More...
 
HPS.ComponentPath GetComponentPath (HPS.SelectionItem in_item)
 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. <linebreak><linebreak> 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. <linebreak><linebreak> 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. <linebreak><linebreak> 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. <linebreak><linebreak> 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. More...
 
HPS.Model GetModel ()
 Get the Model associated with this CADModel. More...
 
override HPS.Type ObjectType ()
 
void ResetVisibility (HPS.Canvas in_canvas, ulong in_layer)
 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. More...
 
void ResetVisibility (HPS.Canvas in_canvas)
 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. More...
 
- Public Member Functions inherited from HPS.Component
void AddKey (HPS.Key in_key)
 Adds a key to be associated with this Component. This will additionally ensure this key can be used to find this Component via CADModel.GetComponentFromKey on the owning CADModel. In general, this will either be a SegmentKey or a GeometryKey (or a subclass thereof), but it may also be an IncludeKey, which is necessary for an instanced Component. If an IncludeKey is associated with this Component, the underlying target of the include will be associated with this Component, though the include will be stored as well to determine things like the associated KeyPath correctly. More...
 
void AddOwner (HPS.Component in_owner, HPS.IncludeKey in_include)
 Adds an owner to this Component. This is intended to facilitate adding additional owners to an instanced Component, and allows specifying the associated IncludeKey for the additional owner. It is possible to add an owner without adding an IncludeKey, and, if desired, add the IncludeKey separately via AddKey. More...
 
void AddOwner (HPS.Component in_owner)
 Adds an owner to this Component. This is intended to facilitate adding additional owners to an instanced Component, and allows specifying the associated IncludeKey for the additional owner. It is possible to add an owner without adding an IncludeKey, and, if desired, add the IncludeKey separately via AddKey. More...
 
void AddReference (HPS.Component in_reference)
 Adds a Component as a reference to this Component. More...
 
bool AddTransform (HPS.MatrixKit in_transform)
 Appends a transform to the underlying PRC or Parasolid data associated with this component. More...
 
virtual void Assign (HPS.Component in_that)
 Share the underlying smart-pointer of the Component source. More...
 
 Component ()
 The default constructor creates an uninitialized Component object. The Type() function will return Type.None. More...
 
 Component (HPS.Component in_that)
 The copy constructor creates a Component object that shares the underlying smart-pointer of the source Component. More...
 
void Delete ()
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Component in_that)
 Check if the source Component points to the same underlying impl as this Component. More...
 
void Flush ()
 Removes all references to the underlying subcomponents, but leaves this Component around. If a subcomponent of the component being flushed has multiple owners, the flush will simply remove the reference to that subcomponent. If a subcomponent of the component being flushed has only one owner (the component being flushed), that subcomponent will be deleted. Any handles to the deleted components will become invalid. More...
 
HPS.Metadata[] GetAllMetadata ()
 Get all Metadata objects associated with this Component. More...
 
HPS.Component[] GetAllSubcomponents (HPS.Component.ComponentType in_type)
 Gets all components under this Component that have the specified ComponentType mask. This will examine this subcomponents of this Component, the subcomponents of the subcomponents, and so on. More...
 
HPS.Component.ComponentType GetComponentType ()
 Gets the specific format-dependent type this Component represents. More...
 
override int GetHashCode ()
 
HPS.Key[] GetKeys ()
 Get the underlying keys (if any) which represent this Component. Generally this will either be a segment or geometry key. More...
 
HPS.Metadata GetMetadata (string in_name)
 Get the single Metadata object with the given name associated with this Component (if present). More...
 
string GetName ()
 Gets the name for this Component. This is a convenience function equivalent to getting the "Name" metadata for this Component. If a Component does not have a name, an empty UTF8 object will be returned. More...
 
HPS.Component[] GetOwners ()
 Get the Component objects (if any) which "own" this Component. Generally this will be a single element or no elements for a root component. It is possible for there to be multiple owners of a Component if it is instanced (i.e., it may have both a prototype and a containing Component). More...
 
HPS.Component[] GetReferences ()
 Get the Component objects (if any) which are referenced by this Component. These are Component objects which are associated with this Component, but not "owned" by this Component, and would not be deleted if this Component is deleted (though the reference relationship will be removed). More...
 
HPS.Component[] GetReferrers ()
 Gets the Component objects which refer to this Component (if any). These relationships are defined in the original CAD file and can be arbitrarily assigned between Components. <linebreak><linebreak> For the Exchange implementation of the Component hierarchy, Referrers will typically indicate which PMI elements refer to the Component being inspected. More...
 
HPS.Component[] GetSubcomponents ()
 Get the subcomponent objects (if any) owned or referenced by this Component. These Component objects would be deleted if this Component is deleted. More...
 
bool HasComponentType (HPS.Component.ComponentType in_mask)
 This function indicates whether this Component has the given ComponentType mask. More...
 
override HPS.Type ObjectType ()
 
bool SetTransform (HPS.MatrixKit in_transform)
 Applies a transform to the underlying PRC or Parasolid data associated with this component, replacing any transforms currently set on it. More...
 
- 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 ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
virtual HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 

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
}
 Enumerates the format-dependent types a Component can represent. More...
 
enum  Visibility : uint { Visibility.PreserveUserDefined = 0x00000000, Visibility.PreserveModelDefined = 0x00000001, Visibility.PreserveNone = 0x00000002, Visibility.PreserveAll = 0x00000003 }
 Enumerates whether visibility will be overridden for the subtree under a ComponentPath. More...
 
- Static Public Member Functions inherited from HPS.Component
static HPS.KeyPath[] GetKeyPath (HPS.Component in_component)
 Gets the list of KeyPath objects that correspond to the given Component. There will be at least one KeyPath, and possibly more than one if a particular Component is instanced, e.g., if the Component corresponds to the wheel of a car, a KeyPath would be returned for each wheel (driver side front and rear, and passenger side front and rear). Each KeyPath in the list will also include the portion of the path above the Model (associated with the root CADModel) for each View, Layout layer, and Canvas permutation which includes the Model. This function will not take into account any includes or paths which do not come from the Component hierarchy or the View, Layout, and Canvas permutations which include the Model. More...
 
static HPS.KeyPath[] GetKeyPath (HPS.Component[] in_components)
 Gets the list of KeyPath objects that correspond to the given ComponentPath. This function can be used to get the KeyPath for a particular instance of an instanced Component. For a non-instanced Component, since the ComponentPath can be determined unambiguously, the KeyPath returned will be the same as if only the leaf non-instanced Component was given to this function. There will be at least one KeyPath returned, and possibly more than one for each View, Layout layer, and Canvas which include the Model associated with the root CADModel. This function will not take into account any includes or paths which do not come from the Component hierarchy or the View, Layout, and Canvas permutations which include the Model. More...
 
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

HPS.CADModel.CADModel ( )
inline

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

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

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.
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.
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.
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.
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).
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. <linebreak><linebreak> The returned path will contain the Components which occurs along the given KeyPath, up to the CADModel. <linebreak><linebreak> 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. <linebreak><linebreak> 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. <linebreak><linebreak> 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. <linebreak><linebreak> 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.
HPS.ComponentPath HPS.CADModel.GetComponentPath ( HPS.KeyPath  in_key_path)
inline

Get the ComponentPath which corresponds to the given KeyPath. <linebreak><linebreak> The returned path will contain the Components which occurs along the given KeyPath, up to the CADModel. <linebreak><linebreak> 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. <linebreak><linebreak> 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. <linebreak><linebreak> 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. <linebreak><linebreak> 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.
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. <linebreak><linebreak> 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. <linebreak><linebreak> 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. <linebreak><linebreak> 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. <linebreak><linebreak> 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.
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. <linebreak><linebreak> 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. <linebreak><linebreak> 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. <linebreak><linebreak> 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. <linebreak><linebreak> 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.
HPS.Model HPS.CADModel.GetModel ( )
inline

Get the Model associated with this CADModel.

Returns
The Model associated with this CADModel.
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.

ComponentPath.Hide

ComponentPath.Show

ComponentPath.Isolate

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.

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