< Home

< Table of Contents

REFERENCE MANUAL

HPS.NURBSCurveKey Class Reference

The NURBSCurveKey class is a smart pointer to a database object. More...

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

Public Member Functions

void Consume (HPS.NURBSCurveKit in_kit)
 Completely replaces all settings on this NURBSCurveKey with those set on the specified kit and resets the kit. More...
 
override void Dispose ()
 
HPS.NURBSCurveKey EditKnotsByReplacement (ulong in_offset, float[] in_knots)
 Replaces knots for this NURBSCurveKey. More...
 
HPS.NURBSCurveKey EditPointsByReplacement (ulong in_offset, HPS.Point[] in_points)
 Replaces control points for this NURBSCurveKey. More...
 
HPS.NURBSCurveKey EditWeightsByReplacement (ulong in_offset, float[] in_weights)
 Replaces control point weights for this NURBSCurveKey. More...
 
ulong GetPointCount ()
 Retrieves the number of points in this NURBS curve. More...
 
 NURBSCurveKey ()
 The default constructor creates an uninitialized NURBSCurveKey object. More...
 
 NURBSCurveKey (HPS.Key in_that)
 This constructor creates a NURBSCurveKey object that shares the underlying smart-pointer of the source Key. More...
 
 NURBSCurveKey (HPS.NURBSCurveKey in_that)
 This constructor creates a NURBSCurveKey object that shares the underlying smart-pointer of the source Key. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.NURBSCurveKit in_kit)
 Replace those settings on this NURBSCurveKey with those set on the specified kit. More...
 
HPS.NURBSCurveKey SetParameters (float in_start, float in_end)
 Sets the normalized start and end parameters for this NURBSCurveKey. More...
 
void Show (out HPS.NURBSCurveKit out_kit)
 Copy the contents of this NURBSCurveKey into the specified kit. More...
 
bool ShowDegree (out ulong out_degree)
 Shows the degree of this NURBSCurveKey. More...
 
bool ShowKnots (out float[] out_knots)
 Shows the knots for this NURBSCurveKey. More...
 
bool ShowParameters (out float out_start, out float out_end)
 Shows the normalized start and end parameters for this NURBSCurveKey. More...
 
bool ShowPoints (out HPS.Point[] out_points)
 Shows the control points for this NURBSCurveKey. More...
 
bool ShowWeights (out float[] out_weights)
 Shows the control point weights for this NURBSCurveKey. More...
 
- Public Member Functions inherited from HPS.GeometryKey
 GeometryKey ()
 The default constructor creates an uninitialized GeometryKey object. More...
 
 GeometryKey (HPS.Key in_that)
 This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. More...
 
 GeometryKey (HPS.GeometryKey in_that)
 This constructor creates a GeometryKey object that shares the underlying smart-pointer of the source Key. More...
 
HPS.GeometryKey SetPriority (int in_priority)
 Assigns a drawing priority value to the geometry. 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 ShowBoundings (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. 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 smart-pointer. 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. 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. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
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. 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
 
HandleRef scptr
 

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

HPS.NURBSCurveKey.NURBSCurveKey ( )

The default constructor creates an uninitialized NURBSCurveKey object.

The Type() function will return Type::None.

HPS.NURBSCurveKey.NURBSCurveKey ( HPS.Key  in_that)

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.

HPS.NURBSCurveKey.NURBSCurveKey ( HPS.NURBSCurveKey  in_that)

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.

Member Function Documentation

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

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 <ref refid="class_h_p_s_1_1_n_u_r_b_s_curve_key" kindref="compound">NURBSCurveKey</ref>.
HPS.NURBSCurveKey HPS.NURBSCurveKey.EditKnotsByReplacement ( ulong  in_offset,
float[]  in_knots 
)

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_countThe number of knots to replace for this NURBS curve. This must be such that in_offset+in_count<=control_point_count+degree+1 for the replacement to succeed.
in_knotsThe knots to use to replace those at the specified offset.
Returns
A reference to this NURBSCurveKey.
HPS.NURBSCurveKey HPS.NURBSCurveKey.EditPointsByReplacement ( ulong  in_offset,
HPS.Point[]  in_points 
)

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_countThe number of control points to replace for the NURBS curve. This must be such that such that in_offset+in_count<=control_point_count for the replacement to succeed.
in_pointsThe points to use to replace those in the control point list at the specified offset.
Returns
A reference to this NURBSCurveKey.
HPS.NURBSCurveKey HPS.NURBSCurveKey.EditWeightsByReplacement ( ulong  in_offset,
float[]  in_weights 
)

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_countThe number of control point weights to replace for the NURBS curve. This must be such that such that in_offset+in_count<=control_point_count for the replacement to succeed.
in_weightsThe weights to use to replace those in the control point weight list at the specified offset.
Returns
A reference to this NURBSCurveKey.
ulong HPS.NURBSCurveKey.GetPointCount ( )

Retrieves the number of points in this NURBS curve.

Returns
The number of points in this NURBS curve.
override HPS.Type HPS.NURBSCurveKey.ObjectType ( )
virtual

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.NURBSCurveKey.Set ( HPS.NURBSCurveKit  in_kit)

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 <ref refid="class_h_p_s_1_1_n_u_r_b_s_curve_key" kindref="compound">NURBSCurveKey</ref>.
HPS.NURBSCurveKey HPS.NURBSCurveKey.SetParameters ( float  in_start,
float  in_end 
)

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.
void HPS.NURBSCurveKey.Show ( out HPS.NURBSCurveKit  out_kit)

Copy the contents of this NURBSCurveKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this <ref refid="class_h_p_s_1_1_n_u_r_b_s_curve_key" kindref="compound">NURBSCurveKey</ref>.
bool HPS.NURBSCurveKey.ShowDegree ( out ulong  out_degree)

Shows the degree of this NURBSCurveKey.

Parameters
out_degreeThe degree of this <ref refid="class_h_p_s_1_1_n_u_r_b_s_curve_key" kindref="compound">NURBSCurveKey</ref>.
Returns
true if a degree was set, false otherwise.
bool HPS.NURBSCurveKey.ShowKnots ( out float[]  out_knots)

Shows the knots for this NURBSCurveKey.

Parameters
out_knotsThe knots for this <ref refid="class_h_p_s_1_1_n_u_r_b_s_curve_key" kindref="compound">NURBSCurveKey</ref>.
Returns
true if knots were set, false otherwise.
bool HPS.NURBSCurveKey.ShowParameters ( out float  out_start,
out float  out_end 
)

Shows the normalized start and end parameters for this NURBSCurveKey.

Parameters
out_startThe noramlized start parameter for this <ref refid="class_h_p_s_1_1_n_u_r_b_s_curve_key" kindref="compound">NURBSCurveKey</ref>.
out_endThe noramlized end parameter for this <ref refid="class_h_p_s_1_1_n_u_r_b_s_curve_key" kindref="compound">NURBSCurveKey</ref>.
Returns
true if start and end parameters were set, false otherwise.
bool HPS.NURBSCurveKey.ShowPoints ( out HPS.Point[]  out_points)

Shows the control points for this NURBSCurveKey.

Parameters
out_pointsThe control points for this <ref refid="class_h_p_s_1_1_n_u_r_b_s_curve_key" kindref="compound">NURBSCurveKey</ref>.
Returns
true if control points were set, false otherwise.
bool HPS.NURBSCurveKey.ShowWeights ( out float[]  out_weights)

Shows the control point weights for this NURBSCurveKey.

Parameters
out_weightsThe control point weights for this <ref refid="class_h_p_s_1_1_n_u_r_b_s_curve_key" kindref="compound">NURBSCurveKey</ref>.
Returns
true if control point weights were set, false otherwise.

The documentation for this class was generated from the following file: