The ComponentPath contains an array of keys, organized from leaf to root. It allows the user to perform a number of queries along that path including accumulating net attributes and converting coordinates. More...
Public Member Functions | |
override void | Dispose () |
ComponentPath () | |
Creates an uninitialized key path that refers to no database objects. More... | |
ComponentPath (HPS.Component[] in_components) | |
Creates a new ComponentPath object based on the supplied path. More... | |
ComponentPath (HPS.ComponentPath in_that) | |
Copies in_that into this key path. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
HPS.ComponentPath | Append (HPS.Component in_component) |
Appends the supplied Component into this object. Same as operator+= function. More... | |
HPS.ComponentPath | Append (HPS.ComponentPath in_path) |
Appends the supplied key into this object. Same as operator+= function. More... | |
HPS.ComponentPath | Append (HPS.Component[] in_components) |
Appends the supplied key into this object. Same as operator+= function. More... | |
void | Set (HPS.ComponentPath in_that) |
Copies the supplied path into this object. More... | |
override bool | Equals (System.Object obj) |
override int | GetHashCode () |
bool | Equals (HPS.ComponentPath in_that) |
Check if the source ComponentPath is equivalent to this object. More... | |
HPS.ComponentPath | SetComponents (HPS.Component[] in_components) |
Copies an array of components into this object. More... | |
HPS.Component[] | GetComponents () |
Gets the components defining this ComponentPath. More... | |
HPS.KeyPath[] | GetKeyPaths () |
Gets the KeyPath objects corresponding to this ComponentPath. These key paths will include all possible paths which include the path components and all Canvas, Layout and View paths which include the Model which contains the path components. More... | |
HPS.KeyPath[] | GetKeyPaths (HPS.Canvas in_canvas, ulong in_layer) |
Gets the KeyPath objects corresponding to this ComponentPath which are included by the specified Canvas and layer. More... | |
HPS.KeyPath[] | GetKeyPaths (HPS.Canvas in_canvas) |
Gets the KeyPath objects corresponding to this ComponentPath which are included by the specified Canvas and layer. More... | |
void | Highlight (HPS.Canvas in_canvas, HPS.HighlightOptionsKit in_options) |
Highlights this ComponentPath with the provided options under the given Canvas in layer zero. More... | |
void | Highlight (HPS.Canvas in_canvas, ulong in_layer, HPS.HighlightOptionsKit in_options) |
Highlights this ComponentPath with the provided options under the given Canvas in the specified layer. More... | |
void | Unhighlight (HPS.Canvas in_canvas, HPS.HighlightOptionsKit in_options) |
Unhighlights this ComponentPath with the provided options under the given Canvas in layer zero. More... | |
void | Unhighlight (HPS.Canvas in_canvas, ulong in_layer, HPS.HighlightOptionsKit in_options) |
Unhighlights this ComponentPath with the provided options under the given Canvas in the specified layer. More... | |
void | Hide (HPS.Canvas in_canvas, ulong in_layer) |
Hides this ComponentPath under the given Canvas in the specified layer. More... | |
void | Hide (HPS.Canvas in_canvas) |
Hides this ComponentPath under the given Canvas in the specified layer. More... | |
void | Show (HPS.Canvas in_canvas, ulong in_layer) |
Shows this ComponentPath under the given Canvas in the specified layer. More... | |
void | Show (HPS.Canvas in_canvas) |
Shows this ComponentPath under the given Canvas in the specified layer. More... | |
bool | IsHidden (HPS.Canvas in_canvas, ulong in_layer) |
Indicates whether this ComponentPath under the given Canvas in the specified layer is hidden. Note that even if a path is hidden, it's possible that paths descending from this path may not be hidden. More... | |
bool | IsHidden (HPS.Canvas in_canvas) |
Indicates whether this ComponentPath under the given Canvas in the specified layer is hidden. Note that even if a path is hidden, it's possible that paths descending from this path may not be hidden. More... | |
void | Isolate (HPS.Canvas in_canvas, ulong in_layer) |
Shows only this ComponentPath and hides all other Component objects under the given Canvas in the specified layer. More... | |
void | Isolate (HPS.Canvas in_canvas) |
Shows only this ComponentPath and hides all other Component objects under the given Canvas in the specified layer. More... | |
![]() | |
override void | Dispose () |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
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... | |
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... | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
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... | |
Static Public Member Functions | |
static bool | operator== (HPS.ComponentPath a, HPS.ComponentPath b) |
static bool | operator!= (HPS.ComponentPath a, HPS.ComponentPath b) |
static void | Isolate (HPS.ComponentPath[] in_components_to_be_isolated, HPS.Canvas in_canvas, ulong in_layer) |
static void | Isolate (HPS.ComponentPath[] in_components_to_be_isolated, HPS.Canvas in_canvas) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
The type of update to perform, either synchronous or asynchronous. More... | |
![]() | |
HandleRef | cptr |
HandleRef | scptr |
bool | cMemOwn |
The ComponentPath contains an array of keys, organized from leaf to root. It allows the user to perform a number of queries along that path including accumulating net attributes and converting coordinates.
|
inline |
Creates an uninitialized key path that refers to no database objects.
|
inline |
Creates a new ComponentPath object based on the supplied path.
in_components | An array of keys arranged from leaf to root. |
|
inline |
Copies in_that into this key path.
|
inline |
|
inline |
Appends the supplied key into this object. Same as operator+= function.
in_path | The <ref refid="class_h_p_s_1_1_component_path" kindref="compound">ComponentPath</ref> to be appended to this. |
|
inline |
Appends the supplied key into this object. Same as operator+= function.
in_components | The ComponentArray to be appended to this. |
|
inline |
Check if the source ComponentPath is equivalent to this object.
in_that | The source <ref refid="class_h_p_s_1_1_component_path" kindref="compound">ComponentPath</ref> to compare to this object. |
|
inline |
Gets the components defining this ComponentPath.
|
inline |
|
inline |
Gets the KeyPath objects corresponding to this ComponentPath which are included by the specified Canvas and layer.
|
inline |
Gets the KeyPath objects corresponding to this ComponentPath which are included by the specified Canvas and layer.
|
inline |
Hides this ComponentPath under the given Canvas in the specified layer.
in_canvas | The <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to hide the <ref refid="class_h_p_s_1_1_component_path" kindref="compound">ComponentPath</ref>. |
in_layer | The layer under the provided <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to hide the <ref refid="class_h_p_s_1_1_component_path" kindref="compound">ComponentPath</ref>. |
|
inline |
Hides this ComponentPath under the given Canvas in the specified layer.
in_canvas | The <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to hide the <ref refid="class_h_p_s_1_1_component_path" kindref="compound">ComponentPath</ref>. |
|
inline |
Highlights this ComponentPath with the provided options under the given Canvas in layer zero.
in_canvas | The <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to perform the highlight. |
in_options | The options to use to perform the highlight. |
|
inline |
Highlights this ComponentPath with the provided options under the given Canvas in the specified layer.
in_canvas | The <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to perform the highlight. |
in_layer | The layer under the provided <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to perform the highlight. |
in_options | The options to use to perform the highlight. |
|
inline |
Indicates whether this ComponentPath under the given Canvas in the specified layer is hidden. Note that even if a path is hidden, it's possible that paths descending from this path may not be hidden.
in_canvas | The <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to check whether the specified path is hidden. |
in_layer | The layer under the provided <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to check whether the specified path is hidden. |
|
inline |
Indicates whether this ComponentPath under the given Canvas in the specified layer is hidden. Note that even if a path is hidden, it's possible that paths descending from this path may not be hidden.
in_canvas | The <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to check whether the specified path is hidden. |
|
inline |
Shows only this ComponentPath and hides all other Component objects under the given Canvas in the specified layer.
in_canvas | The <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to isolate the <ref refid="class_h_p_s_1_1_component_path" kindref="compound">ComponentPath</ref>. |
in_layer | The layer under the provided <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to isolate the <ref refid="class_h_p_s_1_1_component_path" kindref="compound">ComponentPath</ref>. |
|
inline |
Shows only this ComponentPath and hides all other Component objects under the given Canvas in the specified layer.
in_canvas | The <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to isolate the <ref refid="class_h_p_s_1_1_component_path" kindref="compound">ComponentPath</ref>. |
|
inlinevirtual |
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.
|
inline |
Copies the supplied path into this object.
in_that | The source of the copy. |
|
inline |
Copies an array of components into this object.
in_components | The source array, assumed to be arranged from leaf to root. |
|
inline |
Shows this ComponentPath under the given Canvas in the specified layer.
in_canvas | The <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to show the <ref refid="class_h_p_s_1_1_component_path" kindref="compound">ComponentPath</ref>. |
in_layer | The layer under the provided <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to show the <ref refid="class_h_p_s_1_1_component_path" kindref="compound">ComponentPath</ref>. |
|
inline |
Shows this ComponentPath under the given Canvas in the specified layer.
in_canvas | The <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to show the <ref refid="class_h_p_s_1_1_component_path" kindref="compound">ComponentPath</ref>. |
|
inline |
Unhighlights this ComponentPath with the provided options under the given Canvas in layer zero.
in_canvas | The <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to perform the unhighlight. |
in_options | The options to use to perform the unhighlight. |
|
inline |
Unhighlights this ComponentPath with the provided options under the given Canvas in the specified layer.
in_canvas | The <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to perform the unhighlight. |
in_layer | The layer under the provided <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref> in which to perform the unhighlight. |
in_options | The options to use to perform the unhighlight. |