TrimKit

class HPS::TrimKit : public HPS::Kit

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.

Public Functions

virtual bool Empty() const

Indicates whether this TrimKit has any values set on it.

Returns

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

bool Equals(TrimKit const &in_kit) const

Check if the source TrimKit is equivalent to this TrimKit.

Parameters

in_kit – The source TrimKit to compare to this TrimKit.

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!=(TrimKit const &in_kit) const

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

Parameters

in_kit – The source TrimKit to compare to this TrimKit.

Returns

true if the objects are not equivalent, false otherwise.

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_that – An rvalue reference to a TrimKit to take the impl from.

Returns

A reference to this TrimKit.

TrimKit &operator=(TrimKit const &in_kit)

Copies the source TrimKit into this TrimKit.

Parameters

in_kit – The source TrimKit to copy.

Returns

A reference to this TrimKit.

bool operator==(TrimKit const &in_kit) const

Check if the source TrimKit is equivalent to this TrimKit.

Parameters

in_kit – The source TrimKit to compare to this TrimKit.

Returns

true if the objects are equivalent, false otherwise.

void Set(TrimKit const &in_kit)

Copies the source TrimKit into this TrimKit.

Parameters

in_kit – The source TrimKit to copy.

TrimKit &SetOperation(Trim::Operation in_operation)

Sets the operation for the trim.

Parameters

in_operation – The operation for the trim.

Returns

A reference to this TrimKit.

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_count – Size of the following array.

• in_shape – An array of trim elements defining a trim region.

Returns

A reference to this TrimKit.

TrimKit &SetShape(TrimElement const &in_shape)

Sets the shape of the trim region.

Parameters

in_shape – An trim element defining a trim region.

Returns

A reference to this TrimKit.

TrimKit &SetShape(TrimElementArray const &in_shape)

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.

void Show(TrimKit &out_kit) const

Copies this TrimKit into the given TrimKit.

Parameters

out_kit – The TrimKit to populate with the contents of this TrimKit.

bool ShowOperation(Trim::Operation &out_operation) const

Shows the operation for the trim.

Parameters

out_operation – The operation for the trim.

Returns

true if an operation was set, false otherwise.

bool ShowShape(TrimElementArray &out_shape) const

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.

TrimKit()

The default constructor creates an empty TrimKit object.

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.

TrimKit(TrimKit const &in_kit)

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

Parameters

in_kit – The source TrimKit to copy.

TrimKit &UnsetEverything()

Removes all settings from this TrimKit.

Returns

A reference to this TrimKit.

TrimKit &UnsetOperation()

Removes the operation for the trim.

Returns

A reference to this TrimKit.

TrimKit &UnsetShape()

Removes the trim elements defining a trim region.

Returns

A reference to this TrimKit.

virtual ~TrimKit()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::TrimKit