PhosphorAnimation::CurveLoader Class Reference

Scans JSON curve-definition files and registers them with CurveRegistry. More...

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

Inheritance diagram for PhosphorAnimation::CurveLoader:

Classes
struct	Entry

Signals
void	curvesChanged ()

Public Member Functions
	CurveLoader (CurveRegistry &registry, QObject *parent=nullptr)
	~CurveLoader () override
int	loadFromDirectory (const QString &directory, LiveReload liveReload=LiveReload::Off)
	Scan directory for *.json curve definitions and register each.
int	loadFromDirectories (const QStringList &directories, LiveReload liveReload=LiveReload::Off, PhosphorFsLoader::RegistrationOrder order=PhosphorFsLoader::RegistrationOrder::LowestPriorityFirst)
	Scan multiple directories in caller-declared priority order.
int	loadLibraryBuiltins (LiveReload liveReload=LiveReload::Off)
	Load curves bundled at the library's install-prefix data directory.
void	requestRescan ()
int	registeredCount () const
QString	ownerTag () const
QList< Entry >	entries () const

Detailed Description

Scans JSON curve-definition files and registers them with CurveRegistry.

Consumer-agnostic: callers supply directories via their own XDG namespace. Directory walking / watching / collision resolution delegated to DirectoryLoader.

Constructor & Destructor Documentation

CurveLoader()

PhosphorAnimation::CurveLoader::CurveLoader ( CurveRegistry &  registry, QObject *  parent = nullptr  )

explicit

~CurveLoader()

PhosphorAnimation::CurveLoader::~CurveLoader ( )

override

Member Function Documentation

curvesChanged

void PhosphorAnimation::CurveLoader::curvesChanged ( )

signal

entries()

QList< Entry > PhosphorAnimation::CurveLoader::entries

(

)

const

loadFromDirectories()

int PhosphorAnimation::CurveLoader::loadFromDirectories	(	const QStringList &	directories,
		LiveReload	liveReload = LiveReload::Off,
		PhosphorFsLoader::RegistrationOrder	order = PhosphorFsLoader::RegistrationOrder::LowestPriorityFirst
	)

Scan multiple directories in caller-declared priority order.

loadFromDirectory()

int PhosphorAnimation::CurveLoader::loadFromDirectory	(	const QString &	directory,
		LiveReload	liveReload = LiveReload::Off
	)

Scan directory for *.json curve definitions and register each.

loadLibraryBuiltins()

int PhosphorAnimation::CurveLoader::loadLibraryBuiltins

(

LiveReload

liveReload = LiveReload::Off

)

Load curves bundled at the library's install-prefix data directory.

ownerTag()

QString PhosphorAnimation::CurveLoader::ownerTag

(

)

const

registeredCount()

int PhosphorAnimation::CurveLoader::registeredCount

(

)

const

requestRescan()

void PhosphorAnimation::CurveLoader::requestRescan

(

)

---

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

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