Animation Class Reference

Inheritance diagram for Animation:

Collaboration diagram for Animation:

Public Member Functions
	ATTRIB (Animation, m_framenames, string)
	ATTRIB (Animation, object, entity)
virtual void	calcValue ()
virtual void	configureAnimation ()
virtual void	finishAnim ()
	LOG_DEBUGF ("Missing animation for %s: %s", modelnameforindex(mdlidx), this.registered_id)
virtual void	resumeAnim ()
virtual void	setObjectSetter ()
void	setterDummy (Animation this, float)
virtual void	setTimeStartDuration ()
virtual void	setTimeStartEnd ()
virtual void	setValueStartEnd ()
virtual void	stopAnim ()
virtual void	tick ()
virtual void	update ()
	void (Animation this, float) setter

Public Attributes
float	delta = 0
float	duration = 0
float	finished = false
	return
float	startTime = 0
float	startValue = 0
float	stopped = false
float	value = 0

Detailed Description

Definition at line 10 of file animdecide.qh.

Member Function Documentation

ATTRIB() [1/2]

Animation::ATTRIB	(	Animation	,
		m_framenames	,
		string	)

References ATTRIB(), FOREACH_WORD, STATIC_METHOD, and this.

Referenced by ATTRIB().

ATTRIB() [2/2]

Animation::ATTRIB	(	Animation	,
		object	,
		entity	)

References entity().

calcValue()

void Animation::calcValue ( )

virtual

Reimplemented in Easing, and Keyframe.

Definition at line 52 of file animation.qc.

    {
        return animStartValue;
    }

References calcValue(), and entity().

Referenced by calcValue(), and tick().

configureAnimation()

void Animation::configureAnimation ( )

virtual

Definition at line 5 of file animation.qc.

    {
        this.setObjectSetter(this, obj, objSetter);
        this.setTimeStartDuration(this, animStartTime, animDuration);
        this.setValueStartEnd(this, animStartValue, animEndValue);
    }

References configureAnimation(), entity(), setObjectSetter(), setTimeStartDuration(), and setValueStartEnd().

Referenced by configureAnimation().

finishAnim()

void Animation::finishAnim ( )

virtual

Definition at line 67 of file animation.qc.

    {
        this.value = this.delta + this.startValue;
        this.finished = true;
        this.setter(this.object, this.value);
    }

References delta, entity(), finishAnim(), finished, startValue, and value.

Referenced by finishAnim(), and tick().

LOG_DEBUGF()

Animation::LOG_DEBUGF	(	"Missing animation for %s: %s"	,
		modelnameforindex(mdlidx)	,
		this.	registered_id )

References registered_id.

resumeAnim()

void Animation::resumeAnim ( )

virtual

Definition at line 62 of file animation.qc.

    {
        this.stopped = false;
    }

References entity(), resumeAnim(), and stopped.

Referenced by resumeAnim().

setObjectSetter()

void Animation::setObjectSetter ( )

virtual

Definition at line 36 of file animation.qc.

    {
        this.object = o;
        this.setter = s;
    }

References entity(), and setObjectSetter().

Referenced by configureAnimation(), and setObjectSetter().

setterDummy()

void Animation::setterDummy ( Animation this, float  )

inline

Definition at line 18 of file animation.qh.

{}

Referenced by void().

setTimeStartDuration()

void Animation::setTimeStartDuration ( )

virtual

Definition at line 24 of file animation.qc.

    {
        this.startTime = s;
        this.duration = d;
    }

References duration, entity(), setTimeStartDuration(), and startTime.

Referenced by configureAnimation(), setTimeStartDuration(), and update().

setTimeStartEnd()

void Animation::setTimeStartEnd ( )

virtual

Definition at line 18 of file animation.qc.

    {
        this.startTime = s;
        this.duration = e - s;
    }

References duration, entity(), setTimeStartEnd(), and startTime.

Referenced by setTimeStartEnd().

setValueStartEnd()

void Animation::setValueStartEnd ( )

virtual

Definition at line 30 of file animation.qc.

    {
        this.startValue = s;
        this.delta = e - s;
    }

References delta, entity(), setValueStartEnd(), and startValue.

Referenced by configureAnimation(), setValueStartEnd(), and update().

stopAnim()

void Animation::stopAnim ( )

virtual

Definition at line 57 of file animation.qc.

    {
        this.stopped = true;
    }

References entity(), stopAnim(), and stopped.

Referenced by stopAnim().

tick()

void Animation::tick ( )

virtual

Definition at line 42 of file animation.qc.

    {
        if (this.stopped || this.finished || (tickTime < this.startTime)) return;
 
        if (tickTime >= (this.startTime + this.duration)) this.finishAnim(this);
        else this.value = this.calcValue(this, (tickTime - this.startTime), this.duration, this.startValue, this.delta);
 
        this.setter(this.object, this.value);
    }

References calcValue(), delta, duration, entity(), finishAnim(), finished, startTime, startValue, stopped, tick(), and value.

Referenced by tick().

update()

void Animation::update ( )

virtual

Definition at line 12 of file animation.qc.

    {
        this.setTimeStartDuration(this, time, animDuration);
        this.setValueStartEnd(this, animStartValue, animEndValue);
    }

References entity(), setTimeStartDuration(), setValueStartEnd(), time, and update().

Referenced by update().

void()

Animation::void	(	Animation	this,
		float	)

References setterDummy().

Member Data Documentation

delta

float Animation::delta = 0

Definition at line 24 of file animation.qh.

Referenced by finishAnim(), setValueStartEnd(), and tick().

duration

float Animation::duration = 0

Definition at line 22 of file animation.qh.

Referenced by setTimeStartDuration(), setTimeStartEnd(), and tick().

finished

float Animation::finished = false

Definition at line 26 of file animation.qh.

Referenced by finishAnim(), and tick().

return

Animation::return

Definition at line 21 of file animdecide.qh.

startTime

float Animation::startTime = 0

Definition at line 21 of file animation.qh.

Referenced by setTimeStartDuration(), setTimeStartEnd(), and tick().

startValue

float Animation::startValue = 0

Definition at line 23 of file animation.qh.

Referenced by finishAnim(), setValueStartEnd(), and tick().

stopped

float Animation::stopped = false

Definition at line 25 of file animation.qh.

Referenced by resumeAnim(), stopAnim(), and tick().

value

float Animation::value = 0

Definition at line 20 of file animation.qh.

Referenced by finishAnim(), and tick().

---

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

• common/animdecide.qh
• menu/anim/animation.qh
• menu/anim/animation.qc