Click or drag to resize

SubDDisplayParameters Class

A collection of parameters that are passed to functions that calculate a various representations of SubD objects.
Inheritance Hierarchy
SystemObject
  Rhino.GeometrySubDDisplayParameters

Namespace:  Rhino.Geometry
Assembly:  RhinoCommon (in RhinoCommon.dll)
Since: 7.18
Syntax
public class SubDDisplayParameters : IDisposable

The SubDDisplayParameters type exposes the following members.

Constructors
  NameDescription
Public methodSubDDisplayParameters
Initializes a new instance with default values.
Top
Properties
  NameDescription
Public propertyStatic memberAdaptiveDisplayMeshQuadMaximum
When the SubD display density is adaptive (default), AdaptiveMeshQuadMaximum specifies the approximate number of display mesh quads to permit before reducing the SubD display mesh density.
Public propertyDisplayDensityIsAbsolute
True if the SubD display density setting is absolute.
Public propertyDisplayDensityIsAdaptive
True if the SubD display density setting is adaptive and approximate display mesh quad count is capped at SubDDisplayParameters::AdaptiveDisplayMeshQuadMaximum.
Public propertyMeshLocation
The MeshLocation property determines if the mesh is on the SubD's control net or the SubD's surface.
Top
Methods
  NameDescription
Public methodStatic memberAbsoluteDisplayDensityFromSubD
Gets absolute SubD display density for subd.
Public methodStatic memberAbsoluteDisplayDensityFromSubDFaceCount
Gets the absolute SubD display density for SubD with subdFaceCount faces.
Public methodStatic memberClampDisplayDensity
Limits display density to a value useful in user interface code.
Public methodStatic memberCoarse
Parameters for a course limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.CoarseDensity.
Public methodStatic memberCreateFromAbsoluteDisplayDensity
Use of absolute display density is strongly discouraged. SubDs can have a single face or millions of faces. Adaptive display meshing produces more desirable results in almost all cases.
Public methodStatic memberCreateFromDisplayDensity
In most applications, the caller sets the mesh density and leaves the other parameters set to the default values.
Public methodStatic memberCreateFromMeshDensity
This function creates SubDDisplayParameters from a user interface "slider" like Rhino's simple mesh controls.
Public methodStatic memberDefault
Parameters for the default limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.DefaultDensity.
Public methodDisplayDensity
Gets the absolute display density to use when creating display meshes for SubD. When adaptive reduction is enabled, subd.Faces.Count is used to determine the appropriate display density.
Public methodDispose
Actively reclaims unmanaged resources that this instance uses.
Protected methodDispose(Boolean)
For derived class implementers.

This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method.

You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.

Also, you must call the base virtual method within your overriding method.

Public methodStatic memberEmpty
Get an empty SubDDisplayParameters.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodStatic memberExtraCoarse
Parameters for an extra course limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.ExtraCoarseDensity.
Public methodStatic memberExtraFine
Parameters for an extra fine limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.ExtraFineDensity.
Protected methodFinalize
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
(Overrides ObjectFinalize.)
Public methodStatic memberFine
Parameters for a fine limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.FineDensity.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberMedium
Parameters for a medium limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.MediumDensity.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetAbsoluteDisplayDensity
In almast all cases, you are better off using SetAdaptiveDisplayDensity().
Public methodSetAdaptiveDisplayDensity
Set an adaptive SubD display density that caps display mesh quad count at SubDDisplayParameters.AdaptiveDisplayMeshQuadMaximum.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also