#include <sprk.h>

Public Member Functions | |
bool | Equals (SprocketPath const &in_that) const |
Canvas | GetCanvas () const |
KeyPath | GetKeyPath () const |
Layout | GetLayout () const |
Model | GetModel () const |
View | GetView () const |
HPS::Type | ObjectType () const |
bool | operator!= (SprocketPath const &in_that) const |
SprocketPath & | operator= (SprocketPath const &in_that) |
bool | operator== (SprocketPath const &in_that) const |
void | Set (SprocketPath const &in_that) |
SprocketPath (Model const &in_model, View const &in_view, Layout const &in_layout, Canvas const &in_canvas) | |
SprocketPath (Canvas const &in_canvas, Layout const &in_layout, View const &in_view, Model const &in_model) | |
SprocketPath (Canvas const &in_canvas, size_t in_layer=0) | |
SprocketPath (SprocketPath const &that) | |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
virtual bool | Empty () const |
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 Public Attributes | |
static const HPS::Type | staticType = HPS::Type::SprocketPath |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
The SprocketPath class is a utility class which can be used to automatically obtain a KeyPath from the Model to the Canvas.
Member Function Documentation
Canvas HPS::SprocketPath::GetCanvas | ( | ) | const |
Returns the Canvas associated with this SprocketPath
KeyPath HPS::SprocketPath::GetKeyPath | ( | ) | const |
Creates a key path from the model segment up to the canvas window key, including all segments and include keys along the way. This can be used to facilitate highlighting or gathering of net attributes.
- Returns
- A key path from the model segment to the canvas window key.
Layout HPS::SprocketPath::GetLayout | ( | ) | const |
Returns the Layout associated with this SprocketPath
Model HPS::SprocketPath::GetModel | ( | ) | const |
Returns the Model associated with this SprocketPath
View HPS::SprocketPath::GetView | ( | ) | const |
Returns the View associated with this SprocketPath
The documentation for this class was generated from the following file:
- include/sprk.h