Inheritance diagram for HPS.NURBSSurfaceAttributeKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.NURBSSurfaceAttributeKit in_kit)
 
override int GetHashCode ()
 
 NURBSSurfaceAttributeKit ()
 
 NURBSSurfaceAttributeKit (HPS.NURBSSurfaceAttributeKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.NURBSSurfaceAttributeKit in_kit)
 
HPS.NURBSSurfaceAttributeKit SetBudget (ulong in_budget)
 
HPS.NURBSSurfaceAttributeKit SetMaximumAngle (float in_degrees)
 
HPS.NURBSSurfaceAttributeKit SetMaximumDeviation (float in_deviation)
 
HPS.NURBSSurfaceAttributeKit SetMaximumTrimDeviation (float in_deviation)
 
HPS.NURBSSurfaceAttributeKit SetMaximumWidth (float in_width)
 
HPS.NURBSSurfaceAttributeKit SetTrimBudget (ulong in_budget)
 
void Show (out HPS.NURBSSurfaceAttributeKit out_kit)
 
bool ShowBudget (out ulong out_budget)
 
bool ShowMaximumAngle (out float out_degrees)
 
bool ShowMaximumDeviation (out float out_deviation)
 
bool ShowMaximumTrimDeviation (out float out_deviation)
 
bool ShowMaximumWidth (out float out_width)
 
bool ShowTrimBudget (out ulong out_budget)
 
HPS.NURBSSurfaceAttributeKit UnsetBudget ()
 
HPS.NURBSSurfaceAttributeKit UnsetEverything ()
 
HPS.NURBSSurfaceAttributeKit UnsetMaximumAngle ()
 
HPS.NURBSSurfaceAttributeKit UnsetMaximumDeviation ()
 
HPS.NURBSSurfaceAttributeKit UnsetMaximumTrimDeviation ()
 
HPS.NURBSSurfaceAttributeKit UnsetMaximumWidth ()
 
HPS.NURBSSurfaceAttributeKit UnsetTrimBudget ()
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.NURBSSurfaceAttributeKit GetDefault ()
 
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
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ NURBSSurfaceAttributeKit() [1/2]

HPS.NURBSSurfaceAttributeKit.NURBSSurfaceAttributeKit ( )
inline

Initializes an empty kit.

◆ NURBSSurfaceAttributeKit() [2/2]

HPS.NURBSSurfaceAttributeKit.NURBSSurfaceAttributeKit ( HPS.NURBSSurfaceAttributeKit  in_kit)
inline

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

◆ Empty()

override bool HPS.NURBSSurfaceAttributeKit.Empty ( )
inlinevirtual

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.

◆ Equals()

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

Check if the source NURBSSurfaceAttributeKit is equivalent to this object.

Parameters
in_kitThe source NURBSSurfaceAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.GetDefault ( )
inlinestatic

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.

◆ ObjectType()

override HPS.Type HPS.NURBSSurfaceAttributeKit.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.Kit.

◆ Set()

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

Copies the source NURBSSurfaceAttributeKit into this object.

Parameters
in_kitThe source object to copy.

◆ SetBudget()

HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.SetBudget ( ulong  in_budget)
inline

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.

◆ SetMaximumAngle()

HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.SetMaximumAngle ( float  in_degrees)
inline

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.

◆ SetMaximumDeviation()

HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.SetMaximumDeviation ( float  in_deviation)
inline

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.

◆ SetMaximumTrimDeviation()

HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.SetMaximumTrimDeviation ( float  in_deviation)
inline

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.

◆ SetMaximumWidth()

HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.SetMaximumWidth ( float  in_width)
inline

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.

◆ SetTrimBudget()

HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.SetTrimBudget ( ulong  in_budget)
inline

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.

◆ Show()

void HPS.NURBSSurfaceAttributeKit.Show ( out HPS.NURBSSurfaceAttributeKit  out_kit)
inline

Copies this object into the given NURBSSurfaceAttributeKit.

Parameters
out_kitThe NURBSSurfaceAttributeKit to populate with the contents of this object.

◆ ShowBudget()

bool HPS.NURBSSurfaceAttributeKit.ShowBudget ( out ulong  out_budget)
inline

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.

◆ ShowMaximumAngle()

bool HPS.NURBSSurfaceAttributeKit.ShowMaximumAngle ( out float  out_degrees)
inline

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.

◆ ShowMaximumDeviation()

bool HPS.NURBSSurfaceAttributeKit.ShowMaximumDeviation ( out float  out_deviation)
inline

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.

◆ ShowMaximumTrimDeviation()

bool HPS.NURBSSurfaceAttributeKit.ShowMaximumTrimDeviation ( out float  out_deviation)
inline

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.

◆ ShowMaximumWidth()

bool HPS.NURBSSurfaceAttributeKit.ShowMaximumWidth ( out float  out_width)
inline

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.

◆ ShowTrimBudget()

bool HPS.NURBSSurfaceAttributeKit.ShowTrimBudget ( out ulong  out_budget)
inline

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.

◆ UnsetBudget()

HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.UnsetBudget ( )
inline

Removes the NURBS surface tessellation budget.

Returns
A reference to this object.

◆ UnsetEverything()

HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetMaximumAngle()

HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.UnsetMaximumAngle ( )
inline

Removes the largest angle allowed between the surface tangents.

Returns
A reference to this object.

◆ UnsetMaximumDeviation()

HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.UnsetMaximumDeviation ( )
inline

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

Returns
A reference to this object.

◆ UnsetMaximumTrimDeviation()

HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.UnsetMaximumTrimDeviation ( )
inline

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

Returns
A reference to this object.

◆ UnsetMaximumWidth()

HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.UnsetMaximumWidth ( )
inline

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

Returns
A reference to this object.

◆ UnsetTrimBudget()

HPS.NURBSSurfaceAttributeKit HPS.NURBSSurfaceAttributeKit.UnsetTrimBudget ( )
inline

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:
  • internals/hps_core/source/cs/HPS.NURBSSurfaceAttributeKit.cs