TrimElement

class HPS.TrimElement : HPS.Object 

The TrimElement class is a user space object. It is used to specify the curves that are used to define a trim region.

Public Functions

bool Equals (HPS.TrimElement in_that)

Check if the source TrimElement is equivalent to this TrimElement.

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

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.TrimElement in_that)

Copies the source TrimElement into this TrimElement.

Param in_that:	The source TrimElement to copy.

void SetCurve (HPS.LineKit in_line)

Sets a line as the curve for this TrimElement.

Param in_line:	The line for this TrimElement. Only the X and Y coordinates of the points defining the line will be used when the trim region is applied to a surface. The coordinates will be treated as U and V parameter values in the normalized parameter space for the NURBS surface.

void SetCurve (HPS.NURBSCurveKit in_curve)

Sets a NURBS curve as the curve for this TrimElement.

Param in_curve:	The NURBS curve for this TrimElement. Only the X and Y coordinates of the control points defining the curve will be used when the trim region is applied to a surface. The coordinates will be treated as U and V parameter values in the normalized parameter space for the NURBS surface.

bool ShowCurve (out HPS.Trim.Type out_type, out HPS.LineKit out_line, out HPS.NURBSCurveKit out_curve)

Shows the curve for this TrimElement.

Param out_curve:
Param out_type:	The type of curve used for this TrimElement.
Param out_line:	The line for the trim curve. This is only valid if out_type</type> is NURBSSurface.Line.
	The NURBS curve for the trim curve. This is only valid if out_type</type> is NURBSSurface.Curve.
Return:	true if a line or NURBS curve was set, false otherwise.

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

TrimElement (HPS.LineKit in_line)

This constructor creates a TrimElement with a line.

Param in_line:	The line for this TrimElement. Only the X and Y coordinates of the points defining the line will be used when the trim region is applied to a surface. The coordinates will be treated as U and V parameter values in the normalized parameter space for the NURBS surface.

TrimElement (HPS.NURBSCurveKit in_curve)

This constructor creates a TrimElement with a NURBS curve.

Param in_curve:	The NURBS curve for this TrimElement. Only the X and Y coordinates of the control points defining the curve will be used when the trim region is applied to a surface. The coordinates will be treated as U and V parameter values in the normalized parameter space for the NURBS surface.

TrimElement (HPS.TrimElement in_that)

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

Param in_that:	The source TrimElement to copy.

Public Static Functions