Public Member Functions |
Static Public Member Functions |
Protected Member Functions |
List of all members
HPS.SprocketPath Class Reference
Inheritance diagram for HPS.SprocketPath:

Public Member Functions | |
override void | Dispose () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.SprocketPath in_that) |
HPS.Canvas | GetCanvas () |
override int | GetHashCode () |
HPS.KeyPath | GetKeyPath () |
HPS.Layout | GetLayout () |
HPS.Model | GetModel () |
HPS.View | GetView () |
override HPS.Type | ObjectType () |
void | Set (HPS.SprocketPath in_that) |
SprocketPath (HPS.Model in_model, HPS.View in_view, HPS.Layout in_layout, HPS.Canvas in_canvas) | |
SprocketPath (HPS.Canvas in_canvas, HPS.Layout in_layout, HPS.View in_view, HPS.Model in_model) | |
SprocketPath (HPS.Canvas in_canvas, ulong in_layer) | |
SprocketPath (HPS.Canvas in_canvas) | |
SprocketPath (HPS.SprocketPath that) | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
virtual bool | Empty () |
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 bool | operator!= (HPS.SprocketPath a, HPS.SprocketPath b) |
static bool | operator== (HPS.SprocketPath a, HPS.SprocketPath b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
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
◆ GetCanvas()
|
inline |
Returns the Canvas associated with this SprocketPath
◆ GetKeyPath()
|
inline |
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.
◆ GetLayout()
|
inline |
Returns the Layout associated with this SprocketPath
◆ GetModel()
|
inline |
Returns the Model associated with this SprocketPath
◆ GetView()
|
inline |
Returns the View associated with this SprocketPath
◆ 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.
The documentation for this class was generated from the following file:
- internals/hps_sprk/source/cs/HPS.SprocketPath.cs