Skip to main content

SimCloth

16 tools in this family (folder Editor/Tools/SimCloth/ in the bridge package). Effect: writes changes the project or the scene, read-only does not, destructive deletes or overwrites and the client asks before running it.

ToolEffectDescription
sim_cloth_add_capsule_colliderwritesAdd a capsule body collider that the cloth resolves against during each iteration. The capsule is
sim_cloth_add_sphere_colliderwritesAdd a sphere body collider. The sphere is defined by a centre and a radius; if 'attached_to_transfor…
sim_cloth_add_wind_zonewritesAdd a wind volume to the cloth. Shape may be 'global' (uniform world-space wind), 'sphere' (volume
sim_cloth_apply_presetwritesApply a named cloth preset to an existing cloth. Available presets: TableCloth, Curtain, CurtainHeav…
sim_cloth_bake_to_animationwritesRun the cloth simulation for 'duration' seconds at 'sample_rate' Hz and store the resulting particle…
sim_cloth_configure_aerodynamicswritesSet the aerodynamic coefficients for this cloth. Drag opposes relative wind along the triangle norma…
sim_cloth_configure_lodwritesConfigure level-of-detail behaviour for the cloth. 'lod_scale' is a multiplier in (0, 1] applied to
sim_cloth_createwritesCreate a cloth simulation actor from a Unity Mesh source. Either provide 'mesh_filter_transform'
sim_cloth_export_setupread-onlyRead-only export of the cloth's full configuration as a JSON object: properties, wind zones, body
sim_cloth_get_stateread-onlyReturn the current state of a cloth actor: particle count, edge count, triangle count, active
sim_cloth_paint_pin_weightswritesPin a set of particles so they ignore physics. Use 'strategy' = 'indices' (with 'particle_indices'),…
sim_cloth_resetwritesRe-initialise the cloth from its topology rest positions. All particle velocities are zeroed, all
sim_cloth_set_propertieswritesUpdate one or more cloth properties without rebuilding geometry. Any omitted parameter keeps its
sim_cloth_set_proxywritesMark 'cloth_id' as a low-resolution simulation that drives the render mesh of 'render_cloth_id'.
sim_cloth_setup_skinningwritesBind the cloth actor to a SkinnedMeshRenderer for character clothing. Adds one skin constraint per
sim_cloth_setup_tearingwritesEnable or disable tearing for this cloth. When enabled, a distance constraint whose stretch ratio