Inheritance diagram for HPS.NURBSCurveKey:
HPS.GeometryKey HPS.Key HPS.Object

Public Member Functions

void Consume (HPS.NURBSCurveKit in_kit)
 
override void Dispose ()
 
HPS.NURBSCurveKey EditKnotsByReplacement (ulong in_offset, float[] in_knots)
 
HPS.NURBSCurveKey EditPointsByReplacement (ulong in_offset, HPS.Point[] in_points)
 
HPS.NURBSCurveKey EditWeightsByReplacement (ulong in_offset, float[] in_weights)
 
ulong GetPointCount ()
 
 NURBSCurveKey ()
 
 NURBSCurveKey (HPS.Key in_that)
 
 NURBSCurveKey (HPS.NURBSCurveKey in_that)
 
override HPS.Type ObjectType ()
 
void Set (HPS.NURBSCurveKit in_kit)
 
HPS.NURBSCurveKey SetParameters (float in_start, float in_end)
 
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 ShowWeights (out float[] out_weights)
 
- Public Member Functions inherited from HPS.GeometryKey
 GeometryKey ()
 
 GeometryKey (HPS.Key in_that)
 
 GeometryKey (HPS.GeometryKey in_that)
 
HPS.GeometryKey SetPriority (int in_priority)
 
HPS.GeometryKey SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.GeometryKey SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.GeometryKey SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
bool ShowBounding (out HPS.BoundingKit out_kit)
 
bool ShowPriority (out int out_priority)
 
ulong ShowReferrers (out HPS.SegmentKey[] out_segments)
 
ulong ShowReferrers (out HPS.ReferenceKey[] out_references)
 
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)
 
HPS.GeometryKey UnsetAllUserData ()
 
HPS.GeometryKey UnsetPriority ()
 
HPS.GeometryKey UnsetUserData (IntPtr in_index)
 
HPS.GeometryKey UnsetUserData (IntPtr[] in_indices)
 
- Public Member Functions inherited from HPS.Key
virtual void Assign (HPS.Key in_that)
 
HPS.Key CopyTo (HPS.SegmentKey in_destination)
 
void Delete ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Key in_that)
 
ulong GetHash ()
 
override int GetHashCode ()
 
bool HasOwner ()
 
 Key ()
 
 Key (HPS.Key in_that)
 
 Key (HPS.Control in_control)
 
void MoveTo (HPS.SegmentKey in_new_owner)
 
HPS.SegmentKey Owner ()
 
HPS.SegmentKey Up ()
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Protected Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Key
static bool operator!= (HPS.Key a, HPS.Key b)
 
static bool operator== (HPS.Key a, HPS.Key b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The NURBSCurveKey class is a smart pointer to a database object. It is a handle to a NURBS curve inserted via SegmentKey.InsertNURBSCurve.

Constructor & Destructor Documentation

◆ NURBSCurveKey() [1/3]

HPS.NURBSCurveKey.NURBSCurveKey ( )
inline

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

◆ NURBSCurveKey() [2/3]

HPS.NURBSCurveKey.NURBSCurveKey ( HPS.Key  in_that)
inline

This constructor creates a NURBSCurveKey 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 NURBSCurve key. Otherwise the copy will fail and the resulting NURBSCurveKey will be invalid.

◆ NURBSCurveKey() [3/3]

HPS.NURBSCurveKey.NURBSCurveKey ( HPS.NURBSCurveKey  in_that)
inline

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

Parameters
in_thatThe source NURBSCurveKey to copy.

Member Function Documentation

◆ Consume()

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

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

Parameters
in_kitThe kit from which to get the settings to replace on this NURBSCurveKey.

◆ EditKnotsByReplacement()

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

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

Parameters
in_offsetThe offset into the knots for this NURBS curve at which to start replacing knots. This value must be such that in_offset<control_point_count+degree+1 for 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 NURBSCurveKey.

◆ EditPointsByReplacement()

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

Replaces control points for this NURBSCurveKey.

Parameters
in_offsetThe offset into the control points for this NURBS curve at which to start replacing points. This value must be such that in_offset<control_point_count for replacement to succeed.
in_pointsThe 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.
Returns
A reference to this NURBSCurveKey.

◆ EditWeightsByReplacement()

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

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

Parameters
in_offsetThe offset into the control point weights for this NURBS curve at which to start replacing weights. This value must be such that in_offset<control_point_count for replacement to succeed.
in_weightsThe 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.
Returns
A reference to this NURBSCurveKey.

◆ GetPointCount()

ulong HPS.NURBSCurveKey.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.NURBSCurveKey.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.GeometryKey.

◆ Set()

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

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

Parameters
in_kitThe kit from which to get the settings to replace on this NURBSCurveKey.

◆ SetParameters()

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

Sets the normalized start and end parameters for this NURBSCurveKey.

Parameters
in_startThe start parameter. This value should be in the range [0,1] and should be defined such that in_start<=in_end.
in_endThe end parameter. This value should be in the range [0,1] and should be defined such that in_start<=in_end.
Returns
A reference to this NURBSCurveKey.

◆ Show()

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

Copy the contents of this NURBSCurveKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this NURBSCurveKey.

◆ ShowDegree()

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

Shows the degree of this NURBSCurveKey.

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

◆ ShowKnots()

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

Shows the knots for this NURBSCurveKey.

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

◆ ShowParameters()

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

Shows the normalized start and end parameters for this NURBSCurveKey.

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

◆ ShowPoints()

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

Shows the control points for this NURBSCurveKey.

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

◆ ShowPointsByList()

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

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

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

◆ ShowPointsByRange()

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

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

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

◆ ShowWeights()

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

Shows the control point weights for this NURBSCurveKey.

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

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