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

override void Dispose ()

override bool Empty ()

Indicates whether this TrimKit has any values set on it.

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

bool Equals (HPS.TrimKit in_kit)

Check if the source TrimKit is equivalent to this TrimKit.

Param in_kit: The source TrimKit to compare to this TrimKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

override HPS.Type ObjectType ()

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).

Return: The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.TrimKit in_kit)

Copies the source TrimKit into this TrimKit.

Param in_kit: The source TrimKit to copy.

HPS.TrimKit SetOperation (HPS.Trim.Operation in_operation)

Sets the operation for the trim.

Param in_operation: The operation for the trim.
Return: A reference to this TrimKit.

HPS.TrimKit SetShape (HPS.TrimElement in_shape)

Sets the shape of the trim region.

Param in_shape: An trim element defining a trim region.
Return: A reference to this TrimKit.

HPS.TrimKit SetShape (HPS.TrimElement[] in_shape)

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

Param in_shape: An array of trim elements defining a trim region.
Return: A reference to this TrimKit.

void Show (out HPS.TrimKit out_kit)

Copies this TrimKit into the given TrimKit.

Param out_kit: The TrimKit to populate with the contents of this TrimKit.

bool ShowOperation (out HPS.Trim.Operation out_operation)

Shows the operation for the trim.

Param out_operation: The operation for the trim.
Return: true if an operation was set, false otherwise.

bool ShowShape (out HPS.TrimElement[] out_shape)

Shows the shape of the trim region.

Param out_shape: The array of trim elements defining a trim region.
Return: true if a shape was set, false otherwise.

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

TrimKit (HPS.TrimKit in_kit)

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

Param in_kit: The source TrimKit to copy.

HPS.TrimKit UnsetEverything ()

Removes all settings from this TrimKit.

Return: A reference to this TrimKit.

HPS.TrimKit UnsetOperation ()

Removes the operation for the trim.

Return: A reference to this TrimKit.

HPS.TrimKit UnsetShape ()

Removes the trim elements defining a trim region.

Return: A reference to this TrimKit.

Public Static Functions

bool operator!= (HPS.TrimKit a, HPS.TrimKit b)

bool operator== (HPS.TrimKit a, HPS.TrimKit b)