NURBSSurfaceKit

class HPS.NURBSSurfaceKit : HPS.Kit

The NURBSSurfaceKit class is a user space object. It is a kit analog to a NURBSSurfaceKey.

Public Functions

void Consume (HPS.NURBSSurfaceKit in_kit)

Copies the source NURBSSurfaceKit into this NURBSSurfaceKit and resets the source kit.

Param in_kit:The source NURBSSurfaceKit to consume.

override void Dispose ()

HPS.NURBSSurfaceKit EditPointsByDeletion (ulong in_offset, ulong in_count)

Removes points from the control point list for this NURBSSurfaceKit.

Param in_offset:  The offset into the control point list for the NURBSSurfaceKit at which to start removing points. This value must be such that in_offset<control_point_count for deletion to succeed. Param in_count:The number of points to delete from the control point list for the NURBSSurfaceKit. This value must be such that in_offset+in_count<=control_point_count for the deletion to succeed. Return:A reference to this NURBSSurfaceKit.

HPS.NURBSSurfaceKit EditPointsByInsertion (ulong in_offset, HPS.Point[] in_points)

Adds points to the control point list for this NURBSSurfaceKit.

Param in_offset:  The offset into the control point list for the NURBSSurfaceKit at which to insert points. This value must be such that in_offset <= control_point_count for insertion to succeed. Param in_points:  The points to insert into the control point list at the specified offset. Return:A reference to this NURBSSurfaceKit.

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

Replaces control points for this NURBSSurfaceKit.

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

HPS.NURBSSurfaceKit EditUKnotsByDeletion (ulong in_offset, ulong in_count)

Removes knots in the U direction for this NURBSSurfaceKit. This will allow modification of the default knots in the U direction if no such explicit knots are set if possible.

Param in_offset:  The offset into the knots in the U direction for the NURBSSurfaceKit at which to start removing knots. This value must be such that in_offset<u_count+u_degree+1 for deletion to succeed. Param in_count:The number of knots in the U direction to delete for the NURBSSurfaceKit. This value must be such that in_offset+in_count<=u_count+u_degree+1 for the deletion to succeed. Return:A reference to this NURBSSurfaceKit.

HPS.NURBSSurfaceKit EditUKnotsByInsertion (ulong in_offset, float[] in_knots)

Adds knots in the U direction for this NURBSSurfaceKit. This will allow modification of the default knots in the U direction if no such explicit knots are set if possible.

Param in_offset:  The offset into the knots in the U direction for the NURBSSurfaceKit at which to insert knots. This value must be such that in_offset<u_count+u_degree+1 for insertion to succeed. Param in_knots:The knots to insert in the U direction at the specified offset. Return:A reference to this NURBSSurfaceKit.

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

Replaces knots in the U direction for this NURBSSurfaceKit. This will allow modification of the default knots in the U direction if no such explicit knots are set if possible.

Param in_offset:  The offset into the knots in the U direction for the NURBSSurfaceKit at which to replace knots. This value must be such that in_offset<u_count+u_degree+1 for the replacement to succeed. Param in_knots:The knots to use to replace those in the U direction 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 NURBSSurfaceKit.

HPS.NURBSSurfaceKit EditVKnotsByDeletion (ulong in_offset, ulong in_count)

Removes knots in the V direction for this NURBSSurfaceKit. This will allow modification of the default knots in the V direction if no such explicit knots are set if possible.

Param in_offset:  The offset into the knots in the V direction for the NURBSSurfaceKit at which to start removing knots. This value must be such that in_offset<v_count+v_degree+1 for deletion to succeed. Param in_count:The number of knots in the V direction to delete for the NURBSSurfaceKit. This value must be such that in_offset+in_count<=v_count+v_degree+1 for the deletion to succeed. Return:A reference to this NURBSSurfaceKit.

HPS.NURBSSurfaceKit EditVKnotsByInsertion (ulong in_offset, float[] in_knots)

Adds knots in the V direction for this NURBSSurfaceKit. This will allow modification of the default knots in the V direction if no such explicit knots are set if possible.

Param in_offset:  The offset into the knots in the V direction for the NURBSSurfaceKit at which to insert knots. This value must be such that in_offset<v_count+v_degree+1 for insertion to succeed. Param in_knots:The knots to insert in the V direction at the specified offset. Return:A reference to this NURBSSurfaceKit.

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

Replaces knots in the V direction for this NURBSSurfaceKit. This will allow modification of the default knots in the V direction if no such explicit knots are set if possible.

Param in_offset:  The offset into the knots in the V direction for the NURBSSurfaceKit at which to replace knots. This value must be such that in_offset<v_count+v_degree+1 for the replacement to succeed. Param in_knots:The knots to use to replace those in the V direction 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 NURBSSurfaceKit.

HPS.NURBSSurfaceKit EditWeightsByDeletion (ulong in_offset, ulong in_count)

Removes weights from the control point weight list for this NURBSSurfaceKit. This will allow modification of the default control point weights if no explicit weights are set if possible.

Param in_offset:  The offset into the control point weight list for the NURBSSurfaceKit at which to start removing weights. This value must be such that in_offset<control_point_count for deletion to succeed. Param in_count:The number of weights to delete from the control point weight list for the NURBSSurfaceKit. This value must be such that in_offset+in_count<=control_point_count for the deletion to succeed. Return:A reference to this NURBSSurfaceKit.

HPS.NURBSSurfaceKit EditWeightsByInsertion (ulong in_offset, float[] in_weights)

Adds weights to the control point weight list for this NURBSSurfaceKit. This will allow modification of the default control point weights if no explicit weights are set if possible.

Param in_offset:  The offset into the control point weight list for the NURBSSurfaceKit at which to insert weights. This value must be such that in_offset<control_point_count for insertion to succeed. Param in_weights:  The weights to insert into the control point weight list at the specified offset. Return:A reference to this NURBSSurfaceKit.

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

Replaces control point weights for this NURBSSurfaceKit. This will allow modification of the default control point weights if no explicit weights are set if possible.

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

override bool Empty ()

Indicates whether this NURBSSurfaceKit has any values set on it.

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

bool Equals (HPS.NURBSSurfaceKit in_kit)

Check if the source NURBSSurfaceKit is equivalent to this NURBSSurfaceKit.

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

override bool Equals (Object obj)

override int GetHashCode ()

ulong GetPointCount ()

Retrieves the number of points in this NURBS surface.

Return:The number of points in this NURBS surface.

NURBSSurfaceKit ()

The default constructor creates an empty NURBSSurfaceKit object.

NURBSSurfaceKit (HPS.NURBSSurfaceKit in_kit)

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

Param in_kit:The source NURBSSurfaceKit 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)

Copies the source NURBSSurfaceKit into this NURBSSurfaceKit.

Param in_kit:The source NURBSSurfaceKit to copy.

HPS.NURBSSurfaceKit SetPoints (HPS.Point[] in_points)

Sets the control points for the NURBSSurfaceKit.

Param in_points:  The control points for the NURBSSurfaceKit. Return:A reference to this NURBSSurfaceKit.

HPS.NURBSSurfaceKit SetPriority (int in_priority)

Assigns a specific drawing priority value to the NURBSSurfaceKit. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority.

See also

SubwindowKit.SetPriority()

See also

SubwindowKit.SetRenderingAlgorithm()

See also

https://forum.techsoft3d.com/t/priority-sorting-in-3df-and-hps/5138

Param in_priority:  The drawing priority, higher priority items are drawn on top of lower priority items. Return:A reference to this object.

HPS.NURBSSurfaceKit SetTrim (HPS.TrimKit in_trim)

Sets the trim for the NURBSSurfaceKit.

Param in_trim:The trim for the NURBSSurfaceKit. Return:A reference to this NURBSSurfaceKit.

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

Sets the trims for the NURBSSurfaceKit.

Param in_trims:The trims for the NURBSSurfaceKit. Return:A reference to this NURBSSurfaceKit.

HPS.NURBSSurfaceKit SetUCount (ulong in_count)

Sets the number of control points in the U direction for the NURBSSurfaceKit.

Param in_count:The number of control points in the U direction for the NURBSSurfaceKit. Return:A reference to this NURBSSurfaceKit.

HPS.NURBSSurfaceKit SetUDegree (ulong in_degree)

Sets degree of the NURBSSurfaceKit in the U direction.

Param in_degree:  The degree of the NURBSSurfaceKit in the U direction. Return:A reference to this NURBSSurfaceKit.

HPS.NURBSSurfaceKit SetUKnots (float[] in_knots)

Sets the knots in the U direction for the NURBSSurfaceKit. If no knots are set when this kit is used to insert a NURBS surface, default knots of increasing value in the range [0,u_count+u_degree+1) will be used.

Param in_knots:The knots in the U direction for the NURBSSurfaceKit. Return:A reference to this NURBSSurfaceKit.

HPS.NURBSSurfaceKit SetUserData (IntPtr in_index, byte[] in_data)

Sets user data on this kit.

Param in_index:The index of the user data to set. Param in_data:The bytes of user data to set. Return:A reference to this kit.

HPS.NURBSSurfaceKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)

Sets user data on this kit.

Param in_index:The index of the user data to set. Param in_bytes:The number of bytes of user data to set. Param in_data:The bytes of user data to set. Return:A reference to this kit.

HPS.NURBSSurfaceKit SetUserData (IntPtr[] in_indices, byte[][] in_data)

Sets user data on this kit.

Param in_indices:  An array of user data indices to set. Param in_data:An array of bytes of user data to set. Return:A reference to this kit.

HPS.NURBSSurfaceKit SetVCount (ulong in_count)

Sets the number of control points in the V direction for the NURBSSurfaceKit.

Param in_count:The number of control points in the V direction for the NURBSSurfaceKit. Return:A reference to this NURBSSurfaceKit.

HPS.NURBSSurfaceKit SetVDegree (ulong in_degree)

Sets degree of the NURBSSurfaceKit in the V direction.

Param in_degree:  The degree of the NURBSSurfaceKit in the V direction. Return:A reference to this NURBSSurfaceKit.

HPS.NURBSSurfaceKit SetVKnots (float[] in_knots)

Sets the knots in the V direction for the NURBSSurfaceKit. If no knots are set when this kit is used to insert a NURBS surface, default knots of increasing value in the range [0,v_count+v_degree+1) will be used.

Param in_knots:The knots in the V direction for the NURBSSurfaceKit. Return:A reference to this NURBSSurfaceKit.

HPS.NURBSSurfaceKit SetWeights (float[] in_weights)

Sets the control point weights for the NURBSSurfaceKit. If no weights are set when this kit is used to insert a NURBS surface, default weights of 1.0f per control point will be used.

Param in_weights:  The control point weights for the NURBSSurfaceKit. Return:A reference to this NURBSSurfaceKit.

void Show (out HPS.NURBSSurfaceKit out_kit)

Copies this NURBSSurfaceKit into the given NURBSSurfaceKit.

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

bool ShowPoints (out HPS.Point[] out_points)

Shows the control points for this NURBSSurfaceKit.

Param out_points:  The control points for this NURBSSurfaceKit. 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 NURBSSurfaceKit by list.

Param in_indices:  The list of point indices to show. Param out_points:  The requested points for this NURBSSurfaceKit. 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 NURBSSurfaceKit 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 NURBSSurfaceKit. Return:true if all requested points were set, false otherwise.

bool ShowPriority (out int out_priority)

Shows the drawing priority.

Param out_priority:  The drawing priority, higher priority items are drawn on top of lower priority items. Return:true if the setting is valid, false otherwise.

bool ShowTrims (out HPS.TrimKit[] out_trims)

Shows the trims for this NURBSSurfaceKit.

Param out_trims:  The trims for this NURBSSurfaceKit. 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 NURBSSurfaceKit.

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

bool ShowUDegree (out ulong out_degree)

Shows the degree of this NURBSSurfaceKit in the U direction.

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

bool ShowUKnots (out float[] out_knots)

Shows the knots in the U direction for this NURBSSurfaceKit.

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

bool ShowUserData (IntPtr in_index, out byte[] out_data)

Shows the user data at a given index for this kit.

Param in_index:The index of the user data to show. Param out_data:The user data at the given index. Return:true if there is user data at the given index, false otherwise.

bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)

Shows all user data for this kit.

Param out_indices:  An array of all user data indices set on this kit. Param out_data:An array of all user data set on this kit. Return:true if there is user data on this kit, false otherwise.

ulong ShowUserDataCount ()

Get the number of user data indices set on this kit.

bool ShowUserDataIndices (out IntPtr[] out_indices)

Shows the indices of all user data set on this kit.

Param out_indices:  The user data indices set on this kit. Return:The number of user data indices set on this kit.

bool ShowVCount (out ulong out_count)

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

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

bool ShowVDegree (out ulong out_degree)

Shows the degree of this NURBSSurfaceKit in the V direction.

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

bool ShowVKnots (out float[] out_knots)

Shows the knots in the V direction for this NURBSSurfaceKit.

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

bool ShowWeights (out float[] out_weights)

Shows the control point weights for this NURBSSurfaceKit.

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

HPS.NURBSSurfaceKit UnsetAllUserData ()

Removes all user data from this kit.

Return:A reference to this kit.

HPS.NURBSSurfaceKit UnsetEverything ()

Removes all settings from the NURBSSurfaceKit.

Return:A reference to this NURBSSurfaceKit.

HPS.NURBSSurfaceKit UnsetPoints ()

Removes the control points for the NURBSSurfaceKit.

Return:A reference to this NURBSSurfaceKit.

HPS.NURBSSurfaceKit UnsetPriority ()

Removes a drawing priority setting.

Return:A reference to this object.

HPS.NURBSSurfaceKit UnsetTrims ()

Removes the trims from the NURBSSurfaceKit.

Return:A reference to this NURBSSurfaceKit.

HPS.NURBSSurfaceKit UnsetUCount ()

Removes the setting for the number of points in the U direction for the NURBSSurfaceKit.

Return:A reference to this NURBSSurfaceKit.

HPS.NURBSSurfaceKit UnsetUDegree ()

Removes the setting for the degree of the NURBSSurfaceKit in the U direction.

Return:A reference to this NURBSSurfaceKit.

HPS.NURBSSurfaceKit UnsetUKnots ()

Removes the knots in the U direction for the NURBSSurfaceKit.

Return:A reference to this NURBSSurfaceKit.

HPS.NURBSSurfaceKit UnsetUserData (IntPtr in_index)

Removes the user data at the given index from this kit.

Param in_index:The index of the user data to remove. Return:A reference to this kit.

HPS.NURBSSurfaceKit UnsetUserData (IntPtr[] in_indices)

Removes the user data at the given indices from this kit.

Param in_indices:  The indices of the user data to remove. Return:A reference to this kit.

HPS.NURBSSurfaceKit UnsetVCount ()

Removes the setting for the number of points in the V direction for the NURBSSurfaceKit.

Return:A reference to this NURBSSurfaceKit.

HPS.NURBSSurfaceKit UnsetVDegree ()

Removes the setting for the degree of the NURBSSurfaceKit in the V direction.

Return:A reference to this NURBSSurfaceKit.

HPS.NURBSSurfaceKit UnsetVKnots ()

Removes the knots in the V direction for the NURBSSurfaceKit.

Return:A reference to this NURBSSurfaceKit.

HPS.NURBSSurfaceKit UnsetWeights ()

Removes the control point weights for the NURBSSurfaceKit.

Return:A reference to this NURBSSurfaceKit.

Public Static Functions

bool operator!= (HPS.NURBSSurfaceKit a, HPS.NURBSSurfaceKit b)

bool operator== (HPS.NURBSSurfaceKit a, HPS.NURBSSurfaceKit b)