A collection of parameters that are passed to functions that calculate a various representations of SubD objects.
Constructors
public SubDDisplayParameters()
Initializes a new instance with default values.
Called by BinaryFormatter.Deserialize to create a new MeshParamaters object.
Parameters:
| info (SerializationInfo) | |
| context (StreamingContext) |
Finalizer
~SubDDisplayParameters
#~SubDDisplayParameters()
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
Properties
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.
True if the SubD display density setting is absolute.
True if the SubD display density setting is adaptive and approximate display mesh quad count is capped at SubDDisplayParameters::AdaptiveDisplayMeshQuadMaximum.
The MeshLocation property determines if the mesh is on the SubD's control net or the SubD's surface.
Methods
[CLSCompliant(false)]
public static uint AbsoluteDisplayDensityFromSubD(uint adaptiveSubDDisplayDensity, SubD subd)
Gets absolute SubD display density for subd.
Parameters:
| adaptiveSubDDisplayDensity (uint) | A value <= SubDDisplayParameters.Density.MaximumDensity. When in doubt, pass SubDDisplayParameters.Density.DefaultDensity. |
| subd (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. |
Returns: The absolute SubD display density is <= adaptiveSubDDisplayDensity and <= SubDDisplayParameters.Density.MaximumDensity.
[CLSCompliant(false)]
public static uint AbsoluteDisplayDensityFromSubDFaceCount(uint adaptiveSubDDisplayDensity, uint subDFaceCount)
obsoleteUse AbsoluteDisplayDensityFromSubD
Gets the absolute SubD display density for SubD with subdFaceCount faces.
Parameters:
| adaptiveSubDDisplayDensity (uint) | A value <= SubDDisplayParameters.Density.MaximumDensity. When in doubt, pass SubDDisplayParameters.Density.DefaultDensity. |
| subDFaceCount (uint) | Number of SubD faces. |
Returns: The absolute SubD display density is <= adaptiveSubDDisplayDensity and <= SubDDisplayParameters.Density.MaximumDensity.
Limits display density to a value useful in user interface code.
Parameters:
| displayDensity (uint) |
Returns: The clamped value.
Parameters for a course limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.CoarseDensity.
Returns: The SubD display parameters.
[CLSCompliant(false)]
public static SubDDisplayParameters CreateFromAbsoluteDisplayDensity(uint absoluteSubDDisplayDensity)
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.
Parameters:
| absoluteSubDDisplayDensity (uint) | A value <= SubDDisplayParameters.Density.MaximumDensity. When in doubt, pass SubDDisplayParameters.Density.DefaultDensity. |
Returns: The SubD display parameters.
[CLSCompliant(false)]
public static SubDDisplayParameters CreateFromDisplayDensity(uint adaptiveSubDDisplayDensity)
In most applications, the caller sets the mesh density and leaves the other parameters set to the default values.
Parameters:
| adaptiveSubDDisplayDensity (uint) | 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. |
Returns: The SubD display parameters.
This function creates SubDDisplayParameters from a user interface "slider" like Rhino's simple mesh controls.
Parameters:
| normalizedMeshDensity (double) | A double between 0.0 and 1.0. |
Returns: A valid ON_SubDDisplayParameters with the specified subd display density.
Parameters for the default limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.DefaultDensity.
Returns: The SubD display parameters.
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.
Parameters:
| subd (SubD) | The SubD object. |
Returns: The display density.
public void Dispose()
Actively reclaims unmanaged resources that this instance uses.
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.
Parameters:
| disposing (bool) | true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer. |
Get an empty SubDDisplayParameters.
Returns: The SubD display parameters.
Parameters for an extra course limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.ExtraCoarseDensity.
Returns: The SubD display parameters.
Parameters for an extra fine limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.ExtraFineDensity.
Returns: The SubD display parameters.
Parameters for a fine limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.FineDensity.
Returns: The SubD display parameters.
Converts encoded serialized string into a MeshingParameters
Parameters:
| value (string) | Encoded string returned by MeshingParameters.ToString() |
Returns: Returns a new MeshingParameters created by decoding and deserializing the string or null if value is invalid.
Populates a SerializationInfo with the data needed to serialize the target object.
Parameters:
| info (SerializationInfo) | The SerializationInfo to populate with data. |
| context (StreamingContext) | The destination (see StreamingContext) for this serialization. |
Exceptions:
| SecurityException | The caller does not have the required permission. |
Parameters for a medium limit surface display mesh. SubD display density = adaptive SubDDisplayParameters.Density.MediumDensity.
Returns: The SubD display parameters.
In almast all cases, you are better off using SetAdaptiveDisplayDensity().
Parameters:
| absoluteDisplayDensity (uint) | absoluteDisplayDensity <= SubDDisplayParameters.Density.MaximumDensity. |
Set an adaptive SubD display density that caps display mesh quad count at SubDDisplayParameters.AdaptiveDisplayMeshQuadMaximum.
Parameters:
| adaptiveDisplayDensity (uint) | adaptiveDisplayDensity <= SubDDisplayParameters.Density.MaximumDensity. Values <= SubDDisplayParameters.Density.MinimumAdaptiveDensity will never be adaptively reduced during display mesh creation. |