PhosphorAnimation::PhosphorProfile Class Reference

QML value-type wrapper around PhosphorAnimation::Profile. More...

#include <phosphor-animation/include/PhosphorAnimation/PhosphorProfile.h>

Public Types
enum class	SequenceMode : int { AllAtOnce = int(PhosphorAnimation::SequenceMode::AllAtOnce) , Cascade = int(PhosphorAnimation::SequenceMode::Cascade) }

Public Member Functions
	PhosphorProfile ()=default
	PhosphorProfile (const Profile &value)
	Explicit converting ctor from a core-library value.
const Profile &	value () const
	Read-only access to the underlying value.
PhosphorCurve	curve () const
void	setCurve (const PhosphorCurve &c)
qreal	duration () const
void	setDuration (qreal ms)
int	minDistance () const
void	setMinDistance (int px)
SequenceMode	sequenceMode () const
void	setSequenceMode (SequenceMode mode)
int	staggerInterval () const
void	setStaggerInterval (int ms)
QString	presetName () const
void	setPresetName (const QString &name)
QJsonObject	toJson () const
	Serialize to a JSON object via Profile::toJson.
bool	operator== (const PhosphorProfile &other) const
bool	operator!= (const PhosphorProfile &other) const

Static Public Member Functions
static PhosphorProfile	fromJson (const QJsonObject &obj)
	Parse from a JSON object.

Detailed Description

QML value-type wrapper around PhosphorAnimation::Profile.

Q_GADGET per Phase 4 decision O — compile-time snapshot shape for PhosphorMotionAnimation.profile: PhosphorProfile { … } (decision R's value-binding branch). The path-string branch goes through PhosphorProfileRegistry and lands in a later sub-commit.

Optional-field treatment in QML

Profile's fields are std::optional<T> so ProfileTree inheritance can distinguish "unset, inherit" from "explicitly set to library default" (see Profile.h's class doc). QML cannot represent std::optional<T> directly, so the wrapper collapses the distinction at the QML boundary:

• Reading a property returns the effective value (Profile:: effective*). Unset fields read back as their library default.
• Writing a property engages the optional when the value validates, so the field becomes "explicitly set". A write that FAILS validation disengages it instead, which is one of two QML-reachable ways to return a field to "unset" (from C++, call Profile::*.reset() directly). presetName is the exception on this bullet too: its setter validates nothing and always engages, so QML has NO path back to "unset" for it, and reads cannot tell unset from engaged-empty (both return ""). A QML read-modify-write of a profile therefore converts an inherited presetName into an explicit empty override — acceptable because the field is a display label, but load-bearing on the C++ side where engaged-empty blocks tree inheritance (Profile::toJson emits it).

curve is the exception to BOTH bullets, because there is no Profile::effectiveCurve():

• Reading it when unset returns a NULL PhosphorCurve, NOT the library default. isNull() is true and typeId is empty on a fresh gadget; the OutCubic default is substituted later, by withDefaults() and by consumers. Check isNull() rather than assuming a curve is there.
• Assigning a default-constructed PhosphorCurve disengages it, which is the second way to reach "unset" from QML — and setCurve is also the one setter that applies no validation at all, since a curve handle is either a valid curve or null.

This matches how plugin authors typically use PhosphorProfile: construct a compile-time literal with every field they care about, hand it to PhosphorMotionAnimation.profile, and treat it as immutable. ProfileTree inheritance is a C++-side concern accessed through the core ProfileTree API, not through this wrapper.

Member Enumeration Documentation

SequenceMode

enum class PhosphorAnimation::PhosphorProfile::SequenceMode : int

strong

Enumerator
AllAtOnce
Cascade

Constructor & Destructor Documentation

PhosphorProfile() [1/2]

PhosphorAnimation::PhosphorProfile::PhosphorProfile ( )

default

PhosphorProfile() [2/2]

PhosphorAnimation::PhosphorProfile::PhosphorProfile ( const Profile &  value )

inlineexplicit

Explicit converting ctor from a core-library value.

Member Function Documentation

curve()

PhosphorCurve PhosphorAnimation::PhosphorProfile::curve ( ) const

inline

duration()

qreal PhosphorAnimation::PhosphorProfile::duration ( ) const

inline

fromJson()

static PhosphorProfile PhosphorAnimation::PhosphorProfile::fromJson ( const QJsonObject &  obj )

inlinestatic

Parse from a JSON object.

Missing keys become unset fields (read back as library defaults via effective*).

Uses the process-wide CurveRegistry installed via PhosphorCurve::setDefaultRegistry when available so user-authored curves registered by CurveLoader are visible to this parse path. Falls back to a function-local static registry (built-ins only) when no default registry has been installed — this covers startup-before-composition-root and test harness paths where the daemon hasn't published a user-curve-aware registry yet. Consulting the published registry first matches the convention used by PhosphorCurve::fromString.

minDistance()

int PhosphorAnimation::PhosphorProfile::minDistance ( ) const

inline

operator!=()

bool PhosphorAnimation::PhosphorProfile::operator!= ( const PhosphorProfile &  other ) const

inline

operator==()

bool PhosphorAnimation::PhosphorProfile::operator== ( const PhosphorProfile &  other ) const

inline

presetName()

QString PhosphorAnimation::PhosphorProfile::presetName ( ) const

inline

sequenceMode()

SequenceMode PhosphorAnimation::PhosphorProfile::sequenceMode ( ) const

inline

setCurve()

void PhosphorAnimation::PhosphorProfile::setCurve ( const PhosphorCurve &  c )

inline

setDuration()

void PhosphorAnimation::PhosphorProfile::setDuration ( qreal  ms )

inline

setMinDistance()

void PhosphorAnimation::PhosphorProfile::setMinDistance ( int  px )

inline

setPresetName()

void PhosphorAnimation::PhosphorProfile::setPresetName ( const QString &  name )

inline

setSequenceMode()

void PhosphorAnimation::PhosphorProfile::setSequenceMode ( SequenceMode  mode )

inline

setStaggerInterval()

void PhosphorAnimation::PhosphorProfile::setStaggerInterval ( int  ms )

inline

staggerInterval()

int PhosphorAnimation::PhosphorProfile::staggerInterval ( ) const

inline

toJson()

QJsonObject PhosphorAnimation::PhosphorProfile::toJson ( ) const

inline

Serialize to a JSON object via Profile::toJson.

Only engaged fields are written, matching the inheritance-preserving JSON shape the C++ side produces.

value()

const Profile & PhosphorAnimation::PhosphorProfile::value ( ) const

inline

Read-only access to the underlying value.

The non-const overload was deliberately removed: a mutable handle from QML let scripts bypass the setter clamps below by writing directly into the engaged-optional fields. Core-library mutators construct a fresh Profile and assign through the converting ctor instead, which is explicit, so the conversion has to be written out.

---

The documentation for this class was generated from the following file:

• phosphor-animation/include/PhosphorAnimation/PhosphorProfile.h