#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::ShapeKit |
|
static const HPS::Type | staticType = HPS::Type::Kit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
The ShapeKit class is a user space object. It is used for specifying all settings related to a ShapeDefinition.
HPS::ShapeKit::ShapeKit |
( |
| ) |
|
The default constructor creates an empty ShapeKit object.
HPS::ShapeKit::ShapeKit |
( |
ShapeKit const & |
in_kit | ) |
|
The copy constructor creates a new ShapeKit object that contains the same settings as the source ShapeKit.
- Parameters
-
HPS::ShapeKit::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. |
bool HPS::ShapeKit::Empty |
( |
| ) |
const |
|
virtual |
Indicates whether this ShapeKit has any values set on it.
- Returns
- true if no values are set on this ShapeKit, false otherwise.
Reimplemented from HPS::Object.
bool HPS::ShapeKit::Equals |
( |
ShapeKit const & |
in_kit | ) |
const |
Check if the source ShapeKit is equivalent to this ShapeKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
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.
bool HPS::ShapeKit::operator!= |
( |
ShapeKit const & |
in_kit | ) |
const |
Check if the source ShapeKit is not equivalent to this ShapeKit.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
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.
bool HPS::ShapeKit::operator== |
( |
ShapeKit const & |
in_kit | ) |
const |
Check if the source ShapeKit is equivalent to this ShapeKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
void HPS::ShapeKit::Set |
( |
ShapeKit const & |
in_kit | ) |
|
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.
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.
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.
void HPS::ShapeKit::Show |
( |
ShapeKit & |
out_kit | ) |
const |
Shows the elements for this ShapeKit.
- Parameters
-
out_def | The elements for the shape. |
- Returns
- true if elements were set, false otherwise.
ShapeKit& HPS::ShapeKit::UnsetElements |
( |
| ) |
|
Removes the elements for the shape.
- Returns
- A reference to this ShapeKit.
ShapeKit& HPS::ShapeKit::UnsetEverything |
( |
| ) |
|
The documentation for this class was generated from the following file: