ShapeKit

class HPS.ShapeKit : public HPS.Kit

The ShapeKit class is a user space object. It is used for specifying all settings related to a ShapeDefinition.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ShapeKit has any values set on it.

Return

true if no values are set on this ShapeKit, false otherwise.

bool Equals (HPS.ShapeKit in_kit)

Check if the source ShapeKit is equivalent to this ShapeKit.

Param in_kit

The source ShapeKit to compare to this ShapeKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

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

Return

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

void Set (HPS.ShapeKit in_kit)

Copies the source ShapeKit into this ShapeKit.

Param in_kit

The source ShapeKit to copy.

HPS.ShapeKit SetElement (HPS.ShapeElement in_element)

Set a single element for this ShapeKit. This must be specified when defining a shape.

Param in_element

A reference to the ShapeElement to set on this kit.

Return

A reference to this ShapeKit.

HPS.ShapeKit SetElements (HPS.ShapeElement[] in_def)

Sets the elements for this ShapeKit. This must be specified when defining a shape.

Param in_def

The array of elements for the shape.

Return

A reference to this ShapeKit.

ShapeKit ()

The default constructor creates an empty ShapeKit object.

ShapeKit (HPS.ShapeKit in_kit)

The copy constructor creates a new ShapeKit object that contains the same settings as the source ShapeKit.

Param in_kit

The source ShapeKit to copy.

void Show (out HPS.ShapeKit out_kit)

Copies this ShapeKit into the given ShapeKit.

Param out_kit

The ShapeKit to populate with the contents of this ShapeKit.

bool ShowElements (out HPS.ShapeElement[] out_def)

Shows the elements for this ShapeKit.

Param out_def

The elements for the shape.

Return

true if elements were set, false otherwise.

HPS.ShapeKit UnsetElements ()

Removes the elements for the shape.

Return

A reference to this ShapeKit.

HPS.ShapeKit UnsetEverything ()

Removes all settings from this ShapeKit.

Return

A reference to this ShapeKit.

Public Static Functions

HPS.ShapeKit GetDefault (HPS.Shape.Default in_default_shape)

Creates a ShapeKit which contains the definition of the specified default shape.

Param in_default_shape

The default shape for which to get the corresponding ShapeKit.

Return

A ShapeKit which contains the definition of the specified default shape.

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

bool operator== (HPS.ShapeKit a, HPS.ShapeKit b)