|
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 () |
|
|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The ComponentPath contains an array of components, organized from leaf to root. It allows the user to perform queries and operations along that path.
◆ PathType
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.
|
◆ ComponentPath() [1/3]
HPS.ComponentPath.ComponentPath |
( |
| ) |
|
|
inline |
Creates an uninitialized ComponentPath that refers to no database objects.
◆ ComponentPath() [2/3]
HPS.ComponentPath.ComponentPath |
( |
HPS.Component [] |
in_components | ) |
|
|
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]
◆ Append() [1/3]
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]
Appends the supplied key into this object. Same as operator+= function.
- Deprecated:
- This function exists for compatibility. Use ComponentPath.PushBack instead.
- Parameters
-
- Returns
- A reference to this object.
◆ Append() [3/3]
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()
override bool HPS.ComponentPath.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()
Check if the source ComponentPath is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetComponents()
◆ GetKeyPaths() [1/3]
◆ GetKeyPaths() [2/3]
◆ GetKeyPaths() [3/3]
◆ Hide() [1/2]
void HPS.ComponentPath.Hide |
( |
HPS.Canvas |
in_canvas, |
|
|
ulong |
in_layer |
|
) |
| |
|
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
-
- See also
- Show
-
Isolate
-
IsHidden
-
ResetVisibility
-
Programming Guide: Managing Component Visibility
◆ Hide() [2/2]
void HPS.ComponentPath.Hide |
( |
HPS.Canvas |
in_canvas | ) |
|
|
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
-
- See also
- Show
-
Isolate
-
IsHidden
-
ResetVisibility
-
Programming Guide: Managing Component Visibility
◆ Highlight() [1/4]
Highlights this ComponentPath with the provided options under the given Canvas in layer zero.
- Parameters
-
◆ Highlight() [2/4]
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]
Highlights this ComponentPath with the provided options under the given Canvas in the specified layer.
- Parameters
-
◆ Highlight() [4/4]
Highlights this ComponentPath with the provided options under the given Canvas in the specified layer.
- Parameters
-
◆ IsHidden() [1/2]
bool HPS.ComponentPath.IsHidden |
( |
HPS.Canvas |
in_canvas, |
|
|
ulong |
in_layer |
|
) |
| |
|
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.
- See also
- Hide
-
Show
-
Isolate
-
ResetVisibility
-
Programming Guide: Managing Component Visibility
◆ IsHidden() [2/2]
bool HPS.ComponentPath.IsHidden |
( |
HPS.Canvas |
in_canvas | ) |
|
|
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.
- See also
- Hide
-
Show
-
Isolate
-
ResetVisibility
-
Programming Guide: Managing Component Visibility
◆ Isolate() [1/4]
void HPS.ComponentPath.Isolate |
( |
HPS.Canvas |
in_canvas, |
|
|
ulong |
in_layer |
|
) |
| |
|
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
-
- See also
- Hide
-
Show
-
IsHidden
-
ResetVisibility
-
Programming Guide: Managing Component Visibility
◆ Isolate() [2/4]
void HPS.ComponentPath.Isolate |
( |
HPS.Canvas |
in_canvas | ) |
|
|
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
-
- See also
- Hide
-
Show
-
IsHidden
-
ResetVisibility
-
Programming Guide: Managing Component Visibility
◆ Isolate() [3/4]
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. |
- See also
- Hide
-
Show
-
IsHidden
-
ResetVisibility
-
Programming Guide: Managing Component Visibility
◆ Isolate() [4/4]
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. |
- See also
- Hide
-
Show
-
IsHidden
-
ResetVisibility
-
Programming Guide: Managing Component Visibility
◆ ObjectType()
override HPS.Type HPS.ComponentPath.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]
Appends the supplied key into this object. Same as operator+= function.
- Parameters
-
- Returns
- A reference to this object.
◆ PushBack() [2/2]
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]
void HPS.ComponentPath.ResetVisibility |
( |
HPS.Canvas |
in_canvas, |
|
|
ulong |
in_layer |
|
) |
| |
|
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
-
- See also
- Hide
-
Show
-
Isolate
-
IsHidden
-
Programming Guide: Managing Component Visibility
◆ ResetVisibility() [2/4]
void HPS.ComponentPath.ResetVisibility |
( |
HPS.Canvas |
in_canvas | ) |
|
|
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
-
- See also
- Hide
-
Show
-
Isolate
-
IsHidden
-
Programming Guide: Managing Component Visibility
◆ ResetVisibility() [3/4]
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. |
- See also
- Hide
-
Show
-
Isolate
-
IsHidden
-
Programming Guide: Managing Component Visibility
◆ ResetVisibility() [4/4]
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. |
- See also
- Hide
-
Show
-
Isolate
-
IsHidden
-
Programming Guide: Managing Component Visibility
◆ Set()
Copies the supplied path into this object.
- Parameters
-
in_that | The source of the copy. |
◆ SetComponents()
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]
void HPS.ComponentPath.Show |
( |
HPS.Canvas |
in_canvas, |
|
|
ulong |
in_layer |
|
) |
| |
|
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
-
- See also
- Hide
-
Isolate
-
IsHidden
-
ResetVisibility
-
Programming Guide: Managing Component Visibility
◆ Show() [2/2]
void HPS.ComponentPath.Show |
( |
HPS.Canvas |
in_canvas | ) |
|
|
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
-
- See also
- Hide
-
Isolate
-
IsHidden
-
ResetVisibility
-
Programming Guide: Managing Component Visibility
◆ Unhighlight() [1/4]
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]
void HPS.ComponentPath.Unhighlight |
( |
HPS.Canvas |
in_canvas | ) |
|
|
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]
Unhighlights this ComponentPath with the provided options under the given Canvas in the specified layer.
- Parameters
-
in_canvas | The Canvas in which to perform the unhighlight. |
in_layer | The layer under the provided Canvas in which to perform the unhighlight. |
in_options | The options to use to perform the unhighlight. |
◆ Unhighlight() [4/4]
void HPS.ComponentPath.Unhighlight |
( |
HPS.Canvas |
in_canvas, |
|
|
ulong |
in_layer |
|
) |
| |
|
inline |
Unhighlights this ComponentPath with the provided options under the given Canvas in the specified layer.
- Parameters
-
in_canvas | The Canvas in which to perform the unhighlight. |
in_layer | The layer under the provided Canvas in which to perform the unhighlight. |
The documentation for this class was generated from the following file:
- internals/hps_sprk/source/cs/HPS.ComponentPath.cs