Skip to content

Class uipc::constitution::LinearMotor

ClassList > uipc > constitution > LinearMotor

Inherits the following classes: uipc::constitution::Constraint

Public Functions

Type Name
LinearMotor (const Json & config=default_config()) noexcept
void apply_to (geometry::SimplicialComplex & sc, Float strength_ratio=100.0, Vector3 motor_axis=-Vector3::UnitZ(), Float motor_vel=1.0) const

Public Functions inherited from uipc::constitution::Constraint

See uipc::constitution::Constraint

Type Name
Constraint () noexcept

Public Functions inherited from uipc::constitution::IConstitution

See uipc::constitution::IConstitution

Type Name
std::string_view name () noexcept const
std::string_view type () noexcept const
U64 uid () noexcept const
const builtin::UIDInfo & uid_info () noexcept const
virtual ~IConstitution () = default

Public Static Functions

Type Name
void animate (geometry::SimplicialComplex & sc, Float dt)
Json default_config ()

Protected Functions

Type Name
virtual U64 get_uid () noexcept override const

Protected Functions inherited from uipc::constitution::Constraint

See uipc::constitution::Constraint

Type Name
void apply_to (geometry::SimplicialComplex & sc) const
virtual U64 get_uid () noexcept const = 0

Protected Functions inherited from uipc::constitution::IConstitution

See uipc::constitution::IConstitution

Type Name
virtual U64 get_uid () noexcept const = 0

Public Functions Documentation

function LinearMotor

uipc::constitution::LinearMotor::LinearMotor (
    const Json & config=default_config()
) noexcept

function apply_to

void uipc::constitution::LinearMotor::apply_to (
    geometry::SimplicialComplex & sc,
    Float strength_ratio=100.0,
    Vector3 motor_axis=-Vector3::UnitZ(),
    Float motor_vel=1.0
) const

Public Static Functions Documentation

function animate

static void uipc::constitution::LinearMotor::animate (
    geometry::SimplicialComplex & sc,
    Float dt
)

function default_config

static Json uipc::constitution::LinearMotor::default_config ()

Protected Functions Documentation

function get_uid

virtual U64 uipc::constitution::LinearMotor::get_uid () noexcept override const

Implements uipc::constitution::Constraint::get_uid

The documentation for this class was generated from the following file include/uipc/constitution/soft_transform_constraint.h