SubDDisplayParameters

ReferencesSince v7.18
A collection of parameters that are passed to functions that calculate a various representations of SubD objects.

Constructors

SubDDisplayParameters

#Since v7.18
Initializes a new instance with default values.
public SubDDisplayParameters()

SubDDisplayParameters

#Since v8.0
Called by BinaryFormatter.Deserialize to create a new MeshParamaters object.
public SubDDisplayParameters()

Finalizer

~SubDDisplayParameters

#
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
~SubDDisplayParameters()

Properties

AdaptiveDisplayMeshQuadMaximum

#Since v7.18
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.
[CLSCompliant(false)] public static uint AdaptiveDisplayMeshQuadMaximum { get; }

DisplayDensityIsAbsolute

#Since v7.18
True if the SubD display density setting is absolute.
public bool DisplayDensityIsAbsolute { get; }

DisplayDensityIsAdaptive

#Since v7.18
True if the SubD display density setting is adaptive and approximate display mesh quad count is capped at SubDDisplayParameters::AdaptiveDisplayMeshQuadMaximum.
public bool DisplayDensityIsAdaptive { get; }

MeshLocation

#Since v7.18
The MeshLocation property determines if the mesh is on the SubD's control net or the SubD's surface.
public SubDComponentLocation MeshLocation { get; set; }

Methods

AbsoluteDisplayDensityFromSubD

#Since v7.18
Gets absolute SubD display density for subd.
[CLSCompliant(false)] public static uint AbsoluteDisplayDensityFromSubD(
adaptiveSubDDisplayDensity,
A value <= SubDDisplayParameters.Density.MaximumDensity. When in doubt, pass SubDDisplayParameters.Density.DefaultDensity.
subd
In the cases when the SubD in question is not available, like user interface code that applies in general and to unknown SubDs, pass SubD.Empty.
)
The absolute SubD display density is <= adaptiveSubDDisplayDensity and <= SubDDisplayParameters.Density.MaximumDensity.

AbsoluteDisplayDensityFromSubDFaceCount

#Since v7.18 Obsolete v9.0
Gets the absolute SubD display density for SubD with subdFaceCount faces.
[CLSCompliant(false)] public static uint AbsoluteDisplayDensityFromSubDFaceCount(
adaptiveSubDDisplayDensity,
A value <= SubDDisplayParameters.Density.MaximumDensity. When in doubt, pass SubDDisplayParameters.Density.DefaultDensity.
subDFaceCount
Number of SubD faces.
)
obsoleteUse AbsoluteDisplayDensityFromSubD
The absolute SubD display density is <= adaptiveSubDDisplayDensity and <= SubDDisplayParameters.Density.MaximumDensity.

ClampDisplayDensity

#Since v7.18
Limits display density to a value useful in user interface code.
[CLSCompliant(false)] public static uint ClampDisplayDensity(
displayDensity
)
The clamped value.

Coarse

#Since v7.18
Parameters for a course limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.CoarseDensity.
public static SubDDisplayParameters Coarse()
The SubD display parameters.

CreateFromAbsoluteDisplayDensity

#Since v7.18
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.
[CLSCompliant(false)] public static SubDDisplayParameters CreateFromAbsoluteDisplayDensity(
absoluteSubDDisplayDensity
A value <= SubDDisplayParameters.Density.MaximumDensity. When in doubt, pass SubDDisplayParameters.Density.DefaultDensity.
)
The SubD display parameters.

CreateFromDisplayDensity

#Since v7.18
In most applications, the caller sets the mesh density and leaves the other parameters set to the default values.
[CLSCompliant(false)] public static SubDDisplayParameters CreateFromDisplayDensity(
adaptiveSubDDisplayDensity
A value <= SubDDisplayParameters.Density.MaximumDensity. When in doubt, pass SubDDisplayParameters.Density.DefaultDensity. Values < SubDDisplayParameters.Density.MinimumAdaptiveDensity are treated as SubDDisplayParameters.Density.MinimumAdaptiveDensity. All other invalid input values are treated as SubDDisplayParameters.Density.DefaultDensity.
)
The SubD display parameters.

CreateFromMeshDensity

#Since v7.18
This function creates SubDDisplayParameters from a user interface "slider" like Rhino's simple mesh controls.
public static SubDDisplayParameters CreateFromMeshDensity(
normalizedMeshDensity
A double between 0.0 and 1.0.
)
A valid ON_SubDDisplayParameters with the specified subd display density.

Default

#Since v7.18
Parameters for the default limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.DefaultDensity.
public static SubDDisplayParameters Default()
The SubD display parameters.

DisplayDensity

#Since v7.18
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.
[CLSCompliant(false)] public uint DisplayDensity(
subd
The SubD object.
)
The display density.

Dispose

#Since v7.18
Actively reclaims unmanaged resources that this instance uses.
public void Dispose()

Dispose

#
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.

protected virtual void Dispose(
disposing
true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer.
)

Empty

#Since v7.18
Get an empty SubDDisplayParameters.
public static SubDDisplayParameters Empty()
The SubD display parameters.

ExtraCoarse

#Since v7.18
Parameters for an extra course limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.ExtraCoarseDensity.
public static SubDDisplayParameters ExtraCoarse()
The SubD display parameters.

ExtraFine

#Since v7.18
Parameters for an extra fine limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.ExtraFineDensity.
public static SubDDisplayParameters ExtraFine()
The SubD display parameters.

Fine

#Since v7.18
Parameters for a fine limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.FineDensity.
public static SubDDisplayParameters Fine()
The SubD display parameters.

FromEncodedString

#Since v8.0
Converts encoded serialized string into a MeshingParameters
public static SubDDisplayParameters FromEncodedString(
value
Encoded string returned by MeshingParameters.ToString()
)
Returns a new MeshingParameters created by decoding and deserializing the string or null if value is invalid.

GetObjectData

#Since v8.0
Populates a SerializationInfo with the data needed to serialize the target object.
public void GetObjectData(
info,
The SerializationInfo to populate with data.
context
The destination (see StreamingContext) for this serialization.
)
SecurityExceptionThe caller does not have the required permission.

Medium

#Since v7.18
Parameters for a medium limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.MediumDensity.
public static SubDDisplayParameters Medium()
The SubD display parameters.

SetAbsoluteDisplayDensity

#Since v7.18
In almast all cases, you are better off using SetAdaptiveDisplayDensity().
[CLSCompliant(false)] public void SetAbsoluteDisplayDensity(
absoluteDisplayDensity
absoluteDisplayDensity <= SubDDisplayParameters.Density.MaximumDensity.
)

SetAdaptiveDisplayDensity

#Since v7.18
Set an adaptive SubD display density that caps display mesh quad count at SubDDisplayParameters.AdaptiveDisplayMeshQuadMaximum.
[CLSCompliant(false)] public void SetAdaptiveDisplayDensity(
adaptiveDisplayDensity
adaptiveDisplayDensity <= SubDDisplayParameters.Density.MaximumDensity. Values <= SubDDisplayParameters.Density.MinimumAdaptiveDensity will never be adaptively reduced during display mesh creation.
)

ToEncodedString

#Since v8.0
Returns a encoded string that represents the MeshingParameters.
public string ToEncodedString()
A encoded string that represents the MeshingParameters.