#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::TrimKit |
|
static const HPS::Type | staticType = HPS::Type::Kit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
The TrimKit class is a user space object. It is used to define trim curves (either NURBS curves or lines) that can be used to trim NURBS surfaces.
◆ TrimKit() [1/3]
HPS::TrimKit::TrimKit |
( |
| ) |
|
The default constructor creates an empty TrimKit object.
◆ TrimKit() [2/3]
HPS::TrimKit::TrimKit |
( |
TrimKit const & |
in_kit | ) |
|
The copy constructor creates a new TrimKit object that contains the same settings as the source TrimKit.
- Parameters
-
◆ TrimKit() [3/3]
HPS::TrimKit::TrimKit |
( |
TrimKit && |
in_that | ) |
|
The move constructor creates a TrimKit by transferring the underlying impl of the rvalue reference to this TrimKit thereby avoiding a copy and allocation.
- Parameters
-
in_that | An rvalue reference to a TrimKit to take the impl from. |
◆ Empty()
bool HPS::TrimKit::Empty |
( |
| ) |
const |
|
virtual |
Indicates whether this TrimKit has any values set on it.
- Returns
- true if no values are set on this TrimKit, false otherwise.
Reimplemented from HPS::Object.
◆ Equals()
bool HPS::TrimKit::Equals |
( |
TrimKit const & |
in_kit | ) |
const |
Check if the source TrimKit is equivalent to this TrimKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ ObjectType()
HPS::Type HPS::TrimKit::ObjectType |
( |
| ) |
const |
|
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::Kit.
◆ operator!=()
bool HPS::TrimKit::operator!= |
( |
TrimKit const & |
in_kit | ) |
const |
Check if the source TrimKit is not equivalent to this TrimKit.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
The move assignment operator transfers the underlying impl of the rvalue reference to this TrimKit thereby avoiding a copy.
- Parameters
-
in_that | An rvalue reference to a TrimKit to take the impl from. |
- Returns
- A reference to this TrimKit.
◆ operator=() [2/2]
◆ operator==()
bool HPS::TrimKit::operator== |
( |
TrimKit const & |
in_kit | ) |
const |
Check if the source TrimKit is equivalent to this TrimKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
void HPS::TrimKit::Set |
( |
TrimKit const & |
in_kit | ) |
|
◆ SetOperation()
Sets the operation for the trim.
- Parameters
-
in_operation | The operation for the trim. |
- Returns
- A reference to this TrimKit.
◆ SetShape() [1/3]
Sets the shape of the trim region. The shape is a collection of trim elements.
- Parameters
-
in_count | Size of the following array. |
in_shape | An array of trim elements defining a trim region. |
- Returns
- A reference to this TrimKit.
◆ SetShape() [2/3]
Sets the shape of the trim region. The shape is a collection of trim elements.
- Parameters
-
in_shape | An array of trim elements defining a trim region. |
- Returns
- A reference to this TrimKit.
◆ SetShape() [3/3]
Sets the shape of the trim region.
- Parameters
-
in_shape | An trim element defining a trim region. |
- Returns
- A reference to this TrimKit.
◆ Show()
void HPS::TrimKit::Show |
( |
TrimKit & |
out_kit | ) |
const |
◆ ShowOperation()
Shows the operation for the trim.
- Parameters
-
out_operation | The operation for the trim. |
- Returns
- true if an operation was set, false otherwise.
◆ ShowShape()
Shows the shape of the trim region.
- Parameters
-
out_shape | The array of trim elements defining a trim region. |
- Returns
- true if a shape was set, false otherwise.
◆ UnsetEverything()
TrimKit& HPS::TrimKit::UnsetEverything |
( |
| ) |
|
Removes all settings from this TrimKit.
- Returns
- A reference to this TrimKit.
◆ UnsetOperation()
TrimKit& HPS::TrimKit::UnsetOperation |
( |
| ) |
|
Removes the operation for the trim.
- Returns
- A reference to this TrimKit.
◆ UnsetShape()
TrimKit& HPS::TrimKit::UnsetShape |
( |
| ) |
|
Removes the trim elements defining a trim region.
- Returns
- A reference to this TrimKit.
The documentation for this class was generated from the following file: