< Home

< Table of Contents

REFERENCE MANUAL

HPS.NURBSSurfaceAttributeKit Class Reference

The NURBSSurfaceAttributeKit class is a user space object that contains settings related to NURBS surfaces. More...

Inheritance diagram for HPS.NURBSSurfaceAttributeKit:
HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this object has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.NURBSSurfaceAttributeKit in_kit)
 Check if the source NURBSSurfaceAttributeKit is equivalent to this object. More...
 
override int GetHashCode ()
 
 NURBSSurfaceAttributeKit ()
 Initializes an empty kit. More...
 
 NURBSSurfaceAttributeKit (HPS.NURBSSurfaceAttributeKit in_kit)
 The copy constructor creates a new NURBSSurfaceAttributeKit object that contains the same settings as the source object. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.NURBSSurfaceAttributeKit in_kit)
 Copies the source NURBSSurfaceAttributeKit into this object. More...
 
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. More...
 
HPS.NURBSSurfaceAttributeKit SetMaximumAngle (float in_degrees)
 Sets the largest angle allowed between the surface tangents evaluated at any two corners of a given facet. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
void Show (out HPS.NURBSSurfaceAttributeKit out_kit)
 Copies this object into the given NURBSSurfaceAttributeKit. More...
 
bool ShowBudget (out ulong out_budget)
 Shows the NURBS surface tessellation budget. More...
 
bool ShowMaximumAngle (out float out_degrees)
 Shows the largest angle allowed between the surface tangents. More...
 
bool ShowMaximumDeviation (out float out_deviation)
 Shows the upper bound of the difference between the NURBS surface and its parametric definition. More...
 
bool ShowMaximumTrimDeviation (out float out_deviation)
 Shows the upper bound of trim curve vertices from the parametric definition of the trimming curve. More...
 
bool ShowMaximumWidth (out float out_width)
 Shows the setting for the largest allowable length of any facet's edge. More...
 
bool ShowTrimBudget (out ulong out_budget)
 Shows the upper bound of vertices to be used in trim curve tessellation. More...
 
HPS.NURBSSurfaceAttributeKit UnsetBudget ()
 Removes the NURBS surface tessellation budget. More...
 
HPS.NURBSSurfaceAttributeKit UnsetEverything ()
 Removes all settings from this object. More...
 
HPS.NURBSSurfaceAttributeKit UnsetMaximumAngle ()
 Removes the largest angle allowed between the surface tangents. More...
 
HPS.NURBSSurfaceAttributeKit UnsetMaximumDeviation ()
 Removes the upper bound of the difference between the NURBS surface and its parametric definition. More...
 
HPS.NURBSSurfaceAttributeKit UnsetMaximumTrimDeviation ()
 Removes the upper bound of trim curve vertices from the parametric definition of the trimming curve. More...
 
HPS.NURBSSurfaceAttributeKit UnsetMaximumWidth ()
 Removes the setting for the largest allowable length of any facet's edge. More...
 
HPS.NURBSSurfaceAttributeKit UnsetTrimBudget ()
 Removes the upper bound of vertices to be used in trim curve tessellation. More...
 
- Public Member Functions inherited from HPS.Object
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...
 

Static Public Member Functions

static HPS.NURBSSurfaceAttributeKit GetDefault ()
 Creates a NURBSSurfaceAttributeKit which contains the default settings. More...
 
static bool operator!= (HPS.NURBSSurfaceAttributeKit a, HPS.NURBSSurfaceAttributeKit b)
 
static bool operator== (HPS.NURBSSurfaceAttributeKit a, HPS.NURBSSurfaceAttributeKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The NURBSSurfaceAttributeKit class is a user space object that contains settings related to NURBS surfaces.

Calling NURBSSurfaceAttributeKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

HPS.NURBSSurfaceAttributeKit.NURBSSurfaceAttributeKit ( )

Initializes an empty kit.

HPS.NURBSSurfaceAttributeKit.NURBSSurfaceAttributeKit ( HPS.NURBSSurfaceAttributeKit  in_kit)

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

Parameters
in_kitThe source object to copy.

Member Function Documentation

override bool HPS.NURBSSurfaceAttributeKit.Empty ( )
virtual

Indicates whether this object has any values set on it.

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

Reimplemented from HPS.Object.

bool HPS.NURBSSurfaceAttributeKit.Equals ( HPS.NURBSSurfaceAttributeKit  in_kit)

Check if the source NURBSSurfaceAttributeKit is equivalent to this object.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_n_u_r_b_s_surface_attribute_kit" kindref="compound">NURBSSurfaceAttributeKit</ref> to compare to this object.
Returns
true if the objects are equivalent, false otherwise.
static HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.GetDefault ( )
static

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.

Returns
A NURBSSurfaceAttributeKit with the default settings.
override HPS.Type HPS.NURBSSurfaceAttributeKit.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.Object.

void HPS.NURBSSurfaceAttributeKit.Set ( HPS.NURBSSurfaceAttributeKit  in_kit)

Copies the source NURBSSurfaceAttributeKit into this object.

Parameters
in_kitThe source object to copy.
HPS.NURBSSurfaceAttributeKit 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.

Parameters
in_budgetThe maximum number of vertices to be used in NURBS surface tessellation.
Returns
A reference to this object.
HPS.NURBSSurfaceAttributeKit 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.

Parameters
in_degreesThe maximum angle allowed between the surface tangents, in degrees.
Returns
A reference to this object.
HPS.NURBSSurfaceAttributeKit 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.

Parameters
in_deviationThe maximum distance, in object space, of the tessellation to the parametric definition of the surface.
Returns
A reference to this object.
HPS.NURBSSurfaceAttributeKit 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.

Parameters
in_deviationThe maximum distance, in object space, of the tessellation to the parametric definition of the trimming curve.
Returns
A reference to this object.
HPS.NURBSSurfaceAttributeKit 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.

Parameters
in_widthThe largest allowable length of any facet's edge. Valid range is [0, sqrt(2)].
Returns
A reference to this object.
HPS.NURBSSurfaceAttributeKit 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.

Parameters
in_budgetThe maximum number of vertices to be used in trim curve tessellation.
Returns
A reference to this object.
void HPS.NURBSSurfaceAttributeKit.Show ( out HPS.NURBSSurfaceAttributeKit  out_kit)

Copies this object into the given NURBSSurfaceAttributeKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_n_u_r_b_s_surface_attribute_kit" kindref="compound">NURBSSurfaceAttributeKit</ref> to populate with the contents of this object.
bool HPS.NURBSSurfaceAttributeKit.ShowBudget ( out ulong  out_budget)

Shows the NURBS surface tessellation budget.

Parameters
out_budgetThe maximum number of vertices to be used in NURBS surface tessellation.
Returns
true if the budget is valid, false otherwise.
bool HPS.NURBSSurfaceAttributeKit.ShowMaximumAngle ( out float  out_degrees)

Shows the largest angle allowed between the surface tangents.

Parameters
out_degreesThe maximum angle allowed between the surface tangents, in degrees.
Returns
true if the maximum angle is valid, false otherwise.
bool HPS.NURBSSurfaceAttributeKit.ShowMaximumDeviation ( out float  out_deviation)

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

Parameters
out_deviationThe maximum distance, in object space, of the tessellation to the parametric definition of the surface.
Returns
true if the maximum deviation is valid, false otherwise.
bool HPS.NURBSSurfaceAttributeKit.ShowMaximumTrimDeviation ( out float  out_deviation)

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

Parameters
out_deviationThe maximum distance, in object space, of the tessellation to the parametric definition of the trimming curve.
Returns
true if the setting is valid, false otherwise.
bool HPS.NURBSSurfaceAttributeKit.ShowMaximumWidth ( out float  out_width)

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

Parameters
out_widthThe largest allowable length of any facet's edge..
Returns
true if the maximum width is valid, false otherwise.
bool HPS.NURBSSurfaceAttributeKit.ShowTrimBudget ( out ulong  out_budget)

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

Parameters
out_budgetThe maximum number of vertices to be used in trim curve tessellation.
Returns
true if the budget is valid, false otherwise.
HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.UnsetBudget ( )

Removes the NURBS surface tessellation budget.

Returns
A reference to this object.
HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.
HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.UnsetMaximumAngle ( )

Removes the largest angle allowed between the surface tangents.

Returns
A reference to this object.
HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.UnsetMaximumDeviation ( )

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

Returns
A reference to this object.
HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.UnsetMaximumTrimDeviation ( )

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

Returns
A reference to this object.
HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.UnsetMaximumWidth ( )

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

Returns
A reference to this object.
HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.UnsetTrimBudget ( )

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

Returns
A reference to this object.

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