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

Public Member Functions

void Consume (HPS.NURBSSurfaceKit in_kit)
 
override void Dispose ()
 
HPS.NURBSSurfaceKey EditPointsByReplacement (ulong in_offset, HPS.Point[] in_points)
 
HPS.NURBSSurfaceKey EditUKnotsByReplacement (ulong in_offset, float[] in_knots)
 
HPS.NURBSSurfaceKey EditVKnotsByReplacement (ulong in_offset, float[] in_knots)
 
HPS.NURBSSurfaceKey EditWeightsByReplacement (ulong in_offset, float[] in_weights)
 
ulong GetPointCount ()
 
 NURBSSurfaceKey ()
 
 NURBSSurfaceKey (HPS.Key in_that)
 
 NURBSSurfaceKey (HPS.NURBSSurfaceKey in_that)
 
override HPS.Type ObjectType ()
 
void Set (HPS.NURBSSurfaceKit in_kit)
 
HPS.NURBSSurfaceKey SetTrim (HPS.TrimKit in_trim)
 
HPS.NURBSSurfaceKey SetTrims (HPS.TrimKit[] in_trims)
 
void Show (out HPS.NURBSSurfaceKit out_kit)
 
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 ShowTrims (out HPS.TrimKit[] out_trims)
 
bool ShowUCount (out ulong out_count)
 
bool ShowUDegree (out ulong out_degree)
 
bool ShowUKnots (out float[] out_knots)
 
bool ShowVCount (out ulong out_count)
 
bool ShowVDegree (out ulong out_degree)
 
bool ShowVKnots (out float[] out_knots)
 
bool ShowWeights (out float[] out_weights)
 
HPS.NURBSSurfaceKey UnsetTrims ()
 
- 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 NURBSSurfaceKey class is a smart pointer to a database object. It is a handle to a NURBS surface inserted via SegmentKey.InsertNURBSSurface.

Constructor & Destructor Documentation

◆ NURBSSurfaceKey() [1/3]

HPS.NURBSSurfaceKey.NURBSSurfaceKey ( )
inline

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

◆ NURBSSurfaceKey() [2/3]

HPS.NURBSSurfaceKey.NURBSSurfaceKey ( HPS.Key  in_that)
inline

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() [3/3]

HPS.NURBSSurfaceKey.NURBSSurfaceKey ( HPS.NURBSSurfaceKey  in_that)
inline

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

Parameters
in_thatThe source NURBSSurfaceKey to copy.

Member Function Documentation

◆ Consume()

void HPS.NURBSSurfaceKey.Consume ( HPS.NURBSSurfaceKit  in_kit)
inline

Completely replaces all settings on this NURBSSurfaceKey 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 NURBSSurfaceKey.

◆ EditPointsByReplacement()

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

Replaces control points for this NURBSSurfaceKey.

Parameters
in_offsetThe 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.
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 NURBSSurfaceKey.

◆ EditUKnotsByReplacement()

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

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.

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

◆ EditVKnotsByReplacement()

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

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.

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

◆ EditWeightsByReplacement()

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

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.

Parameters
in_offsetThe 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.
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 NURBSSurfaceKey.

◆ GetPointCount()

ulong HPS.NURBSSurfaceKey.GetPointCount ( )
inline

Retrieves the number of points in this NURBS surface.

Returns
The number of points in this NURBS surface.

◆ ObjectType()

override HPS.Type HPS.NURBSSurfaceKey.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.NURBSSurfaceKey.Set ( HPS.NURBSSurfaceKit  in_kit)
inline

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

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

◆ SetTrim()

HPS.NURBSSurfaceKey HPS.NURBSSurfaceKey.SetTrim ( HPS.TrimKit  in_trim)
inline

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

Parameters
in_trimThe trim to apply to this NURBSSurfaceKey.
Returns
A reference to this NURBSSurfaceKey.

◆ SetTrims()

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

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

Parameters
in_trimsThe array of trims to apply to this NURBSSurfaceKey.
Returns
A reference to this NURBSSurfaceKey.

◆ Show()

void HPS.NURBSSurfaceKey.Show ( out HPS.NURBSSurfaceKit  out_kit)
inline

Copy the contents of this NURBSSurfaceKey into the specified kit.

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

◆ ShowPoints()

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

Shows the control points for this NURBSSurfaceKey.

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

◆ ShowPointsByList()

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

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

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

◆ ShowPointsByRange()

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

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

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

◆ ShowTrims()

bool HPS.NURBSSurfaceKey.ShowTrims ( out HPS.TrimKit []  out_trims)
inline

Shows the trims for this NURBSSurfaceKey.

Parameters
out_trimsThe trims for this NURBSSurfaceKey.
Returns
true if trims were set, false otherwise.

◆ ShowUCount()

bool HPS.NURBSSurfaceKey.ShowUCount ( out ulong  out_count)
inline

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

Parameters
out_countThe number of control points in the U direction for this NURBSSurfaceKey.
Returns
true if such a count was set, false otherwise.

◆ ShowUDegree()

bool HPS.NURBSSurfaceKey.ShowUDegree ( out ulong  out_degree)
inline

Shows the degree of this NURBSSurfaceKey in the U direction.

Parameters
out_degreeThe degree of this NURBSSurfaceKey in the U direction.
Returns
true if such a degree was set, false otherwise.

◆ ShowUKnots()

bool HPS.NURBSSurfaceKey.ShowUKnots ( out float []  out_knots)
inline

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

Parameters
out_knotsThe knot sequence in the U direction for this NURBSSurfaceKey.
Returns
true if these knots were set, false otherwise.

◆ ShowVCount()

bool HPS.NURBSSurfaceKey.ShowVCount ( out ulong  out_count)
inline

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

Parameters
out_countThe number of control points in the V direction for this NURBSSurfaceKey.
Returns
true if such a count was set, false otherwise.

◆ ShowVDegree()

bool HPS.NURBSSurfaceKey.ShowVDegree ( out ulong  out_degree)
inline

Shows the degree of this NURBSSurfaceKey in the V direction.

Parameters
out_degreeThe degree of this NURBSSurfaceKey in the V direction.
Returns
true if such a degree was set, false otherwise.

◆ ShowVKnots()

bool HPS.NURBSSurfaceKey.ShowVKnots ( out float []  out_knots)
inline

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

Parameters
out_knotsThe knot sequence in the V direction for this NURBSSurfaceKey.
Returns
true if these knots were set, false otherwise.

◆ ShowWeights()

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

Shows the control point weights for this NURBSSurfaceKey.

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

◆ UnsetTrims()

HPS.NURBSSurfaceKey HPS.NURBSSurfaceKey.UnsetTrims ( )
inline

Removes the trims from this NURBSSurfaceKey.

Returns
A reference to this NURBSSurfaceKey.

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