NURBSCurveKit

class HPS.NURBSCurveKit : public HPS.Kit 

The NURBSCurveKit class is a user space object. It is a kit analog to a NURBSCurveKey.

Public Functions

void Consume (HPS.NURBSCurveKit in_kit)

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

Param in_kit: The source NURBSCurveKit to consume.

override void Dispose ()

HPS.NURBSCurveKit EditKnotsByDeletion (ulong in_offset, ulong in_count)

Removes knots for this NURBSCurveKit. This will allow modification of the default knots if no explicit knots are set if possible.

Param in_offset: The offset into the knots for the NURBSCurveKit at which to start removing knots. This value must be such that in_offset<control_point_count+degree+1 for deletion to succeed.
Param in_count: The number of knots to delete for the NURBSCurveKit. This value must be such that in_offset+in_count<=control_point_count+degree+1 for the deletion to succeed.
Return: A reference to this NURBSCurveKit.

HPS.NURBSCurveKit EditKnotsByInsertion (ulong in_offset, float[] in_knots)

Adds knots for this NURBSCurveKit. This will allow modification of the default knots if no explicit knots are set if possible.

Param in_offset: The offset into the knots the NURBSCurveKit at which to insert knots. This value must be such that in_offset<control_point_count+degree+1 for insertion to succeed.
Param in_knots: The knots to insert at the specified offset.
Return: A reference to this NURBSCurveKit.

HPS.NURBSCurveKit EditKnotsByReplacement (ulong in_offset, float[] in_knots)

Replaces knots for this NURBSCurveKit. This will allow modification of the default knots if no explicit knots are set if possible.

Param in_offset: The offset into the knots for the NURBSCurveKit at which to replace knots. This value must be such that in_offset<control_point_count+degree+1 for the replacement to succeed.
Param in_knots: The knots to use to replace those at the specified offset. The size of the array must be such that in_offset+in_knots.size()<=control_point_count+degree+1 for the replacement to succeed.
Return: A reference to this NURBSCurveKit.

HPS.NURBSCurveKit EditPointsByDeletion (ulong in_offset, ulong in_count)

Removes points from the control point list for this NURBSCurveKit.

Param in_offset: The offset into the control point list for the NURBSCurveKit 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 NURBSCurveKit. This value must be such that in_offset+in_count<=control_point_count for the deletion to succeed.
Return: A reference to this NURBSCurveKit.

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

Adds points to the control point list for this NURBSCurveKit.

Param in_offset: The offset into the control point list for the NURBSCurveKit 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 NURBSCurveKit.

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

Replaces control points for this NURBSCurveKit.

Param in_offset: The offset into the control point list for the NURBSCurveKit 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 NURBSCurveKit.

HPS.NURBSCurveKit EditWeightsByDeletion (ulong in_offset, ulong in_count)

Removes weights from the control point weight list for this NURBSCurveKit. 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 NURBSCurveKit 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 NURBSCurveKit. This value must be such that in_offset+in_count<=weight_count for the deletion to succeed.
Return: A reference to this NURBSCurveKit.

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

Adds weights to the control point weight list for this NURBSCurveKit. 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 NURBSCurveKit 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 NURBSCurveKit.

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

Replaces control point weights for this NURBSCurveKit. 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 NURBSCurveKit 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()<=weight_count for the replacement to succeed.
Return: A reference to this NURBSCurveKit.

override bool Empty ()

Indicates whether this NURBSCurveKit has any values set on it.

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

bool Equals (HPS.NURBSCurveKit in_kit)

Check if the source NURBSCurveKit is equivalent to this NURBSCurveKit.

Param in_kit: The source NURBSCurveKit to compare to this NURBSCurveKit.
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 curve.

Return: The number of points in this NURBS curve.

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

NURBSCurveKit (HPS.NURBSCurveKit in_kit)

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

Param in_kit: The source NURBSCurveKit 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.NURBSCurveKit in_kit)

Copies the source NURBSCurveKit into this NURBSCurveKit.

Param in_kit: The source NURBSCurveKit to copy.

HPS.NURBSCurveKit SetDegree (ulong in_degree)

Sets the degree of the NURBSCurveKit.

Param in_degree: The degree of the NURBSCurveKit.
Return: A reference to this NURBSCurveKit.

HPS.NURBSCurveKit SetKnots (float[] in_knots)

Sets the knots for the NURBSCurveKit.

Param in_knots: The knots for the NURBSCurveKit.
Return: A reference to this NURBSCurveKit.

HPS.NURBSCurveKit SetParameters (float in_start, float in_end)

Sets the normalized start and end parameters for the NURBSCurveKit.

Param in_start: The normalized start parameter for the NURBSCurveKit.
Param in_end: The normalized end parameter for the NURBSCurveKit.
Return: A reference to this NURBSCurveKit.

HPS.NURBSCurveKit SetPoints (HPS.Point[] in_points)

Sets the control points for the NURBSCurveKit.

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

HPS.NURBSCurveKit SetPriority (int in_priority)

Assigns a specific drawing priority value to the NURBSCurveKit. 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: SubwindowKit.SetPriority()
See: SubwindowKit.SetRenderingAlgorithm()

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

HPS.NURBSCurveKit 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.NURBSCurveKit 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.NURBSCurveKit 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.NURBSCurveKit SetWeights (float[] in_weights)

Sets the control point weights for the NURBSCurveKit.

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

void Show (out HPS.NURBSCurveKit out_kit)

Copies this NURBSCurveKit into the given NURBSCurveKit.

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

bool ShowDegree (out ulong out_degree)

Shows the degree of this NURBSCurveKit.

Param out_degree: The degree of this NURBSCurveKit.
Return: true if a degree was set, false otherwise.

bool ShowKnots (out float[] out_knots)

Shows the knots for this NURBSCurveKit.

Param out_knots: The knots for this NURBSCurveKit.
Return: true if knots were set, false otherwise.

bool ShowParameters (out float out_start, out float out_end)

Shows the normalized start and end parameters for this NURBSCurveKit.

Param out_start: The normalized start parameter for this NURBSCurveKit.
Param out_end: The normalized end parameter for this NURBSCurveKit.
Return: true if start and end parameters were set, false otherwise.

bool ShowPoints (out HPS.Point[] out_points)

Shows the control points for this NURBSCurveKit.

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

Param in_indices: The list of point indices to show.
Param out_points: The requested points for this NURBSCurveKit.
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 NURBSCurveKit 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 NURBSCurveKit.
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 ShowUserData (IntPtr in_index, out byte[] out_data)