Click or drag to resize

SquishParameters Class

Parameters used by the 'Squish' command flattening algorithm
Inheritance Hierarchy
SystemObject
  Rhino.GeometrySquishParameters

Namespace:  Rhino.Geometry
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
public class SquishParameters : IDisposable

The SquishParameters type exposes the following members.

Constructors
  NameDescription
Public methodSquishParameters
Initializes a new instance with default values. Initial values are same as Default.
Top
Properties
  NameDescription
Public propertyAbsoluteLimit
If -1.0 <= AnsoluteLimit < 0.0, then then an absolute compression limit is applied so that (2d length)/(3d length) >= abs(AbsoluteLimit). In particular, Absolute = -1.0, then no compression is permitted(2d length) >= (3d length). If 0.0 < m_absolute_limit <= 1.0 then then an absolute stretching limit is applied so that (2d length)/(3d length) <= 1/abs(AbsoluteLimit). Examples: AbsoluteLimit 1.0: no stretching, (2d length) <= 1.0*(3d length) 0.5: cap on stretching, 0.5*(2d length) <= (3d length) -0.5: cap on compression, (2d length) >= 0.5*(3d length) -1.0: no compression, (2d length) >= 1.0*(3d length)
Public propertyAlgorithm
The flattening agorithm to use: Geometric: (scale independent)the "spring" constant is proportional to 1/L^2 and the result is independent of scale. PhysicalStress: (scale dependent) the "spring" constant is proportional to 1/L.
Public propertyBoundaryCompressConstant
Spring constant for compressed boundary edges times the rest length
Public propertyBoundaryStretchConstant
Spring constant for stretched boundary edges
Public propertyStatic memberDefault
Gets the default Squishing parameters
Public propertyInteriorCompressConstant
Spring constant for compressed interior edges times the rest length
Public propertyInteriorStretchConstant
Spring constant for stretched boundary edges times the rest length
Public propertyPreserveTopology
the mesh has coincident vertices and PreserveTopology is true, then the flattening is based on the mesh's topology and coincident vertices will remain coincident. Otherwise coincident vertices are free to move apart.
Public propertySaveMapping
If SaveMapping is true, then ON_SquishMesh() will save extra information on the squished mesh so 3d points and curves near the input mesh can be mapped to the squished mesh and 2d points and curves on the squished mesh can be mapped back to the 3d mesh.
Top
Methods
  NameDescription
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 methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
(Overrides ObjectFinalize.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetSpringConstants
See if the spring constants could have been set with SetSpringConstants().
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetDeformation
Sets the squish deformation characteristics
Public methodSetSpringConstants
A simplified interface for setting the Stretch and Compression spring constants
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also