#include <hps.h>

Inheritance diagram for HPS::TrimKit:
HPS::Kit HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (TrimKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (TrimKit const &in_kit) const
 
TrimKitoperator= (TrimKit &&in_that)
 
TrimKitoperator= (TrimKit const &in_kit)
 
bool operator== (TrimKit const &in_kit) const
 
void Set (TrimKit const &in_kit)
 
TrimKitSetOperation (Trim::Operation in_operation)
 
TrimKitSetShape (size_t in_count, TrimElement const in_shape[])
 
TrimKitSetShape (TrimElementArray const &in_shape)
 
TrimKitSetShape (TrimElement const &in_shape)
 
void Show (TrimKit &out_kit) const
 
bool ShowOperation (Trim::Operation &out_operation) const
 
bool ShowShape (TrimElementArray &out_shape) const
 
 TrimKit ()
 
 TrimKit (TrimKit const &in_kit)
 
 TrimKit (TrimKit &&in_that)
 
TrimKitUnsetEverything ()
 
TrimKitUnsetOperation ()
 
TrimKitUnsetShape ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::TrimKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ 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
in_kitThe source TrimKit to copy.

◆ 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_thatAn rvalue reference to a TrimKit to take the impl from.

Member Function Documentation

◆ 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
in_kitThe source TrimKit to compare to this TrimKit.
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
in_kitThe source TrimKit to compare to this TrimKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

TrimKit& HPS::TrimKit::operator= ( TrimKit &&  in_that)

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

Parameters
in_thatAn rvalue reference to a TrimKit to take the impl from.
Returns
A reference to this TrimKit.

◆ operator=() [2/2]

TrimKit& HPS::TrimKit::operator= ( TrimKit const &  in_kit)

Copies the source TrimKit into this TrimKit.

Parameters
in_kitThe source TrimKit to copy.
Returns
A reference to this TrimKit.

◆ operator==()

bool HPS::TrimKit::operator== ( TrimKit const &  in_kit) const

Check if the source TrimKit is equivalent to this TrimKit.

Parameters
in_kitThe source TrimKit to compare to this TrimKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::TrimKit::Set ( TrimKit const &  in_kit)

Copies the source TrimKit into this TrimKit.

Parameters
in_kitThe source TrimKit to copy.

◆ SetOperation()

TrimKit& HPS::TrimKit::SetOperation ( Trim::Operation  in_operation)

Sets the operation for the trim.

Parameters
in_operationThe operation for the trim.
Returns
A reference to this TrimKit.

◆ SetShape() [1/3]

TrimKit& HPS::TrimKit::SetShape ( size_t  in_count,
TrimElement const  in_shape[] 
)

Sets the shape of the trim region. The shape is a collection of trim elements.

Parameters
in_countSize of the following array.
in_shapeAn array of trim elements defining a trim region.
Returns
A reference to this TrimKit.

◆ SetShape() [2/3]

TrimKit& HPS::TrimKit::SetShape ( TrimElementArray const &  in_shape)

Sets the shape of the trim region. The shape is a collection of trim elements.

Parameters
in_shapeAn array of trim elements defining a trim region.
Returns
A reference to this TrimKit.

◆ SetShape() [3/3]

TrimKit& HPS::TrimKit::SetShape ( TrimElement const &  in_shape)

Sets the shape of the trim region.

Parameters
in_shapeAn trim element defining a trim region.
Returns
A reference to this TrimKit.

◆ Show()

void HPS::TrimKit::Show ( TrimKit out_kit) const

Copies this TrimKit into the given TrimKit.

Parameters
out_kitThe TrimKit to populate with the contents of this TrimKit.

◆ ShowOperation()

bool HPS::TrimKit::ShowOperation ( Trim::Operation out_operation) const

Shows the operation for the trim.

Parameters
out_operationThe operation for the trim.
Returns
true if an operation was set, false otherwise.

◆ ShowShape()

bool HPS::TrimKit::ShowShape ( TrimElementArray out_shape) const

Shows the shape of the trim region.

Parameters
out_shapeThe 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: