stim::soft_body_handle class

A handle to a soft body.

Constructors, destructors, conversion operators

operator bool() const explicit constexpr noexcept: Returns true if this handle represents a soft_body (i.e is not null).
operator object_handle() const noexcept: Casts this handle to a generic object_handle.
soft_body_handle() defaulted constexpr noexcept: Default-constructs a null handle.
soft_body_handle(const soft_body_handle&) defaulted constexpr noexcept: Copy constructor.

Public functions

auto flags() const -> soft_body_flags noexcept: Gets the flags associated with this soft body, if any.
auto operator=(const soft_body_handle&) -> soft_body_handle& defaulted noexcept: Copy-assignment operator.

Mesh readers

RAII mesh readers for applying geometry changes back into your scene.

Attention

Instances of mesh_reader share a reference-counted lock to prevent you from modifying/updating the simulation while an object's mesh is being read. Do not keep mesh_reader instances alive! There is no performance benefit to doing so. Restrict their use to tightly-scoped situations, e.g.:

stim::soft_body_handle sb = /* ... */;

{
    auto reader = sb.mesh_reader();
    //
    // mesh reader ops here...
    //
}

// the mesh reader has gone out of scope at this point

auto leftover_mesh_reader() -> result<mesh_reader> noexcept: Gets a mesh reader for extracting the 'leftover' mesh (i.e. parts of the initial mesh that did not intersect with the simulation workspace).
auto mesh_reader() -> result<mesh_reader> noexcept: Gets a mesh reader so you can apply geometry changes back into your scene.

Function documentation

result<mesh_reader> stim::soft_body_handle::leftover_mesh_reader() noexcept

Gets a mesh reader for extracting the 'leftover' mesh (i.e. parts of the initial mesh that did not intersect with the simulation workspace).