Inheritance diagram for HPS.NURBSCurveKit:
HPS.Kit HPS.Object

Public Member Functions

void Consume (HPS.NURBSCurveKit in_kit)
 
override void Dispose ()
 
HPS.NURBSCurveKit EditKnotsByDeletion (ulong in_offset, ulong in_count)
 
HPS.NURBSCurveKit EditKnotsByInsertion (ulong in_offset, float[] in_knots)
 
HPS.NURBSCurveKit EditKnotsByReplacement (ulong in_offset, float[] in_knots)
 
HPS.NURBSCurveKit EditPointsByDeletion (ulong in_offset, ulong in_count)
 
HPS.NURBSCurveKit EditPointsByInsertion (ulong in_offset, HPS.Point[] in_points)
 
HPS.NURBSCurveKit EditPointsByReplacement (ulong in_offset, HPS.Point[] in_points)
 
HPS.NURBSCurveKit EditWeightsByDeletion (ulong in_offset, ulong in_count)
 
HPS.NURBSCurveKit EditWeightsByInsertion (ulong in_offset, float[] in_weights)
 
HPS.NURBSCurveKit EditWeightsByReplacement (ulong in_offset, float[] in_weights)
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.NURBSCurveKit in_kit)
 
override int GetHashCode ()
 
ulong GetPointCount ()
 
 NURBSCurveKit ()
 
 NURBSCurveKit (HPS.NURBSCurveKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.NURBSCurveKit in_kit)
 
HPS.NURBSCurveKit SetDegree (ulong in_degree)
 
HPS.NURBSCurveKit SetKnots (float[] in_knots)
 
HPS.NURBSCurveKit SetParameters (float in_start, float in_end)
 
HPS.NURBSCurveKit SetPoints (HPS.Point[] in_points)
 
HPS.NURBSCurveKit SetPriority (int in_priority)
 
HPS.NURBSCurveKit SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.NURBSCurveKit SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.NURBSCurveKit SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
HPS.NURBSCurveKit SetWeights (float[] in_weights)
 
void Show (out HPS.NURBSCurveKit out_kit)
 
bool ShowDegree (out ulong out_degree)
 
bool ShowKnots (out float[] out_knots)
 
bool ShowParameters (out float out_start, out float out_end)
 
bool ShowPoints (out HPS.Point[] out_points)
 
bool ShowPointsByList (ulong[] in_indices, out HPS.Point[] out_points)
 
bool ShowPointsByRange (ulong in_start_index, ulong in_count, out HPS.Point[] out_points)
 
bool ShowPriority (out int out_priority)
 
bool ShowUserData (IntPtr in_index, out byte[] out_data)
 
bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
 
ulong ShowUserDataCount ()
 
bool ShowUserDataIndices (out IntPtr[] out_indices)
 
bool ShowWeights (out float[] out_weights)
 
HPS.NURBSCurveKit UnsetAllUserData ()
 
HPS.NURBSCurveKit UnsetDegree ()
 
HPS.NURBSCurveKit UnsetEverything ()
 
HPS.NURBSCurveKit UnsetKnots ()
 
HPS.NURBSCurveKit UnsetParameters ()
 
HPS.NURBSCurveKit UnsetPoints ()
 
HPS.NURBSCurveKit UnsetPriority ()
 
HPS.NURBSCurveKit UnsetUserData (IntPtr in_index)
 
HPS.NURBSCurveKit UnsetUserData (IntPtr[] in_indices)
 
HPS.NURBSCurveKit UnsetWeights ()
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static bool operator!= (HPS.NURBSCurveKit a, HPS.NURBSCurveKit b)
 
static bool operator== (HPS.NURBSCurveKit a, HPS.NURBSCurveKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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

Constructor & Destructor Documentation

◆ NURBSCurveKit() [1/2]

HPS.NURBSCurveKit.NURBSCurveKit ( )
inline

The default constructor creates an empty NURBSCurveKit object.

◆ NURBSCurveKit() [2/2]

HPS.NURBSCurveKit.NURBSCurveKit ( HPS.NURBSCurveKit  in_kit)
inline

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

Parameters
in_kitThe source NURBSCurveKit to copy.

Member Function Documentation

◆ Consume()

void HPS.NURBSCurveKit.Consume ( HPS.NURBSCurveKit  in_kit)
inline

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

Parameters
in_kitThe source NURBSCurveKit to consume.

◆ EditKnotsByDeletion()

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

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

Parameters
in_offsetThe 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.
in_countThe 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.
Returns
A reference to this NURBSCurveKit.

◆ EditKnotsByInsertion()

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

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

Parameters
in_offsetThe 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.
in_knotsThe knots to insert at the specified offset.
Returns
A reference to this NURBSCurveKit.

◆ EditKnotsByReplacement()

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

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

Parameters
in_offsetThe 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.
in_knotsThe 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.
Returns
A reference to this NURBSCurveKit.

◆ EditPointsByDeletion()

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

Removes points from the control point list for this NURBSCurveKit.

Parameters
in_offsetThe 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.
in_countThe 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.
Returns
A reference to this NURBSCurveKit.

◆ EditPointsByInsertion()

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

Adds points to the control point list for this NURBSCurveKit.

Parameters
in_offsetThe 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.
in_pointsThe points to insert into the control point list at the specified offset.
Returns
A reference to this NURBSCurveKit.

◆ EditPointsByReplacement()

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

Replaces control points for this NURBSCurveKit.

Parameters
in_offsetThe 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.
in_pointsThe 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.
Returns
A reference to this NURBSCurveKit.

◆ EditWeightsByDeletion()

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

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.

Parameters
in_offsetThe 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.
in_countThe 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.
Returns
A reference to this NURBSCurveKit.

◆ EditWeightsByInsertion()

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

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.

Parameters
in_offsetThe 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.
in_weightsThe weights to insert into the control point weight list at the specified offset.
Returns
A reference to this NURBSCurveKit.

◆ EditWeightsByReplacement()

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

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.

Parameters
in_offsetThe 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.
in_weightsThe 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.
Returns
A reference to this NURBSCurveKit.

◆ Empty()

override bool HPS.NURBSCurveKit.Empty ( )
inlinevirtual

Indicates whether this NURBSCurveKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

bool HPS.NURBSCurveKit.Equals ( HPS.NURBSCurveKit  in_kit)
inline

Check if the source NURBSCurveKit is equivalent to this NURBSCurveKit.

Parameters
in_kitThe source NURBSCurveKit to compare to this NURBSCurveKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetPointCount()

ulong HPS.NURBSCurveKit.GetPointCount ( )
inline

Retrieves the number of points in this NURBS curve.

Returns
The number of points in this NURBS curve.

◆ ObjectType()

override HPS.Type HPS.NURBSCurveKit.ObjectType ( )
inlinevirtual

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

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

Reimplemented from HPS.Kit.

◆ Set()

void HPS.NURBSCurveKit.Set ( HPS.NURBSCurveKit  in_kit)
inline

Copies the source NURBSCurveKit into this NURBSCurveKit.

Parameters
in_kitThe source NURBSCurveKit to copy.

◆ SetDegree()

HPS.NURBSCurveKit HPS.NURBSCurveKit.SetDegree ( ulong  in_degree)
inline

Sets the degree of the NURBSCurveKit.

Parameters
in_degreeThe degree of the NURBSCurveKit.
Returns
A reference to this NURBSCurveKit.

◆ SetKnots()

HPS.NURBSCurveKit HPS.NURBSCurveKit.SetKnots ( float []  in_knots)
inline

Sets the knots for the NURBSCurveKit.

Parameters
in_knotsThe knots for the NURBSCurveKit.
Returns
A reference to this NURBSCurveKit.

◆ SetParameters()

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

Sets the normalized start and end parameters for the NURBSCurveKit.

Parameters
in_startThe noramlized start parameter for the NURBSCurveKit.
in_endThe noramlized end parameter for the NURBSCurveKit.
Returns
A reference to this NURBSCurveKit.

◆ SetPoints()

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

Sets the control points for the NURBSCurveKit.

Parameters
in_pointsThe control points for the NURBSCurveKit.
Returns
A reference to this NURBSCurveKit.

◆ SetPriority()

HPS.NURBSCurveKit HPS.NURBSCurveKit.SetPriority ( int  in_priority)
inline

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.

Parameters
in_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
A reference to this object.
See also
SubwindowKit.SetPriority()
SubwindowKit.SetRenderingAlgorithm()

◆ SetUserData() [1/3]

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

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_bytesThe number of bytes of user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [2/3]

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

Sets user data on this kit.

Parameters
in_indexThe index of the user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this kit.

◆ SetUserData() [3/3]

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

Sets user data on this kit.

Parameters
in_indicesAn array of user data indices to set.
in_dataAn array of bytes of user data to set.
Returns
A reference to this kit.

◆ SetWeights()

HPS.NURBSCurveKit HPS.NURBSCurveKit.SetWeights ( float []  in_weights)
inline

Sets the control point weights for the NURBSCurveKit.

Parameters
in_weightsThe control point weights for the NURBSCurveKit.
Returns
A reference to this NURBSCurveKit.

◆ Show()

void HPS.NURBSCurveKit.Show ( out HPS.NURBSCurveKit  out_kit)
inline

Copies this NURBSCurveKit into the given NURBSCurveKit.

Parameters
out_kitThe NURBSCurveKit to populate with the contents of this NURBSCurveKit.

◆ ShowDegree()

bool HPS.NURBSCurveKit.ShowDegree ( out ulong  out_degree)
inline

Shows the degree of this NURBSCurveKit.

Parameters
out_degreeThe degree of this NURBSCurveKit.
Returns
true if a degree was set, false otherwise.

◆ ShowKnots()

bool HPS.NURBSCurveKit.ShowKnots ( out float []  out_knots)
inline

Shows the knots for this NURBSCurveKit.

Parameters
out_knotsThe knots for this NURBSCurveKit.
Returns
true if knots were set, false otherwise.

◆ ShowParameters()

bool HPS.NURBSCurveKit.ShowParameters ( out float  out_start,
out float  out_end 
)
inline

Shows the normalized start and end parameters for this NURBSCurveKit.

Parameters
out_startThe normalized start parameter for this NURBSCurveKit.
out_endThe normalized end parameter for this NURBSCurveKit.
Returns
true if start and end parameters were set, false otherwise.

◆ ShowPoints()

bool HPS.NURBSCurveKit.ShowPoints ( out HPS.Point []  out_points)
inline

Shows the control points for this NURBSCurveKit.

Parameters
out_pointsThe control points for this NURBSCurveKit.
Returns
true if control points were set, false otherwise.

◆ ShowPointsByList()

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

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

Parameters
in_indicesThe list of point indices to show.
out_pointsThe requested points for this NURBSCurveKit.
Returns
true if all requested points were set, false otherwise.

◆ ShowPointsByRange()

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

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

Parameters
in_start_indexThe first point to show.
in_countThe number of points to show.
out_pointsThe requested points for this NURBSCurveKit.
Returns
true if all requested points were set, false otherwise.

◆ ShowPriority()

bool HPS.NURBSCurveKit.ShowPriority ( out int  out_priority)
inline

Shows the drawing priority.

Parameters
out_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
true if the setting is valid, false otherwise.

◆ ShowUserData() [1/2]

bool HPS.NURBSCurveKit.ShowUserData ( IntPtr  in_index,
out byte []  out_data 
)
inline

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

Parameters
in_indexThe index of the user data to show.
out_dataThe user data at the given index.
Returns
true if there is user data at the given index, false otherwise.

◆ ShowUserData() [2/2]

bool HPS.NURBSCurveKit.ShowUserData ( out IntPtr []  out_indices,
out byte  out_data[][] 
)
inline

Shows all user data for this kit.

Parameters
out_indicesAn array of all user data indices set on this kit.
out_dataAn array of all user data set on this kit.
Returns
true if there is user data on this kit, false otherwise.

◆ ShowUserDataCount()

ulong HPS.NURBSCurveKit.ShowUserDataCount ( )
inline

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

◆ ShowUserDataIndices()

bool HPS.NURBSCurveKit.ShowUserDataIndices ( out IntPtr []  out_indices)
inline

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

Parameters
out_indicesThe user data indices set on this kit.
Returns
The number of user data indices set on this kit.

◆ ShowWeights()

bool HPS.NURBSCurveKit.ShowWeights ( out float []  out_weights)
inline

Shows the control point weights for this NURBSCurveKit.

Parameters
out_weightsThe control point weights for this NURBSCurveKit.
Returns
true if control point weights were set, false otherwise.

◆ UnsetAllUserData()

HPS.NURBSCurveKit HPS.NURBSCurveKit.UnsetAllUserData ( )
inline

Removes all user data from this kit.

Returns
A reference to this kit.

◆ UnsetDegree()

HPS.NURBSCurveKit HPS.NURBSCurveKit.UnsetDegree ( )
inline

Removes the setting for the degree of the NURBSCurveKit.

Returns
A reference to this NURBSCurveKit.

◆ UnsetEverything()

HPS.NURBSCurveKit HPS.NURBSCurveKit.UnsetEverything ( )
inline

Removes all settings from the NURBSCurveKit.

Returns
A reference to this NURBSCurveKit.

◆ UnsetKnots()

HPS.NURBSCurveKit HPS.NURBSCurveKit.UnsetKnots ( )
inline

Removes the knots for the NURBSCurveKit.

Returns
A reference to this NURBSCurveKit.

◆ UnsetParameters()

HPS.NURBSCurveKit HPS.NURBSCurveKit.UnsetParameters ( )
inline

Removes the normalized start and end parameters for the NURBSCurveKit.

Returns
A reference to this NURBSCurveKit.

◆ UnsetPoints()

HPS.NURBSCurveKit HPS.NURBSCurveKit.UnsetPoints ( )
inline

Removes the control points for the NURBSCurveKit.

Returns
A reference to this NURBSCurveKit.

◆ UnsetPriority()

HPS.NURBSCurveKit HPS.NURBSCurveKit.UnsetPriority ( )
inline

Removes a drawing priority setting.

Returns
A reference to this object.

◆ UnsetUserData() [1/2]

HPS.NURBSCurveKit HPS.NURBSCurveKit.UnsetUserData ( IntPtr  in_index)
inline

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

Parameters
in_indexThe index of the user data to remove.
Returns
A reference to this kit.

◆ UnsetUserData() [2/2]

HPS.NURBSCurveKit HPS.NURBSCurveKit.UnsetUserData ( IntPtr []  in_indices)
inline

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

Parameters
in_indicesThe indices of the user data to remove.
Returns
A reference to this kit.

◆ UnsetWeights()

HPS.NURBSCurveKit HPS.NURBSCurveKit.UnsetWeights ( )
inline

Removes the control point weights for the NURBSCurveKit.

Returns
A reference to this NURBSCurveKit.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.NURBSCurveKit.cs