NURBSSurfaceKey

class HPS.NURBSSurfaceKey : HPS.GeometryKey

The NURBSSurfaceKey class is a smart pointer to a database object. It is a handle to a NURBS surface inserted via SegmentKey.InsertNURBSSurface.

Public Functions

void Consume (HPS.NURBSSurfaceKit in_kit)

Completely replaces all settings on this NURBSSurfaceKey with those set on the specified kit and resets the kit.

Param in_kit:The kit from which to get the settings to replace on this NURBSSurfaceKey.

override void Dispose ()

HPS.NURBSSurfaceKey EditPointsByReplacement (ulong in_offset, HPS.Point[] in_points)

Replaces control points for this NURBSSurfaceKey.

Param in_offset:  The offset into the control points for this NURBS surface at which to start replacing points. This value must be such that in_offset<control_point_count for replacement to succeed. Param in_points:  The points to use to replace those in the control point list at the specified offset. The size of the array must be such that such that in_offset+in_points.size()<=control_point_count for the replacement to succeed. Return:A reference to this NURBSSurfaceKey.

HPS.NURBSSurfaceKey EditUKnotsByReplacement (ulong in_offset, float[] in_knots)

Replaces knots in the U direction for this NURBSSurfaceKey. It is possible to edit these knots even if no knots were specified (i.e., default knots were used) when the NURBS surface was inserted.

Param in_offset:  The offset into the knots in the U direction for this NURBS surface at which to start replacing knots. This value must be such that in_offset<u_count+u_degree+1 for replacement to succeed. Param in_knots:The knots in the U direction to use to replace those at the specified offset. The size of the array must be such that in_offset+in_knots.size()<=u_count+u_degree+1 for the replacement to succeed. Return:A reference to this NURBSSurfaceKey.

HPS.NURBSSurfaceKey EditVKnotsByReplacement (ulong in_offset, float[] in_knots)

Replaces knots in the V direction for this NURBSSurfaceKey. It is possible to edit these knots even if no knots were specified (i.e., default knots were used) when the NURBS surface was inserted.

Param in_offset:  The offset into the knots in the V direction for this NURBS surface at which to start replacing knots. This value must be such that in_offset<v_count+v_degree+1 for replacement to succeed. Param in_knots:The knots in the V direction to use to replace those at the specified offset. The size of the array must be such that in_offset+in_knots.size()<=v_count+v_degree+1 for the replacement to succeed. Return:A reference to this NURBSSurfaceKey.

HPS.NURBSSurfaceKey EditWeightsByReplacement (ulong in_offset, float[] in_weights)

Replaces control point weights for this NURBSSurfaceKey. It is possible to edit control point weights even if no weights were specified (i.e., default weights were used) when the NURBS surface was inserted.

Param in_offset:  The offset into the control point weights for this NURBS surface at which to start replacing weights. This value must be such that in_offset<control_point_count for replacement to succeed. Param in_weights:  The weights to use to replace those in the control point weight list at the specified offset. The size of the array must be such that such that in_offset+in_weights.size()<=control_point_count for the replacement to succeed. Return:A reference to this NURBSSurfaceKey.

ulong GetPointCount ()

Retrieves the number of points in this NURBS surface.

Return:The number of points in this NURBS surface.

NURBSSurfaceKey ()

The default constructor creates an uninitialized NURBSSurfaceKey object. The Type() function will return Type.None.

NURBSSurfaceKey (HPS.Key in_that)

This constructor creates a NURBSSurfaceKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of a NURBSSurface key. Otherwise the copy will fail and the resulting NURBSSurfaceKey will be invalid.

NURBSSurfaceKey (HPS.NURBSSurfaceKey in_that)

The copy constructor creates a NURBSSurfaceKey object that shares the underlying smart-pointer of the source NURBSSurfaceKey.

Param in_that:The source NURBSSurfaceKey to copy.

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

Replace those settings on this NURBSSurfaceKey with those set on the specified kit.

Param in_kit:The kit from which to get the settings to replace on this NURBSSurfaceKey.

HPS.NURBSSurfaceKey SetTrim (HPS.TrimKit in_trim)

Sets the specified trim on this NURBSSurfaceKey. These will replace any existing trims.

Param in_trim:The trim to apply to this NURBSSurfaceKey. Return:A reference to this NURBSSurfaceKey.

HPS.NURBSSurfaceKey SetTrims (HPS.TrimKit[] in_trims)

Sets the specified trims on this NURBSSurfaceKey. These will replace any existing trims.

Param in_trims:The array of trims to apply to this NURBSSurfaceKey. Return:A reference to this NURBSSurfaceKey.

void Show (out HPS.NURBSSurfaceKit out_kit)

Copy the contents of this NURBSSurfaceKey into the specified kit.

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

bool ShowPoints (out HPS.Point[] out_points)

Shows the control points for this NURBSSurfaceKey.

Param out_points:  The control points for this NURBSSurfaceKey. Return:true if control points were set, false otherwise.

bool ShowPointsByList (ulong[] in_indices, out HPS.Point[] out_points)

Show a subset of the points for this NURBSSurfaceKey by list.

Param in_indices:  The list of point indices to show. Param out_points:  The requested points for this NURBSSurfaceKey. Return:true if all requested points were set, false otherwise.

bool ShowPointsByRange (ulong in_start_index, ulong in_count, out HPS.Point[] out_points)

Show a subset of the points for this NURBSSurfaceKey by range.

Param in_start_index:  The first point to show. Param in_count:The number of points to show. Param out_points:  The requested points for this NURBSSurfaceKey. Return:true if all requested points were set, false otherwise.

bool ShowTrims (out HPS.TrimKit[] out_trims)

Shows the trims for this NURBSSurfaceKey.

Param out_trims:  The trims for this NURBSSurfaceKey. Return:true if trims were set, false otherwise.

bool ShowUCount (out ulong out_count)

Shows the number of control points in the U direction for this NURBSSurfaceKey.

Param out_count:  The number of control points in the U direction for this NURBSSurfaceKey. Return:true if such a count was set, false otherwise.

bool ShowUDegree (out ulong out_degree)

Shows the degree of this NURBSSurfaceKey in the U direction.

Param out_degree:  The degree of this NURBSSurfaceKey in the U direction. Return:true if such a degree was set, false otherwise.

bool ShowUKnots (out float[] out_knots)

Shows the knot sequence in the U direction for this NURBSSurfaceKey.

Param out_knots:  The knot sequence in the U direction for this NURBSSurfaceKey. Return:true if these knots were set, false otherwise.

bool ShowVCount (out ulong out_count)

Shows the number of control points in the V direction for this NURBSSurfaceKey.

Param out_count:  The number of control points in the V direction for this NURBSSurfaceKey. Return:true if such a count was set, false otherwise.

bool ShowVDegree (out ulong out_degree)

Shows the degree of this NURBSSurfaceKey in the V direction.

Param out_degree:  The degree of this NURBSSurfaceKey in the V direction. Return:true if such a degree was set, false otherwise.

bool ShowVKnots (out float[] out_knots)

Shows the knot sequence in the V direction for this NURBSSurfaceKey.

Param out_knots:  The knot sequence in the V direction for this NURBSSurfaceKey. Return:true if these knots were set, false otherwise.

bool ShowWeights (out float[] out_weights)

Shows the control point weights for this NURBSSurfaceKey.

Param out_weights:  The control point weights for this NURBSSurfaceKey. Return:true if control point weights were set, false otherwise.

HPS.NURBSSurfaceKey UnsetTrims ()

Removes the trims from this NURBSSurfaceKey.

Return:A reference to this NURBSSurfaceKey.