|
Phosphor
Qt6 / Wayland library suite for window-management tools
|
|
| |
|
Phosphor
Qt6 / Wayland library suite for window-management tools
|
|
|
| |
QQuickPropertyAnimation subclass driving property animation with a phosphor-animation Profile.
More...
#include <phosphor-animation/include/PhosphorAnimation/PhosphorMotionAnimation.h>
Signals | |
| void | profileChanged () |
| void | durationOverrideChanged () |
Public Member Functions | |
| PhosphorMotionAnimation (QObject *parent=nullptr) | |
| ~PhosphorMotionAnimation () override | |
| QVariant | profile () const |
| void | setProfile (const QVariant &p) |
| int | durationOverride () const |
| void | setDurationOverride (int ms) |
| const Profile & | resolvedProfile () const |
| Current effective profile (with library defaults filled in for unset fields). | |
Static Public Attributes | |
| static constexpr int | kBezierSplineSegments = 8 |
Either a QString path (resolved live via PhosphorProfileRegistry) or a PhosphorProfile value (compile-time snapshot). | |
QQuickPropertyAnimation subclass driving property animation with a phosphor-animation Profile.
Phase 4 decision Q — the working shape for QML Behavior sites:
Inherits from QQuickPropertyAnimation (the Qt Quick base class that QML Behavior wires into). On profile resolution, the Phase-3 curve is converted to a QEasingCurve::BezierSpline approximation and installed via setEasing(), and the profile duration is installed via setDuration(). Qt Quick's animation infrastructure then handles all timing, interpolation, and property writes — no per-tick interpolated() override is needed.
The BezierSpline approximation samples the Phase-3 Curve::evaluate(t) into kBezierSplineSegments piecewise cubic Bezier segments (8 by default — chosen to stay safely below Qt 6.11's setEasing heap- corruption threshold at ≥11 segments while keeping visual faithfulness at typical 150-300 ms UI durations). Plain cubic-bezier Easing profiles take a fast path that installs a single canonical segment with the two original control points — no sampling.
profile is a QVariant accepting either:
QString path — resolved live through PhosphorProfileRegistry. A settings-reload that calls registerProfile(path, newProfile) fires profileChanged(path); this object re-resolves and rebinds, updating the easing curve and duration for the NEXT animation start.PhosphorProfile value — compile-time snapshot, installed as-is. No registry indirection, no live update.Assigning an unresolved path string (the registry doesn't know about it yet — typical during startup before ProfileLoader has scanned the XDG dirs) keeps the animation running with the library default profile (OutCubic, 150 ms) until the registry gets populated; the profileChanged(path) signal will then trigger the rebind.
QQuickPropertyAnimation is fundamentally fixed-duration — it parameterises progress as t in [0, 1]. Stateful curves (Spring) need real-time dt integration to preserve velocity across retargets, which the QPropertyAnimation/Behavior path cannot provide.
PhosphorMotionAnimation therefore uses the spring's analytical step response (Spring::evaluate(t)) rather than the physics integration (Spring::step(dt, state, target)). The visual shape is still spring-like — overshoot preserved, settle-time derived from damping ratio — but velocity continuity across mid-animation retargets is lost. Consumers that need true velocity-preserving spring retargets in QML should use PhosphorAnimatedReal (et al.) which use the Phase-3 AnimatedValue<T> path directly and preserve the physics.
|
explicit |
|
override |
| int PhosphorAnimation::PhosphorMotionAnimation::durationOverride | ( | ) | const |
|
signal |
| QVariant PhosphorAnimation::PhosphorMotionAnimation::profile | ( | ) | const |
|
signal |
| const Profile & PhosphorAnimation::PhosphorMotionAnimation::resolvedProfile | ( | ) | const |
Current effective profile (with library defaults filled in for unset fields).
Exposed for tests and adapter code that needs to inspect the resolved snapshot — not a Q_PROPERTY because the settings-time target for QML is always the input profile property, not the resolved form.
| void PhosphorAnimation::PhosphorMotionAnimation::setDurationOverride | ( | int | ms | ) |
| void PhosphorAnimation::PhosphorMotionAnimation::setProfile | ( | const QVariant & | p | ) |
|
staticconstexpr |
Either a QString path (resolved live via PhosphorProfileRegistry) or a PhosphorProfile value (compile-time snapshot).
See class doc for the dispatch shape. Override the resolved profile's duration (milliseconds). When > 0, this value is installed via QQuickPropertyAnimation:: setDuration instead of the profile's own duration — the profile's curve is still used. Zero or negative means "use the
profile's duration unchanged".
The intended use is binding a theme-scaled value like Kirigami.Units.longDuration so a shared profile JSON provides the curve shape while the caller's theme-scaled duration drives the timing. Without this property, switching a Behavior off a hardcoded duration: Kirigami.Units.* onto a fixed-duration profile silently drops the user's animation- speed preference from Plasma's system settings. Number of piecewise cubic Bezier segments used to approximate parametric / stateful curves (Spring, Elastic, Bounce, user-authored). Must stay below 11 — Qt 6.11's QQuickPropertyAnimation::setEasing heap-corrupts on QEasingCurve::BezierSpline curves with ≥11 segments. 8 keeps a safe margin while giving visually faithful approximations at 150-300 ms durations. Plain cubic-bezier Easing curves take the fast path (single canonical segment) and are not subject to this cap.
Exposed as a public static so tests can assert the installed easing's segment count stays under the Qt boundary — see the BezierSpline regression test in test_phosphormotionanimation.cpp.
1.9.8