NURBSSurfaceAttributeKit

class HPS.NURBSSurfaceAttributeKit : HPS.Kit

The HPS.NURBSSurfaceAttributeKit class is a user space object that contains settings related to NURBS surfaces. Calling HPS.NURBSSurfaceAttributeKit.GetDefault() will return a kit with values found in this table.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this object has any values set on it.

Return:true if no values are set on this object, false otherwise.

bool Equals (HPS.NURBSSurfaceAttributeKit in_kit)

Check if the source NURBSSurfaceAttributeKit is equivalent to this object.

Param in_kit:The source NURBSSurfaceAttributeKit to compare to this object. Return:true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

NURBSSurfaceAttributeKit ()

Initializes an empty kit.

NURBSSurfaceAttributeKit (HPS.NURBSSurfaceAttributeKit in_kit)

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

Param in_kit:The source object to copy.

override HPS.Type ObjectType ()

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

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

void Set (HPS.NURBSSurfaceAttributeKit in_kit)

Copies the source NURBSSurfaceAttributeKit into this object.

Param in_kit:The source object to copy.

HPS.NURBSSurfaceAttributeKit SetBudget (ulong in_budget)

Sets an upper bound on the number of vertices that will be allowed in the tessellation of NURBS surfaces.

Param in_budget:  The maximum number of vertices to be used in NURBS surface tessellation. Return:A reference to this object.

HPS.NURBSSurfaceAttributeKit SetMaximumAngle (float in_degrees)

Sets the largest angle allowed between the surface tangents evaluated at any two corners of a given facet. Expressed in degrees.

Param in_degrees:  The maximum angle allowed between the surface tangents, in degrees. Return:A reference to this object.

HPS.NURBSSurfaceAttributeKit SetMaximumDeviation (float in_deviation)

Sets an upper bound for the distance, in object space, of the tessellation to the parametric definition of the surface. Note that since this setting is in object space, it should be set differently depending on the scale of the NURBS control points.

Param in_deviation:  The maximum distance, in object space, of the tessellation to the parametric definition of the surface. Return:A reference to this object.

HPS.NURBSSurfaceAttributeKit SetMaximumTrimDeviation (float in_deviation)

Sets an upper bound for the distance, in the NURBS surface’s normalized [0..1] parametric space, of trim curve vertices from the parametric definition of the trimming curve.

Param in_deviation:  The maximum distance, in object space, of the tessellation to the parametric definition of the trimming curve. Return:A reference to this object.

HPS.NURBSSurfaceAttributeKit SetMaximumWidth (float in_width)

The largest allowable length, in the NURBS surface’s normalized [0..1] parametric space, of any facet’s edge.

Param in_width:The largest allowable length of any facet’s edge. Valid range is [0, sqrt(2)]. Return:A reference to this object.

HPS.NURBSSurfaceAttributeKit SetTrimBudget (ulong in_budget)

Sets an upper bound on the number of vertices that will be allowed in the tessellation of a trim curve.

Param in_budget:  The maximum number of vertices to be used in trim curve tessellation. Return:A reference to this object.

void Show (out HPS.NURBSSurfaceAttributeKit out_kit)

Copies this object into the given NURBSSurfaceAttributeKit.

Param out_kit:The NURBSSurfaceAttributeKit to populate with the contents of this object.

bool ShowBudget (out ulong out_budget)

Shows the NURBS surface tessellation budget.

Param out_budget:  The maximum number of vertices to be used in NURBS surface tessellation. Return:true if the budget is valid, false otherwise.

bool ShowMaximumAngle (out float out_degrees)

Shows the largest angle allowed between the surface tangents.

Param out_degrees:  The maximum angle allowed between the surface tangents, in degrees. Return:true if the maximum angle is valid, false otherwise.

bool ShowMaximumDeviation (out float out_deviation)

Shows the upper bound of the difference between the NURBS surface and its parametric definition.

Param out_deviation:  The maximum distance, in object space, of the tessellation to the parametric definition of the surface. Return:true if the maximum deviation is valid, false otherwise.

bool ShowMaximumTrimDeviation (out float out_deviation)

Shows the upper bound of trim curve vertices from the parametric definition of the trimming curve.

Param out_deviation:  The maximum distance, in object space, of the tessellation to the parametric definition of the trimming curve. Return:true if the setting is valid, false otherwise.

bool ShowMaximumWidth (out float out_width)

Shows the setting for the largest allowable length of any facet’s edge.

Param out_width:  The largest allowable length of any facet’s edge.. Return:true if the maximum width is valid, false otherwise.

bool ShowTrimBudget (out ulong out_budget)

Shows the upper bound of vertices to be used in trim curve tessellation.

Param out_budget:  The maximum number of vertices to be used in trim curve tessellation. Return:true if the budget is valid, false otherwise.

HPS.NURBSSurfaceAttributeKit UnsetBudget ()

Removes the NURBS surface tessellation budget.

Return:A reference to this object.

HPS.NURBSSurfaceAttributeKit UnsetEverything ()

Removes all settings from this object.

Return:A reference to this object.

HPS.NURBSSurfaceAttributeKit UnsetMaximumAngle ()

Removes the largest angle allowed between the surface tangents.

Return:A reference to this object.

HPS.NURBSSurfaceAttributeKit UnsetMaximumDeviation ()

Removes the upper bound of the difference between the NURBS surface and its parametric definition.

Return:A reference to this object.

HPS.NURBSSurfaceAttributeKit UnsetMaximumTrimDeviation ()

Removes the upper bound of trim curve vertices from the parametric definition of the trimming curve.

Return:A reference to this object.

HPS.NURBSSurfaceAttributeKit UnsetMaximumWidth ()

Removes the setting for the largest allowable length of any facet’s edge.

Return:A reference to this object.

HPS.NURBSSurfaceAttributeKit UnsetTrimBudget ()

Removes the upper bound of vertices to be used in trim curve tessellation.

Return:A reference to this object.

Public Static Functions

HPS.NURBSSurfaceAttributeKit GetDefault ()

Creates a NURBSSurfaceAttributeKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Return:A NURBSSurfaceAttributeKit with the default settings.

bool operator!= (HPS.NURBSSurfaceAttributeKit a, HPS.NURBSSurfaceAttributeKit b)

bool operator== (HPS.NURBSSurfaceAttributeKit a, HPS.NURBSSurfaceAttributeKit b)