Kuesa::Qt3D::SteppedAnimationPlayer

Module: Kuesa Qt 3D API

SteppedAnimationPlayer is an utility class that automatically stops a set of animations when the "up" signal of an AnimationPulse is emitted. More...

#include <Kuesa/Qt3D/api/steppedanimationplayer.h>

Inherits from Kuesa::Qt3D::AnimationPulse, Kuesa::Qt3D::AnimationPlayer, Kuesa::Qt3D::KuesaNode, Qt3DCore::QNode

Public Signals

	Name
void	animationNamesChanged()

Public Functions

	Name
	SteppedAnimationPlayer(Qt3DCore::QNode * parent =nullptr)
QStringList	animationNames() const
void	setAnimationNames(const QStringList & animationNames)

Public Properties

	Name
QStringList	animationNames

Additional inherited members

Public Signals inherited from Kuesa::Qt3D::AnimationPulse

	Name
void	up()
void	down()
void	pulseChanged(float pulse)

Public Functions inherited from Kuesa::Qt3D::AnimationPulse

	Name
	AnimationPulse(Qt3DCore::QNode * parent =nullptr)
float	pulse() const

Public Properties inherited from Kuesa::Qt3D::AnimationPulse

	Name
float	pulse

Public Types inherited from Kuesa::Qt3D::AnimationPlayer

	Name
enum	Loops { Infinite}

Public Slots inherited from Kuesa::Qt3D::AnimationPlayer

	Name
void	setClip(const QString & clip)
void	setMapper(const QString & mapper)
void	setRunning(bool running)
void	setLoopCount(int loops)
void	setClock(Qt3DAnimation::QClock * clock)
void	setNormalizedTime(float timeFraction)
void	start(int delay =0)
void	stop()
void	reset()
void	restart(int delay =0)
void	run(float fromTimeFraction, float toTimeFraction)

Public Signals inherited from Kuesa::Qt3D::AnimationPlayer

	Name
void	statusChanged(Kuesa::Qt3D::AnimationPlayer::Status status)
void	clipChanged(const QString & clip)
void	mapperChanged(const QString & mapper)
void	runningChanged(bool running)
void	loopCountChanged(int loops)
void	clockChanged(Qt3DAnimation::QClock * clock)
void	normalizedTimeChanged(float index)
void	durationChanged(float duration)
void	currentLoopChanged(int currentLoop)

Public Functions inherited from Kuesa::Qt3D::AnimationPlayer

	Name
	Q_ENUM(Loops )
Q_ENUM(Status) explicit AnimationPlayer(Qt3DCore	~AnimationPlayer()
Status	status() const
QString	clip() const
QString	mapper() const
bool	isRunning() const
int	loopCount() const
int	currentLoop() const
Qt3DAnimation::QClock *	clock() const
float	normalizedTime() const
float	duration() const
QVector< Qt3DCore::QNode * >	targets() const AnimationPlayer::targets returns the list of currently defined targets for animations.
void	addTarget(Qt3DCore::QNode * target) AnimationPlayer::addTarget adds a node target as a target for the animation.
void	removeTarget(Qt3DCore::QNode * target)

Public Properties inherited from Kuesa::Qt3D::AnimationPlayer

	Name
Status	status the current status of the player
QString	clip the name of the clip asset.
QString	mapper the name of the mapper asset.
bool	running controls if the animation is running or not
int	loops controls the number of time the animation should repeat.
int	currentLoop
Qt3DAnimation::QClock *	clock instance of Qt3DAnimation::QClock used to control animation speed and direction
float	normalizedTime progress of the animation as a uniform value between 0. and 1.
float	duration duration of the animation in secconds

Public Slots inherited from Kuesa::Qt3D::KuesaNode

	Name
void	setSceneEntity(Kuesa::Qt3D::SceneEntity * sceneEntity)

Public Signals inherited from Kuesa::Qt3D::KuesaNode

	Name
void	sceneEntityChanged(Kuesa::Qt3D::SceneEntity * sceneEntity)

Public Functions inherited from Kuesa::Qt3D::KuesaNode

	Name
	KuesaNode(Qt3DCore::QNode * parent =nullptr)
SceneEntity *	sceneEntity() const

Public Properties inherited from Kuesa::Qt3D::KuesaNode

	Name
Kuesa::Qt3D::SceneEntity *	sceneEntity

Protected Attributes inherited from Kuesa::Qt3D::KuesaNode

	Name
SceneEntity *	m_sceneEntity

Detailed Description

class Kuesa::Qt3D::SteppedAnimationPlayer;

SteppedAnimationPlayer is an utility class that automatically stops a set of animations when the "up" signal of an AnimationPulse is emitted.

Since: Kuesa 2.0

Given a list of animation names, it will create a Kuesa::Qt3D::AnimationPlayer for each. The running state of each of these Kuesa::Qt3D::AnimationPlayer will match the running state of the Kuesa::Qt3D::SteppedAnimationPlayer. Therefore, when the Kuesa::Qt3D::SteppedAnimationPlayer starts, all the animations will start.

When the "up" signal of the Kuesa::Qt3D::SteppedAnimationPlayer is triggered, the Kuesa::Qt3D::SteppedAnimationPlayer and all the animations will stop.

Public Signals Documentation

signal animationNamesChanged

void animationNamesChanged()

Public Functions Documentation

function SteppedAnimationPlayer

explicit SteppedAnimationPlayer(
    Qt3DCore::QNode * parent =nullptr
)

function animationNames

QStringList animationNames() const

function setAnimationNames

void setAnimationNames(
    const QStringList & animationNames
)

Public Property Documentation

property animationNames

QStringList animationNames;

Holds the names of the animations that are controlled by this Kuesa::Qt3D::SteppedAnimationPlayer

---

Updated on 2023-07-03 at 11:02:09 +0000