
Public Types | |
enum | PathType : uint { PathType.Complete = 0x00000000, PathType.Unique = 0x00000001 } |
Public Member Functions | |
HPS.ComponentPath | Append (HPS.Component in_component) |
HPS.ComponentPath | Append (HPS.ComponentPath in_path) |
HPS.ComponentPath | Append (HPS.Component[] in_components) |
HPS.Component | At (ulong in_index) |
HPS.Component | Back () |
ComponentPath () | |
ComponentPath (HPS.Component[] in_components) | |
ComponentPath (HPS.ComponentPath in_that) | |
override void | Dispose () |
override bool | Empty () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.ComponentPath in_that) |
HPS.Component | Front () |
HPS.Component [] | GetComponents () |
override int | GetHashCode () |
HPS.KeyPath [] | GetKeyPaths () |
HPS.KeyPath [] | GetKeyPaths (HPS.Canvas in_canvas, ulong in_layer) |
HPS.KeyPath [] | GetKeyPaths (HPS.Canvas in_canvas) |
void | Hide (HPS.Canvas in_canvas, ulong in_layer) |
void | Hide (HPS.Canvas in_canvas) |
void | Highlight (HPS.Canvas in_canvas, HPS.HighlightOptionsKit in_options, bool in_remove_existing) |
void | Highlight (HPS.Canvas in_canvas, HPS.HighlightOptionsKit in_options) |
void | Highlight (HPS.Canvas in_canvas, ulong in_layer, HPS.HighlightOptionsKit in_options, bool in_remove_existing) |
void | Highlight (HPS.Canvas in_canvas, ulong in_layer, HPS.HighlightOptionsKit in_options) |
void | Insert (ulong in_index, HPS.Component in_item) |
bool | IsHidden (HPS.Canvas in_canvas, ulong in_layer) |
bool | IsHidden (HPS.Canvas in_canvas) |
void | Isolate (HPS.Canvas in_canvas, ulong in_layer) |
void | Isolate (HPS.Canvas in_canvas) |
override HPS.Type | ObjectType () |
HPS.Component | PopBack () |
HPS.Component | PopFront () |
HPS.ComponentPath | PushBack (HPS.Component in_component) |
HPS.ComponentPath | PushBack (HPS.ComponentPath in_path) |
HPS.ComponentPath | PushBack (HPS.Component[] in_components) |
HPS.ComponentPath | PushFront (HPS.Component in_component) |
void | Remove (HPS.Component in_item) |
void | Remove (ulong in_index) |
void | ResetVisibility (HPS.Canvas in_canvas, ulong in_layer) |
void | ResetVisibility (HPS.Canvas in_canvas) |
HPS.ComponentPath | Reverse () |
void | Set (HPS.ComponentPath in_that) |
HPS.ComponentPath | SetComponents (HPS.Component[] in_components) |
void | Show (HPS.Canvas in_canvas, ulong in_layer) |
void | Show (HPS.Canvas in_canvas) |
ulong | Size () |
void | Unhighlight (HPS.Canvas in_canvas, HPS.HighlightOptionsKit in_options) |
void | Unhighlight (HPS.Canvas in_canvas) |
void | Unhighlight (HPS.Canvas in_canvas, ulong in_layer, HPS.HighlightOptionsKit in_options) |
void | Unhighlight (HPS.Canvas in_canvas, ulong in_layer) |
![]() | |
override void | Dispose () |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
bool | HasType (HPS.Type in_mask) |
Object (HPS.Object that) | |
virtual void | Reset () |
virtual HPS.Type | Type () |
Static Public Member Functions | |
static void | Isolate (HPS.ComponentPath[] in_component_paths, HPS.Canvas in_canvas, ulong in_layer) |
static void | Isolate (HPS.ComponentPath[] in_component_paths, HPS.Canvas in_canvas) |
static bool | operator!= (HPS.ComponentPath a, HPS.ComponentPath b) |
static bool | operator== (HPS.ComponentPath a, HPS.ComponentPath b) |
static void | ResetVisibility (HPS.ComponentPath[] in_component_paths, HPS.Canvas in_canvas, ulong in_layer) |
static void | ResetVisibility (HPS.ComponentPath[] in_component_paths, HPS.Canvas in_canvas) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The ComponentPath contains an array of components, organized from leaf to root. It allows the user to perform queries and operations along that path.
Member Enumeration Documentation
◆ PathType
|
strong |
Enumerates the types of ComponentPaths.
Enumerator | |
---|---|
Complete | The ComponentPath contains all components between leaf and root. |
Unique | The ComponentPath contains only components which are unique to this request, omitting ambiguous entries. |
Constructor & Destructor Documentation
◆ ComponentPath() [1/3]
|
inline |
Creates an uninitialized ComponentPath that refers to no database objects.
◆ ComponentPath() [2/3]
|
inline |
Creates a new ComponentPath object based on the supplied path.
- Parameters
-
in_components An array of components arranged from leaf to root.
◆ ComponentPath() [3/3]
|
inline |
Copies in_that into this ComponentPath.
Member Function Documentation
◆ Append() [1/3]
|
inline |
Appends the supplied Component into this object. Same as operator+= function.
- Deprecated:
- This function exists for compatibility. Use ComponentPath.PushBack instead.
- Parameters
-
in_component The Component to be appended to this.
- Returns
- A reference to this object.
◆ Append() [2/3]
|
inline |
Appends the supplied key into this object. Same as operator+= function.
- Deprecated:
- This function exists for compatibility. Use ComponentPath.PushBack instead.
- Parameters
-
in_path The ComponentPath to be appended to this.
- Returns
- A reference to this object.
◆ Append() [3/3]
|
inline |
Appends the supplied key into this object. Same as operator+= function.
- Deprecated:
- This function exists for compatibility. Use ComponentPath.PushBack instead.
- Parameters
-
in_components The ComponentArray to be appended to this.
- Returns
- A reference to this object.
◆ Empty()
|
inlinevirtual |
Indicates whether this ComponentPath is empty.
- Returns
- true if no components are set on the path, false otherwise.
Reimplemented from HPS.Object.
◆ Equals()
|
inline |
Check if the source ComponentPath is equivalent to this object.
- Parameters
-
in_that The source ComponentPath to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetComponents()
|
inline |
Gets the components defining this ComponentPath.
- Returns
- The components defining this ComponentPath.
◆ GetKeyPaths() [1/3]
|
inline |
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.
- Returns
- All KeyPath objects for this ComponentPath.
◆ GetKeyPaths() [2/3]
|
inline |
Gets the KeyPath objects corresponding to this ComponentPath which are included by the specified Canvas and layer.
- Parameters
-
in_canvas The Canvas the returned KeyPath objects should reference. in_layer The layer under the provided Canvas the returned KeyPath objects should reference.
- Returns
- The KeyPath objects for this ComponentPath which are included by the specified Canvas and layer.
◆ GetKeyPaths() [3/3]
|
inline |
Gets the KeyPath objects corresponding to this ComponentPath which are included by the specified Canvas and layer.
- Returns
- The KeyPath objects for this ComponentPath which are included by the specified Canvas and layer.
◆ Hide() [1/2]
|
inline |
Hides this ComponentPath under the given Canvas in the specified layer. This forces the visibility of the selected ComponentPath and all components under this path to invisible. Any visibility changes made previously at or below this path are flushed. When performing a highlight in combination with this function the highlight must be applied with Drawing.Overlay.InPlace to display properly. See this section for limitations and details on managing component visibility.
- Parameters
-
in_canvas The Canvas in which to hide the ComponentPath. in_layer The layer under the provided Canvas in which to hide the ComponentPath.
Show
Isolate
IsHidden
ResetVisibility
Programming Guide: Managing Component Visibility
◆ Hide() [2/2]
|
inline |
Hides this ComponentPath under the given Canvas in the specified layer. This forces the visibility of the selected ComponentPath and all components under this path to invisible. Any visibility changes made previously at or below this path are flushed. When performing a highlight in combination with this function the highlight must be applied with Drawing.Overlay.InPlace to display properly. See this section for limitations and details on managing component visibility.
- Parameters
-
in_canvas The Canvas in which to hide the ComponentPath.
Show
Isolate
IsHidden
ResetVisibility
Programming Guide: Managing Component Visibility
◆ Highlight() [1/4]
|
inline |
Highlights this ComponentPath with the provided options under the given Canvas in layer zero.
- Parameters
-
in_canvas The Canvas in which to perform the highlight. in_options The options to use to perform the highlight. in_remove_existing Indicates whether this highlight should flush existing highlights at the specified path for the desired overlay type. If HPS.ComponentPath.Isolate(), HPS.ComponentPath.Hide(), or HPS.ComponentPath.Show() have been called on this ComponentPath, in_remove_existing should be set to false so that it doesn't override those visibility states.
◆ Highlight() [2/4]
|
inline |
Highlights this ComponentPath with the provided options under the given Canvas in layer zero.
- Parameters
-
in_canvas The Canvas in which to perform the highlight. in_options The options to use to perform the highlight.
◆ Highlight() [3/4]
|
inline |
Highlights this ComponentPath with the provided options under the given Canvas in the specified layer.
- Parameters
-
in_canvas The Canvas in which to perform the highlight. in_layer The layer under the provided Canvas in which to perform the highlight. in_options The options to use to perform the highlight. If HPS.ComponentPath.Isolate(), HPS.ComponentPath.Hide(), or HPS.ComponentPath.Show() have been called on this ComponentPath, in_remove_existing should be set to false so that it doesn't override those visibility states.
◆ Highlight() [4/4]
|
inline |
Highlights this ComponentPath with the provided options under the given Canvas in the specified layer.
- Parameters
-
in_canvas The Canvas in which to perform the highlight. in_layer The layer under the provided Canvas in which to perform the highlight. in_options The options to use to perform the highlight. If HPS.ComponentPath.Isolate(), HPS.ComponentPath.Hide(), or HPS.ComponentPath.Show() have been called on this ComponentPath, in_remove_existing should be set to false so that it doesn't override those visibility states.
◆ IsHidden() [1/2]
|
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.
- Parameters
-
in_canvas The Canvas in which to check whether the specified path is hidden. in_layer The layer under the provided Canvas in which to check whether the specified path is hidden.
- Returns
- true if this path is hidden, false otherwise.
Hide
Show
Isolate
ResetVisibility
Programming Guide: Managing Component Visibility
◆ IsHidden() [2/2]
|
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.
- Parameters
-
in_canvas The Canvas in which to check whether the specified path is hidden.
- Returns
- true if this path is hidden, false otherwise.
Hide
Show
Isolate
ResetVisibility
Programming Guide: Managing Component Visibility
◆ Isolate() [1/4]
|
inline |
Shows only this ComponentPath and hides all other Component objects under the given Canvas in the specified layer. When performing a highlight in combination with this function the highlight must be applied with Drawing.Overlay.InPlace to display properly. See this section for limitations and details on managing component visibility.
- Parameters
-
in_canvas The Canvas in which to isolate the ComponentPath. in_layer The layer under the provided Canvas in which to isolate the ComponentPath.
Hide
Show
IsHidden
ResetVisibility
Programming Guide: Managing Component Visibility
◆ Isolate() [2/4]
|
inline |
Shows only this ComponentPath and hides all other Component objects under the given Canvas in the specified layer. When performing a highlight in combination with this function the highlight must be applied with Drawing.Overlay.InPlace to display properly. See this section for limitations and details on managing component visibility.
- Parameters
-
in_canvas The Canvas in which to isolate the ComponentPath.
Hide
Show
IsHidden
ResetVisibility
Programming Guide: Managing Component Visibility
◆ Isolate() [3/4]
|
inlinestatic |
Shows only the objects in the supplied ComponentPathArray and hides all other Component objects under the given Canvas in the specified layer. When performing a highlight in combination with this function the highlight must be applied with Drawing.Overlay.InPlace to display properly. See this section for limitations and details on managing component visibility.
- Parameters
-
in_component_paths A ComponentPathArray containing paths to isolate. in_canvas The Canvas in which to isolate the supplied paths. in_layer The layer under the provided Canvas in which to isolate the supplied paths.
Hide
Show
IsHidden
ResetVisibility
Programming Guide: Managing Component Visibility
◆ Isolate() [4/4]
|
inlinestatic |
Shows only the objects in the supplied ComponentPathArray and hides all other Component objects under the given Canvas in the specified layer. When performing a highlight in combination with this function the highlight must be applied with Drawing.Overlay.InPlace to display properly. See this section for limitations and details on managing component visibility.
- Parameters
-
in_component_paths A ComponentPathArray containing paths to isolate. in_canvas The Canvas in which to isolate the supplied paths.
Hide
Show
IsHidden
ResetVisibility
Programming Guide: Managing Component Visibility
◆ 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.
◆ PushBack() [1/2]
|
inline |
Appends the supplied key into this object. Same as operator+= function.
- Parameters
-
in_path The ComponentPath to be appended to this.
- Returns
- A reference to this object.
◆ PushBack() [2/2]
|
inline |
Appends the supplied key into this object. Same as operator+= function.
- Parameters
-
in_components The ComponentArray to be appended to this.
- Returns
- A reference to this object.
◆ ResetVisibility() [1/4]
|
inline |
Resets the visibility of all components at or below this ComponentPath back to the visibility state defined by their model & view. See this section for limitations and details on managing component visibility.
- Parameters
-
in_canvas The Canvas in which to isolate the ComponentPath. in_layer The layer under the provided Canvas in which to isolate the ComponentPath.
Hide
Show
Isolate
IsHidden
Programming Guide: Managing Component Visibility
◆ ResetVisibility() [2/4]
|
inline |
Resets the visibility of all components at or below this ComponentPath back to the visibility state defined by their model & view. See this section for limitations and details on managing component visibility.
- Parameters
-
in_canvas The Canvas in which to isolate the ComponentPath.
Hide
Show
Isolate
IsHidden
Programming Guide: Managing Component Visibility
◆ ResetVisibility() [3/4]
|
inlinestatic |
Resets the visibility of all components at or below the given paths back to the visibility state defined by their model & view. See this section for limitations and details on managing component visibility.
- Parameters
-
in_component_paths A ComponentPathArray containing paths to reset. in_canvas The Canvas in which to isolate the supplied paths. in_layer The layer under the provided Canvas in which to isolate the supplied paths.
Hide
Show
Isolate
IsHidden
Programming Guide: Managing Component Visibility
◆ ResetVisibility() [4/4]
|
inlinestatic |
Resets the visibility of all components at or below the given paths back to the visibility state defined by their model & view. See this section for limitations and details on managing component visibility.
- Parameters
-
in_component_paths A ComponentPathArray containing paths to reset. in_canvas The Canvas in which to isolate the supplied paths.
Hide
Show
Isolate
IsHidden
Programming Guide: Managing Component Visibility
◆ Set()
|
inline |
Copies the supplied path into this object.
- Parameters
-
in_that The source of the copy.
◆ SetComponents()
|
inline |
Copies an array of components into this object.
- Parameters
-
in_components The source array, assumed to be arranged from leaf to root.
- Returns
- A reference to this object.
◆ Show() [1/2]
|
inline |
Shows this ComponentPath under the given Canvas in the specified layer. This makes the selected path visibile but preserves the model-defined visibility of any components that exist underneath the chosen path. Any visibility changes made subsequently at or below this path are honored unless they are redundant. When performing a highlight in combination with this function the highlight must be applied with Drawing.Overlay.InPlace to display properly. See this section for limitations and details on managing component visibility.
- Parameters
-
in_canvas The Canvas in which to show the ComponentPath. in_layer The layer under the provided Canvas in which to show the ComponentPath.
Hide
Isolate
IsHidden
ResetVisibility
Programming Guide: Managing Component Visibility
◆ Show() [2/2]
|
inline |
Shows this ComponentPath under the given Canvas in the specified layer. This makes the selected path visibile but preserves the model-defined visibility of any components that exist underneath the chosen path. Any visibility changes made subsequently at or below this path are honored unless they are redundant. When performing a highlight in combination with this function the highlight must be applied with Drawing.Overlay.InPlace to display properly. See this section for limitations and details on managing component visibility.
- Parameters
-
in_canvas The Canvas in which to show the ComponentPath.
Hide
Isolate
IsHidden
ResetVisibility
Programming Guide: Managing Component Visibility
◆ Unhighlight() [1/4]
|
inline |
Unhighlights this ComponentPath with the provided options under the given Canvas in layer zero.
- Parameters
-
in_canvas The Canvas in which to perform the unhighlight. in_options The options to use to perform the unhighlight.
◆ Unhighlight() [2/4]
|
inline |
Unhighlights this ComponentPath with the provided options under the given Canvas in layer zero.
- Parameters
-
in_canvas The Canvas in which to perform the unhighlight.
◆ Unhighlight() [3/4]
|
inline |
Unhighlights this ComponentPath with the provided options under the given Canvas in the specified layer.
◆ Unhighlight() [4/4]
|
inline |
Unhighlights this ComponentPath with the provided options under the given Canvas in the specified layer.
The documentation for this class was generated from the following file:
- internals/hps_sprk/source/cs/HPS.ComponentPath.cs