RhinoCommon documentation has a new look. The old site can still be found here.

/

/

SquishParameters

SquishParameters class

Parameters used by the 'Squish' command flattening algorithm

Derived Classes:

Namespace: Rhino.Geometry
SquishParameters: references

Constructors (1)

SquishParameters()

Initializes a new instance with default values. Initial values are same as Default.

Properties (9)

AbsoluteLimit

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)

Algorithm

The flattening algorithm 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.

BoundaryCompressConstant

Spring constant for compressed boundary edges times the rest length

BoundaryStretchConstant

Spring constant for stretched boundary edges

Default

Gets the default Squishing parameters

InteriorCompressConstant

Spring constant for compressed interior edges times the rest length

InteriorStretchConstant

Spring constant for stretched boundary edges times the rest length

PreserveTopology

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.

SaveMapping

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.

Methods (5)

Dispose()

Actively reclaims unmanaged resources that this instance uses.

Dispose(bool disposing)

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.

GetSpringConstants(out double boundaryBias, out double deformationBias)

See if the spring constants could have been set with SetSpringConstants().

SetDeformation(SquishDeformation deformation, bool bPreserveBoundary, double boundaryStretchConstant, double boundaryCompressConstant, double interiorStretchConstant, double interiorCompressConstant)

Sets the squish deformation characteristics

SetSpringConstants(double boundaryBias, double deformationBias)

A simplified interface for setting the Stretch and Compression spring constants

Nothing found