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

Copy

[SerializableAttribute]
public class SubDDisplayParameters : IDisposable, 
	ISerializable

<SerializableAttribute>
Public Class SubDDisplayParameters
	Implements IDisposable, ISerializable

The SubDDisplayParameters type exposes the following members.

Constructors

	Name	Description
	SubDDisplayParameters	Initializes a new instance with default values.
	SubDDisplayParameters(SerializationInfo, StreamingContext)	Called by BinaryFormatter.Deserialize to create a new MeshParamaters object.

Top

Properties

	Name	Description
	AdaptiveDisplayMeshQuadMaximum	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.
	DisplayDensityIsAbsolute	True if the SubD display density setting is absolute.
	DisplayDensityIsAdaptive	True if the SubD display density setting is adaptive and approximate display mesh quad count is capped at SubDDisplayParameters::AdaptiveDisplayMeshQuadMaximum.
	MeshLocation	The MeshLocation property determines if the mesh is on the SubD's control net or the SubD's surface.

Top

Methods

	Name	Description
	AbsoluteDisplayDensityFromSubD	Gets absolute SubD display density for subd.
	AbsoluteDisplayDensityFromSubDFaceCount	Gets the absolute SubD display density for SubD with subdFaceCount faces.
	ClampDisplayDensity	Limits display density to a value useful in user interface code.
	Coarse	Parameters for a course limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.CoarseDensity.
	CreateFromAbsoluteDisplayDensity	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.
	CreateFromDisplayDensity	In most applications, the caller sets the mesh density and leaves the other parameters set to the default values.
	CreateFromMeshDensity	This function creates SubDDisplayParameters from a user interface "slider" like Rhino's simple mesh controls.
	Default	Parameters for the default limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.DefaultDensity.
	DisplayDensity	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.
	Dispose	Actively reclaims unmanaged resources that this instance uses.
	Dispose(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.
	Empty	Get an empty SubDDisplayParameters.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	ExtraCoarse	Parameters for an extra course limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.ExtraCoarseDensity.
	ExtraFine	Parameters for an extra fine limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.ExtraFineDensity.
	Finalize	Passively reclaims unmanaged resources when the class user did not explicitly call Dispose(). (Overrides ObjectFinalize.)
	Fine	Parameters for a fine limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.FineDensity.
	FromEncodedString	Converts encoded serialized string into a MeshingParameters
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Medium	Parameters for a medium limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.MediumDensity.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SetAbsoluteDisplayDensity	In almast all cases, you are better off using SetAdaptiveDisplayDensity().
	SetAdaptiveDisplayDensity	Set an adaptive SubD display density that caps display mesh quad count at SubDDisplayParameters.AdaptiveDisplayMeshQuadMaximum.
	ToEncodedString	Returns a encoded string that represents the MeshingParameters.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

Rhino.Geometry Namespace