REFERENCE MANUAL
The CADModel class is a smart pointer. More...
Public Member Functions | |
HPS.View | ActivateDefaultCapture () |
Creates a new View object corresponding to the default capture for this CADModel. More... | |
CADModel () | |
The default constructor creates an uninitialized CADModel object. More... | |
CADModel (HPS.Component in_that) | |
This constructor creates a CADModel object that shares the underlying smart-pointer of the source Component. More... | |
CADModel (HPS.CADModel in_that) | |
This constructor creates a CADModel object that shares the underlying smart-pointer of the source Component. More... | |
CADModel (HPS.Model in_that) | |
This constructor creates a CADModel object that shares the underlying smart-pointer of the source Component. 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) |
Get the Component path which corresponds to the given KeyPath. More... | |
HPS.ComponentPath | GetComponentPath (HPS.SelectionItem in_item) |
Get the Component path which corresponds to the given SelectionItem. More... | |
HPS.Model | GetModel () |
Get the Model associated with this CADModel. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | ResetVisibility (HPS.Canvas in_canvas, ulong in_layer) |
Resets the visibility in the view specfied by the given Canvas and layer. More... | |
void | ResetVisibility (HPS.Canvas in_canvas) |
Resets the visibility in the view specfied by the given Canvas and layer. More... | |
![]() | |
void | AddKey (HPS.Key in_key) |
Adds a key to be associated with this Component. More... | |
void | AddOwner (HPS.Component in_owner, HPS.IncludeKey in_include) |
Adds an owner to this Component. More... | |
void | AddOwner (HPS.Component in_owner) |
Adds an owner to this Component. More... | |
void | AddReference (HPS.Component in_reference) |
Adds a Component as a reference to 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. 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 () |
Removes all references owning Components have to this Component, deletes all owned subcomponents, and deletes any underlying keys. More... | |
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... | |
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. 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. More... | |
HPS.Metadata | GetMetadata (string in_name) |
Get the single Metadata object with the given name associated with this Component (if present). More... | |
HPS.Component[] | GetOwners () |
Get the Component objects (if any) which "own" this Component. More... | |
HPS.Component[] | GetReferences () |
Get the Component objects (if any) which are referenced by this Component. More... | |
HPS.Component[] | GetReferrers () |
Gets the Component objects which refer to this Component (if any). More... | |
HPS.Component[] | GetSubcomponents () |
Get the subcomponent objects (if any) owned or referenced by this Component. More... | |
bool | HasComponentType (HPS.Component.ComponentType in_mask) |
This function indicates whether this Component has the given ComponentType mask. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
![]() | |
override void | Dispose () |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
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. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
The CADModel class is a smart pointer.
It represents the root Component for a structured file format.
HPS.CADModel.CADModel | ( | ) |
HPS.CADModel.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.
in_that | The source <ref refid="class_h_p_s_1_1_component" kindref="compound">Component</ref> to copy. |
HPS.CADModel.CADModel | ( | HPS.CADModel | 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.
in_that | The source <ref refid="class_h_p_s_1_1_component" kindref="compound">Component</ref> to copy. |
HPS.CADModel.CADModel | ( | HPS.Model | 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.
in_that | The source <ref refid="class_h_p_s_1_1_component" kindref="compound">Component</ref> to copy. |
HPS.View HPS.CADModel.ActivateDefaultCapture | ( | ) |
HPS.Filter [] HPS.CADModel.GetActiveFilters | ( | HPS.View | in_view | ) |
HPS.Capture [] HPS.CADModel.GetAllCaptures | ( | ) |
HPS.Filter [] HPS.CADModel.GetAllFilters | ( | ) |
HPS.Component HPS.CADModel.GetComponentFromKey | ( | HPS.Key | in_key | ) |
HPS.ComponentPath HPS.CADModel.GetComponentPath | ( | HPS.KeyPath | in_key_path | ) |
Get the Component path which corresponds to the given KeyPath.
The returned path will basically be the Component associated with each key which occurs in the given KeyPath, up to the CADModel. Note that since there are some Component objects for which there is no underlying Key (e.g., a Component representing a CoEdge), these objects will not appear in the returned Component list.
HPS.ComponentPath HPS.CADModel.GetComponentPath | ( | HPS.SelectionItem | in_item | ) |
Get the Component path which corresponds to the given SelectionItem.
The returned path will basically be the Component associated with each key which occurs in the KeyPath associated with the SelectionItem, up to the CADModel. Note that since there are some Component objects for which there is no underlying Key (e.g., a Component representing a CoEdge), these objects will not appear in the returned Component list.
in_item | The SelectionItem for which to compute the corresponding <ref refid="class_h_p_s_1_1_component" kindref="compound">Component</ref> path. |
HPS.Model HPS.CADModel.GetModel | ( | ) |
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
Reimplemented in HPS.Parasolid.CADModel, and HPS.Exchange.CADModel.
void HPS.CADModel.ResetVisibility | ( | HPS.Canvas | in_canvas, |
ulong | in_layer | ||
) |
Resets the visibility in the view specfied by the given Canvas and layer.
This will undo any hides, shows or isolates performed on components contained within this CADModel via ComponentPath calls.
void HPS.CADModel.ResetVisibility | ( | HPS.Canvas | in_canvas | ) |
Resets the visibility in the view specfied by the given Canvas and layer.
This will undo any hides, shows or isolates performed on components contained within this CADModel via ComponentPath calls.
in_canvas | The <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to perform the the visibility reset. |