class HPS.SprocketPath : public HPS.Sprocket

The SprocketPath class is a utility class which can be used to automatically obtain a KeyPath from the Model to the Canvas.

Public Functions

override void Dispose ()
bool Equals (HPS.SprocketPath in_that)
override bool Equals (Object obj)
HPS.Canvas GetCanvas ()

Returns the Canvas associated with this SprocketPath

override int GetHashCode ()
HPS.KeyPath GetKeyPath ()

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.


A key path from the model segment to the canvas window key.

HPS.Layout GetLayout ()

Returns the Layout associated with this SprocketPath

HPS.Model GetModel ()

Returns the Model associated with this SprocketPath

HPS.View GetView ()

Returns the View associated with this SprocketPath

override HPS.Type ObjectType ()

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).


The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.SprocketPath in_that)
SprocketPath ()
SprocketPath (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.Model in_model, HPS.View in_view, HPS.Layout in_layout, HPS.Canvas in_canvas)
SprocketPath (HPS.SprocketPath that)

Public Static Functions

bool operator!= (HPS.SprocketPath a, HPS.SprocketPath b)
bool operator== (HPS.SprocketPath a, HPS.SprocketPath b)