#include <sprk.h>
|
using | const_iterator = HPS::ComponentArray::const_iterator |
|
using | const_reverse_iterator = HPS::ComponentArray::const_reverse_iterator |
|
using | iterator = HPS::ComponentArray::iterator |
|
enum | PathType : uint32_t { PathType::Complete,
PathType::Unique
} |
|
using | reverse_iterator = HPS::ComponentArray::reverse_iterator |
|
|
ComponentPath & | Append (Component const &in_component) |
|
ComponentPath & | Append (ComponentPath const &in_path) |
|
ComponentPath & | Append (ComponentArray const &in_components) |
|
Component & | At (size_t in_index) |
|
Component const & | At (size_t in_index) const |
|
Component & | Back () |
|
Component const & | Back () const |
|
iterator | begin () |
|
const_iterator | begin () const |
|
const_iterator | cbegin () const |
|
const_iterator | cend () const |
|
| ComponentPath () |
|
| ComponentPath (ComponentArray const &in_components) |
|
| ComponentPath (size_t in_count, Component const in_components[]) |
|
| ComponentPath (ComponentPath const &in_that) |
|
| ComponentPath (ComponentPath &&in_that) |
|
bool | Empty () const |
|
iterator | end () |
|
const_iterator | end () const |
|
bool | Equals (ComponentPath const &in_that) const |
|
Component & | Front () |
|
Component const & | Front () const |
|
ComponentArray | GetComponents () const |
|
KeyPathArray | GetKeyPaths () const |
|
KeyPathArray | GetKeyPaths (Canvas const &in_canvas, size_t in_layer=0) const |
|
void | Hide (Canvas const &in_canvas, size_t in_layer=0) |
|
void | Highlight (Canvas const &in_canvas, HighlightOptionsKit const &in_options, bool in_remove_existing=true) const |
|
void | Highlight (Canvas const &in_canvas, size_t in_layer, HighlightOptionsKit const &in_options, bool in_remove_existing=true) const |
|
void | Insert (size_t in_index, Component const &in_item) |
|
bool | IsHidden (Canvas const &in_canvas, size_t in_layer=0) const |
|
void | Isolate (Canvas const &in_canvas, size_t in_layer=0) |
|
HPS::Type | ObjectType () const |
|
bool | operator!= (ComponentPath const &in_that) const |
|
ComponentPath & | operator+= (Component const &in_component) |
|
ComponentPath & | operator+= (ComponentPath const &in_path) |
|
ComponentPath & | operator+= (ComponentArray const &in_components) |
|
ComponentPath & | operator= (ComponentPath &&in_that) |
|
ComponentPath & | operator= (ComponentPath const &in_that) |
|
ComponentPath & | operator= (ComponentArray const &in_path) |
|
bool | operator== (ComponentPath const &in_that) const |
|
Component | PopBack () |
|
Component | PopFront () |
|
ComponentPath & | PushBack (Component const &in_component) |
|
ComponentPath & | PushBack (ComponentPath const &in_path) |
|
ComponentPath & | PushBack (ComponentArray const &in_components) |
|
ComponentPath & | PushFront (Component const &in_component) |
|
reverse_iterator | rbegin () |
|
const_reverse_iterator | rbegin () const |
|
void | Remove (Component const &in_item) |
|
void | Remove (size_t in_index) |
|
reverse_iterator | rend () |
|
const_reverse_iterator | rend () const |
|
void | ResetVisibility (Canvas const &in_canvas, size_t in_layer=0) |
|
ComponentPath | Reverse () const |
|
void | Set (ComponentPath const &in_that) |
|
ComponentPath & | SetComponents (ComponentArray const &in_components) |
|
ComponentPath & | SetComponents (size_t in_count, Component const in_components[]) |
|
void | Show (Canvas const &in_canvas, size_t in_layer=0) |
|
size_t | Size () const |
|
void | Unhighlight (Canvas const &in_canvas, HighlightOptionsKit const &in_options=HighlightOptionsKit()) const |
|
void | Unhighlight (Canvas const &in_canvas, size_t in_layer, HighlightOptionsKit const &in_options=HighlightOptionsKit()) const |
|
virtual | ~ComponentPath () |
|
| Sprocket (Sprocket &&in_that) |
|
intptr_t | GetClassID () const |
|
intptr_t | GetInstanceID () const |
|
bool | HasType (HPS::Type in_mask) const |
|
| Object (Object const &that) |
|
| Object (Object &&in_that) |
|
Object & | operator= (Object const &other_object) |
|
Object & | operator= (Object &&in_that) |
|
virtual void | Reset () |
|
virtual HPS::Type | Type () const |
|
|
static void | Isolate (HPS::ComponentPathArray &in_component_paths, Canvas const &in_canvas, size_t in_layer=0) |
|
static void | ResetVisibility (HPS::ComponentPathArray &in_component_paths, Canvas const &in_canvas, size_t in_layer=0) |
|
template<typename T > |
static intptr_t | ClassID () |
|
|
static const HPS::Type | staticType = HPS::Type::ComponentPath |
|
static const HPS::Type | staticType = HPS::Type::None |
|
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/5]
HPS::ComponentPath::ComponentPath |
( |
| ) |
|
Creates an uninitialized ComponentPath that refers to no database objects.
◆ ComponentPath() [2/5]
HPS::ComponentPath::ComponentPath |
( |
ComponentArray const & |
in_components | ) |
|
Creates a new ComponentPath object based on the supplied path.
- Parameters
-
in_components | An array of components arranged from leaf to root. |
◆ ComponentPath() [3/5]
HPS::ComponentPath::ComponentPath |
( |
size_t |
in_count, |
|
|
Component const |
in_components[] |
|
) |
| |
Creates a new ComponentPath object based on the supplied path.
- Parameters
-
in_count | The number of keys in the array. |
in_components | An array of components arranged from leaf to root. |
◆ ComponentPath() [4/5]
HPS::ComponentPath::ComponentPath |
( |
ComponentPath const & |
in_that | ) |
|
◆ ComponentPath() [5/5]
The move constructor creates a ComponentPath by transferring the underlying impl of the rvalue reference to this ComponentPath thereby avoiding a copy and allocation.
- Parameters
-
in_that | An rvalue reference to a ComponentPath to take the impl from. |
◆ ~ComponentPath()
virtual HPS::ComponentPath::~ComponentPath |
( |
| ) |
|
|
virtual |
Releases a reference to the database object this object is tied to.
◆ Append() [1/3]
Appends the supplied Component into this object. Same as operator+= function.
- Parameters
-
in_component | The Component to be appended to this. |
- Returns
- A reference to this object.
- Deprecated:
- This function exists for compatibility. Use ComponentPath::PushBack instead.
◆ Append() [2/3]
Appends the supplied key into this object. Same as operator+= function.
- Parameters
-
- Returns
- A reference to this object.
- Deprecated:
- This function exists for compatibility. Use ComponentPath::PushBack instead.
◆ Append() [3/3]
ComponentPath& HPS::ComponentPath::Append |
( |
ComponentArray const & |
in_components | ) |
|
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.
- Deprecated:
- This function exists for compatibility. Use ComponentPath::PushBack instead.
◆ Empty()
bool HPS::ComponentPath::Empty |
( |
| ) |
const |
|
virtual |
Indicates whether this ComponentPath is empty.
- Returns
- true if no components are set on the path, false otherwise.
Reimplemented from HPS::Object.
◆ Equals()
bool HPS::ComponentPath::Equals |
( |
ComponentPath const & |
in_that | ) |
const |
Check if the source ComponentPath is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetComponents()
ComponentArray HPS::ComponentPath::GetComponents |
( |
| ) |
const |
◆ GetKeyPaths() [1/2]
◆ GetKeyPaths() [2/2]
KeyPathArray HPS::ComponentPath::GetKeyPaths |
( |
Canvas const & |
in_canvas, |
|
|
size_t |
in_layer = 0 |
|
) |
| const |
◆ Hide()
void HPS::ComponentPath::Hide |
( |
Canvas const & |
in_canvas, |
|
|
size_t |
in_layer = 0 |
|
) |
| |
◆ Highlight() [1/2]
void HPS::ComponentPath::Highlight |
( |
Canvas const & |
in_canvas, |
|
|
HighlightOptionsKit const & |
in_options, |
|
|
bool |
in_remove_existing = true |
|
) |
| const |
Highlights this ComponentPath with the provided options under the given Canvas in layer zero.
- Parameters
-
◆ Highlight() [2/2]
void HPS::ComponentPath::Highlight |
( |
Canvas const & |
in_canvas, |
|
|
size_t |
in_layer, |
|
|
HighlightOptionsKit const & |
in_options, |
|
|
bool |
in_remove_existing = true |
|
) |
| const |
Highlights this ComponentPath with the provided options under the given Canvas in the specified layer.
- Parameters
-
◆ IsHidden()
bool HPS::ComponentPath::IsHidden |
( |
Canvas const & |
in_canvas, |
|
|
size_t |
in_layer = 0 |
|
) |
| const |
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
◆ Isolate() [1/2]
void HPS::ComponentPath::Isolate |
( |
Canvas const & |
in_canvas, |
|
|
size_t |
in_layer = 0 |
|
) |
| |
◆ Isolate() [2/2]
static void HPS::ComponentPath::Isolate |
( |
HPS::ComponentPathArray & |
in_component_paths, |
|
|
Canvas const & |
in_canvas, |
|
|
size_t |
in_layer = 0 |
|
) |
| |
|
static |
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
◆ ObjectType()
HPS::Type HPS::ComponentPath::ObjectType |
( |
| ) |
const |
|
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.
◆ operator!=()
bool HPS::ComponentPath::operator!= |
( |
ComponentPath const & |
in_that | ) |
const |
Check if the source ComponentPath is not equivalent to this object.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator+=() [1/3]
Appends the supplied Component into this object. Same as Append function.
- Parameters
-
in_key | The key to be appended to this. |
- Returns
- A reference to this object.
◆ operator+=() [2/3]
Appends the supplied ComponentPath into this object. Same as Append function.
- Parameters
-
- Returns
- A reference to this object.
◆ operator+=() [3/3]
ComponentPath& HPS::ComponentPath::operator+= |
( |
ComponentArray const & |
in_components | ) |
|
Appends the supplied ComponentArray into this object. Same as Append function.
- Parameters
-
in_components | The ComponentArray to be appended to this. |
- Returns
- A reference to this object.
◆ operator=() [1/3]
The move assignment operator transfers the underlying impl of the rvalue reference to this ComponentPath thereby avoiding a copy.
- Parameters
-
in_that | An rvalue reference to a ComponentPath to take the impl from. |
- Returns
- A reference to this ComponentPath.
◆ operator=() [2/3]
Copies the supplied path into this object.
- Parameters
-
in_that | The source of the copy. |
- Returns
- A reference to this object.
◆ operator=() [3/3]
ComponentPath& HPS::ComponentPath::operator= |
( |
ComponentArray const & |
in_path | ) |
|
Copies an array of components into this object.
- Parameters
-
in_path | The source array, assumed to be arranged from leaf to root. |
- Returns
- A reference to this object.
◆ operator==()
bool HPS::ComponentPath::operator== |
( |
ComponentPath const & |
in_that | ) |
const |
Check if the source ComponentPath is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ PushBack() [1/2]
Appends the supplied key into this object. Same as operator+= function.
- Parameters
-
- Returns
- A reference to this object.
◆ PushBack() [2/2]
ComponentPath& HPS::ComponentPath::PushBack |
( |
ComponentArray const & |
in_components | ) |
|
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/2]
void HPS::ComponentPath::ResetVisibility |
( |
Canvas const & |
in_canvas, |
|
|
size_t |
in_layer = 0 |
|
) |
| |
◆ ResetVisibility() [2/2]
static void HPS::ComponentPath::ResetVisibility |
( |
HPS::ComponentPathArray & |
in_component_paths, |
|
|
Canvas const & |
in_canvas, |
|
|
size_t |
in_layer = 0 |
|
) |
| |
|
static |
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
◆ Set()
Copies the supplied path into this object.
- Parameters
-
in_that | The source of the copy. |
◆ SetComponents() [1/2]
ComponentPath& HPS::ComponentPath::SetComponents |
( |
ComponentArray const & |
in_components | ) |
|
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.
◆ SetComponents() [2/2]
Copies an array of components into this object.
- Parameters
-
in_count | the number of components in the array. |
in_components | The source array, assumed to arranged from leaf to root. |
- Returns
- A reference to this object.
◆ Show()
void HPS::ComponentPath::Show |
( |
Canvas const & |
in_canvas, |
|
|
size_t |
in_layer = 0 |
|
) |
| |
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/2]
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/2]
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. |
The documentation for this class was generated from the following file: