HPS.NURBSSurfaceAttributeControl Class Reference
Inheritance diagram for HPS.NURBSSurfaceAttributeControl:
HPS.Control HPS.Object

Public Member Functions

override void Dispose ()
 
 NURBSSurfaceAttributeControl (HPS.SegmentKey in_seg)
 
 NURBSSurfaceAttributeControl (HPS.NURBSSurfaceAttributeControl in_that)
 
override HPS.Type ObjectType ()
 
HPS.NURBSSurfaceAttributeControl SetBudget (ulong in_budget)
 
HPS.NURBSSurfaceAttributeControl SetMaximumAngle (float in_degrees)
 
HPS.NURBSSurfaceAttributeControl SetMaximumDeviation (float in_deviation)
 
HPS.NURBSSurfaceAttributeControl SetMaximumTrimDeviation (float in_deviation)
 
HPS.NURBSSurfaceAttributeControl SetMaximumWidth (float in_width)
 
HPS.NURBSSurfaceAttributeControl SetTrimBudget (ulong in_budget)
 
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)
 
override HPS.Type Type ()
 
HPS.NURBSSurfaceAttributeControl UnsetBudget ()
 
HPS.NURBSSurfaceAttributeControl UnsetEverything ()
 
HPS.NURBSSurfaceAttributeControl UnsetMaximumAngle ()
 
HPS.NURBSSurfaceAttributeControl UnsetMaximumDeviation ()
 
HPS.NURBSSurfaceAttributeControl UnsetMaximumTrimDeviation ()
 
HPS.NURBSSurfaceAttributeControl UnsetMaximumWidth ()
 
HPS.NURBSSurfaceAttributeControl UnsetTrimBudget ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

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.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The HPS.NURBSSurfaceAttributeControl class is a smart pointer that is tied to a database object. This object allows you to manipulate various settings related to NURBS surfaces, such as budget, angle, deviation, and width.

This table lists default values for the various segment attributes accessible from HPS.NURBSSurfaceAttributeControl.

Constructor & Destructor Documentation

◆ NURBSSurfaceAttributeControl() [1/2]

HPS.NURBSSurfaceAttributeControl.NURBSSurfaceAttributeControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ NURBSSurfaceAttributeControl() [2/2]

HPS.NURBSSurfaceAttributeControl.NURBSSurfaceAttributeControl ( HPS.NURBSSurfaceAttributeControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.NURBSSurfaceAttributeControl.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.Control.

◆ SetBudget()

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

◆ ShowBudget()

bool HPS.NURBSSurfaceAttributeControl.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.NURBSSurfaceAttributeControl.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.NURBSSurfaceAttributeControl.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.NURBSSurfaceAttributeControl.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.NURBSSurfaceAttributeControl.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.NURBSSurfaceAttributeControl.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.

◆ Type()

override HPS.Type HPS.NURBSSurfaceAttributeControl.Type ( )
inlinevirtual

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.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS.Control.

◆ UnsetBudget()

HPS.NURBSSurfaceAttributeControl HPS.NURBSSurfaceAttributeControl.UnsetBudget ( )
inline

Unsets the NURBS surface tessellation budget. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CurveAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetEverything()

HPS.NURBSSurfaceAttributeControl HPS.NURBSSurfaceAttributeControl.UnsetEverything ( )
inline

Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by CurveAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetMaximumAngle()

HPS.NURBSSurfaceAttributeControl HPS.NURBSSurfaceAttributeControl.UnsetMaximumAngle ( )
inline

Removes the largest angle allowed between the surface tangents. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CurveAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetMaximumDeviation()

HPS.NURBSSurfaceAttributeControl HPS.NURBSSurfaceAttributeControl.UnsetMaximumDeviation ( )
inline

Removes the upper bound of the difference between the NURBS surface and its parametric definition. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CurveAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetMaximumTrimDeviation()

HPS.NURBSSurfaceAttributeControl HPS.NURBSSurfaceAttributeControl.UnsetMaximumTrimDeviation ( )
inline

Removes the upper bound of trim curve vertices from the parametric definition of the trimming curve. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CurveAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetMaximumWidth()

HPS.NURBSSurfaceAttributeControl HPS.NURBSSurfaceAttributeControl.UnsetMaximumWidth ( )
inline

Removes the setting for the largest allowable length of any facet's edge. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CurveAttributeKit.GetDefault().

Returns
A reference to this object.

◆ UnsetTrimBudget()

HPS.NURBSSurfaceAttributeControl HPS.NURBSSurfaceAttributeControl.UnsetTrimBudget ( )
inline

Removes the upper bound of vertices to be used in trim curve tessellation. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CurveAttributeKit.GetDefault().

Returns
A reference to this object.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.NURBSSurfaceAttributeControl.cs