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

virtual bool Empty() const

Indicates whether this ShapeKit has any values set on it.

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

bool Equals(ShapeKit const &in_kit) const

Check if the source ShapeKit is equivalent to this ShapeKit.

Parameters: in_kit – The source ShapeKit to compare to this ShapeKit.
Returns: true if the objects are equivalent, false otherwise.

inline virtual HPS::Type ObjectType() const

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.

bool operator!=(ShapeKit const &in_kit) const

Check if the source ShapeKit is not equivalent to this ShapeKit.

Parameters: in_kit – The source ShapeKit to compare to this ShapeKit.
Returns: true if the objects are not equivalent, false otherwise.

ShapeKit &operator=(ShapeKit &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this ShapeKit thereby avoiding a copy.

Parameters: in_that – An rvalue reference to a ShapeKit to take the impl from.
Returns: A reference to this ShapeKit.

ShapeKit &operator=(ShapeKit const &in_kit)

Copies the source ShapeKit into this ShapeKit.

Parameters: in_kit – The source ShapeKit to copy.
Returns: A reference to this ShapeKit.

bool operator==(ShapeKit const &in_kit) const

Check if the source ShapeKit is equivalent to this ShapeKit.

Parameters: in_kit – The source ShapeKit to compare to this ShapeKit.
Returns: true if the objects are equivalent, false otherwise.

void Set(ShapeKit const &in_kit)

Copies the source ShapeKit into this ShapeKit.

Parameters: in_kit – The source ShapeKit to copy.

ShapeKit &SetElement(ShapeElement const &in_element)

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

Parameters: in_element – A reference to the ShapeElement to set on this kit.
Returns: A reference to this ShapeKit.

ShapeKit &SetElements(ShapeElementArray const &in_def)

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

Parameters: in_def – The array of elements for the shape.
Returns: A reference to this ShapeKit.

ShapeKit &SetElements(size_t in_count, ShapeElement const in_def[])

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

Parameters

in_count – Size of the following array.
in_def – The array of elements for the shape.

Returns

A reference to this ShapeKit.

ShapeKit(): The default constructor creates an empty ShapeKit object.

ShapeKit(ShapeKit &&in_that)

The move constructor creates a ShapeKit by transferring the underlying impl of the rvalue reference to this ShapeKit thereby avoiding a copy and allocation.

Parameters: in_that – An rvalue reference to a ShapeKit to take the impl from.

ShapeKit(ShapeKit const &in_kit)

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

Parameters: in_kit – The source ShapeKit to copy.

void Show(ShapeKit &out_kit) const

Copies this ShapeKit into the given ShapeKit.

Parameters: out_kit – The ShapeKit to populate with the contents of this ShapeKit.

bool ShowElements(ShapeElementArray &out_def) const

Shows the elements for this ShapeKit.

Parameters: out_def – The elements for the shape.
Returns: true if elements were set, false otherwise.

ShapeKit &UnsetElements()

Removes the elements for the shape.

Returns: A reference to this ShapeKit.

ShapeKit &UnsetEverything()

Removes all settings from this ShapeKit.

Returns: A reference to this ShapeKit.

virtual ~ShapeKit()

Public Static Functions

static HPS::ShapeKit GetDefault(Shape::Default in_default_shape)

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

Parameters: in_default_shape – The default shape for which to get the corresponding ShapeKit.
Returns: A ShapeKit which contains the definition of the specified default shape.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::ShapeKit