pyvista_cad.CadMultiBlockAccessor.set_units

pyvista_cad.CadMultiBlockAccessor.set_units#

CadMultiBlockAccessor.set_units(target, *, convert=False)[source]#

Update cad.units on every block, optionally rescaling points.

Parameters:
targetstr

Target unit string.

convertbool, default: False

When True, rescale point coordinates by the unit ratio.

Parameters:
Return type:

None

Examples

>>> import pyvista as pv
>>> import pyvista_cad
>>> mb = pv.MultiBlock([pv.Sphere()])
>>> mb.cad.set_units('mm')
>>> mb.cad.units
'mm'