The NURBSSurfaceKey class is a smart pointer to a database object. It is a handle to a NURBS surface inserted via SegmentKey.InsertNURBSSurface. More...

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

Public Member Functions

void Consume (HPS.NURBSSurfaceKit in_kit)
 Completely replaces all settings on this NURBSSurfaceKey with those set on the specified kit and resets the kit. More...
 
override void Dispose ()
 
HPS.NURBSSurfaceKey EditPointsByReplacement (ulong in_offset, HPS.Point[] in_points)
 Replaces control points for this NURBSSurfaceKey. More...
 
HPS.NURBSSurfaceKey EditUKnotsByReplacement (ulong in_offset, float[] in_knots)
 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. More...
 
HPS.NURBSSurfaceKey EditVKnotsByReplacement (ulong in_offset, float[] in_knots)
 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. More...
 
HPS.NURBSSurfaceKey EditWeightsByReplacement (ulong in_offset, float[] in_weights)
 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. More...
 
ulong GetPointCount ()
 Retrieves the number of points in this NURBS surface. More...
 
 NURBSSurfaceKey ()
 The default constructor creates an uninitialized NURBSSurfaceKey object. The Type() function will return Type.None. More...
 
 NURBSSurfaceKey (HPS.Key in_that)
 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. More...
 
 NURBSSurfaceKey (HPS.NURBSSurfaceKey in_that)
 The copy constructor creates a NURBSSurfaceKey object that shares the underlying smart-pointer of the source NURBSSurfaceKey. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Set (HPS.NURBSSurfaceKit in_kit)
 Replace those settings on this NURBSSurfaceKey with those set on the specified kit. More...
 
HPS.NURBSSurfaceKey SetTrim (HPS.TrimKit in_trim)
 Sets the specified trim on this NURBSSurfaceKey. These will replace any existing trims. More...
 
HPS.NURBSSurfaceKey SetTrims (HPS.TrimKit[] in_trims)
 Sets the specified trims on this NURBSSurfaceKey. These will replace any existing trims. More...
 
void Show (out HPS.NURBSSurfaceKit out_kit)
 Copy the contents of this NURBSSurfaceKey into the specified kit. More...
 
bool ShowPoints (out HPS.Point[] out_points)
 Shows the control points for this NURBSSurfaceKey. More...
 
bool ShowPointsByList (ulong[] in_indices, out HPS.Point[] out_points)
 Show a subset of the points for this NURBSSurfaceKey by list. More...
 
bool ShowPointsByRange (ulong in_start_index, ulong in_count, out HPS.Point[] out_points)
 Show a subset of the points for this NURBSSurfaceKey by range. More...
 
bool ShowTrims (out HPS.TrimKit[] out_trims)
 Shows the trims for this NURBSSurfaceKey. More...
 
bool ShowUCount (out ulong out_count)
 Shows the number of control points in the U direction for this NURBSSurfaceKey. More...
 
bool ShowUDegree (out ulong out_degree)
 Shows the degree of this NURBSSurfaceKey in the U direction. More...
 
bool ShowUKnots (out float[] out_knots)
 Shows the knot sequence in the U direction for this NURBSSurfaceKey. More...
 
bool ShowVCount (out ulong out_count)
 Shows the number of control points in the V direction for this NURBSSurfaceKey. More...
 
bool ShowVDegree (out ulong out_degree)
 Shows the degree of this NURBSSurfaceKey in the V direction. More...
 
bool ShowVKnots (out float[] out_knots)
 Shows the knot sequence in the V direction for this NURBSSurfaceKey. More...
 
bool ShowWeights (out float[] out_weights)
 Shows the control point weights for this NURBSSurfaceKey. More...
 
HPS.NURBSSurfaceKey UnsetTrims ()
 Removes the trims from this NURBSSurfaceKey. More...
 
- Public Member Functions inherited from HPS.GeometryKey
 GeometryKey ()
 The default constructor creates an uninitialized GeometryKey object. The Type() function will return Type.None. More...
 
 GeometryKey (HPS.Key in_that)
 This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really a type of geometry key. Otherwise the copy will fail and the resulting GeometryKey will be invalid. More...
 
 GeometryKey (HPS.GeometryKey in_that)
 The copy constructor creates a GeometryKey object that shares the underlying smart-pointer of the source GeometryKey. More...
 
HPS.GeometryKey SetPriority (int in_priority)
 Assigns a drawing priority value to the geometry. It affects the order in which the geometry is visited if and only if the rendering algorithm is set to Priority. The geometry has a default drawing priority assigned, based on the order of insertion. More...
 
HPS.GeometryKey SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 Sets user data on this key. More...
 
HPS.GeometryKey SetUserData (IntPtr in_index, byte[] in_data)
 Sets user data on this key. More...
 
HPS.GeometryKey SetUserData (IntPtr[] in_indices, byte[][] in_data)
 Sets user data on this key. More...
 
bool ShowBounding (out HPS.BoundingKit out_kit)
 Shows the bounding of this geometry. More...
 
bool ShowPriority (out int out_priority)
 Shows the drawing priority. More...
 
ulong ShowReferrers (out HPS.SegmentKey[] out_segments)
 Shows the all the segments which contain references to this key. Note that while a segment may only appear once in the returned array, that segment could have multiple references to this key. More...
 
ulong ShowReferrers (out HPS.ReferenceKey[] out_references)
 Shows the all the references to this key. More...
 
bool ShowUserData (IntPtr in_index, out byte[] out_data)
 Shows the user data at a given index for this key. More...
 
bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
 Shows all user data for this key. More...
 
ulong ShowUserDataCount ()
 Get the number of user data indices set on this key. More...
 
bool ShowUserDataIndices (out IntPtr[] out_indices)
 Shows the indices of all user data set on this key. More...
 
HPS.GeometryKey UnsetAllUserData ()
 Removes all user data from this key. More...
 
HPS.GeometryKey UnsetPriority ()
 Removes the drawing priority setting. More...
 
HPS.GeometryKey UnsetUserData (IntPtr in_index)
 Removes the user data at the given index from this key. More...
 
HPS.GeometryKey UnsetUserData (IntPtr[] in_indices)
 Removes the user data at the given indices from this key. More...
 
- Public Member Functions inherited from HPS.Key
virtual void Assign (HPS.Key in_that)
 Share the underlying smart-pointer of the Key source. More...
 
HPS.Key CopyTo (HPS.SegmentKey in_destination)
 Copies the database object referred to by this key into a segment pointed to by in_destination. More...
 
void Delete ()
 Removes the database object referred to by this key. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Key in_that)
 Determines whether the database objects pointed to by this key and in_that are the same. Empty keys (when key.Empty() returns true) are never equal to any key, even when the key is compared against itself (they act analogously to NaN comparisons in this case.) More...
 
ulong GetHash ()
 Returns a hash code for the key. More...
 
override int GetHashCode ()
 
bool HasOwner ()
 
Returns
Indicates whether this key has an owner or not.

 
 Key ()
 An uninitialized key refers to no database object and Type() will return Type.None. More...
 
 Key (HPS.Key in_that)
 Shares a reference to a database object referred to by in_that. More...
 
 Key (HPS.Control in_control)
 Initializes a key tied to the Control in_control. More...
 
void MoveTo (HPS.SegmentKey in_new_owner)
 Moves the database object referred to by this key into a new containing segment pointed to by in_new_owner. More...
 
HPS.SegmentKey Owner ()
 
Returns
The segment containing this key.

 
HPS.SegmentKey Up ()
 
Returns
The segment containing this key.

 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 

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

HPS.NURBSSurfaceKey.NURBSSurfaceKey ( )
inline

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

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.

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

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.
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.
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.
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.
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.
ulong HPS.NURBSSurfaceKey.GetPointCount ( )
inline

Retrieves the number of points in this NURBS surface.

Returns
The number of points in this NURBS surface.
override HPS.Type HPS.NURBSSurfaceKey.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.GeometryKey.

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