iterator.c File Reference

Iterator code for animation/motion support. More...

#include "../ctl/ctldef.h"
#include "iterator.h"

Include dependency graph for iterator.c:

Go to the source code of this file.

Functions
void	LinePath_init (LinePath *self, int x1, int y1, int z1, unsigned msBegin, int x2, int y2, int z2, unsigned msFinish)
	Initialize linear motion.
void	LinePath_setpos (LinePath *self, int x, int y, int z, unsigned msCurrent)
	Set current position in space, now.
void	LinePath_moveto (LinePath *self, int x, int y, int z, unsigned msCurrent, unsigned msArrive)
	Move from current position to target.
bool	LinePath_curr (const LinePath *self, int *x, int *y, int *z, unsigned msCurrent)
	Get current position in space, given time.
int	Animator_init (Animator *self, int firstFrame, int lastFrame, Animator_Dir dir, unsigned msPerFrame)
	Initialize an animation.
int	Animator_set (Animator *self, int frame)
	Set animation to single frame.
bool	Animator_pending (const Animator *self)
	Return true if we're pending a oneshot event.
bool	Animator_curr (Animator *self, int *frame, unsigned msCurrent)
	Get current animation frame.

---

Detailed Description

Iterator code for animation/motion support.

Author:

David Mace

Definition in file iterator.c.

---

Function Documentation

bool Animator_curr	(	Animator *	self,
		int *	frame,
		unsigned	msCurrent
	)

Get current animation frame.

Parameters:

	self	Animation we're cycling
	frame	Int to receive frame index
	msCurrent	Realtime in milliseconds

Returns:

true if Animating, false if 'finished'

Definition at line 168 of file iterator.c.

{
    if( msCurrent - self->msprev > self->msframe )
    {
        if( !self->msprev )
        {
            self->msprev = msCurrent;
            *frame = self->iFrame;
            return false;
        }
        self->msprev = msCurrent;
        switch( self->aDir )
        {
        case an_Stop:
            break;
        case an_ForwardOneshot:
            if( ++self->iFrame > self->lastFrame )
            {
                *frame = self->iFrame = self->lastFrame;
                self->aDir = an_Stop;
                return false;
            }
            break;
        case an_BackwardOneshot:
            if( --self->iFrame < self->firstFrame )
            {
                *frame = self->iFrame = self->firstFrame;
                self->aDir = an_Stop;
                return false;
            }
            break;
        case an_ForwardLoop:
            if( ++self->iFrame > self->lastFrame )
                self->iFrame = self->firstFrame;
            break;
        case an_BackwardLoop:
            if( --self->iFrame < self->firstFrame )
                self->iFrame = self->lastFrame;
            break;
        case an_ForwardPingPong:
            if( ++self->iFrame > self->lastFrame )
            {
                self->iFrame = self->lastFrame-1;
                self->aDir = an_BackwardPingPong;
            }
            break;
        case an_BackwardPingPong:
            if( --self->iFrame < self->firstFrame )
            {
                self->iFrame = self->firstFrame + 1;
                self->aDir = an_ForwardPingPong;
            }
            break;
        case an_Random:
            self->iFrame = self->firstFrame + (rand() % (1+self->lastFrame-self->firstFrame));
            break;
        }

    }
    *frame = self->iFrame;
    return true;
}

int Animator_init	(	Animator *	self,
		int	firstFrame,
		int	lastFrame,
		Animator_Dir	dir,
		unsigned	msPerFrame
	)

Initialize an animation.

Parameters:

	self	Animation we're cycling
	firstFrame	First frame index in set we're animating
	lastFrame	Last frame index in set we're animating
	dir	Animation type to apply
	msPerFrame	How many milliseconds each frame should be displayed

Returns:

true if Animating, false if 'finished'

Definition at line 106 of file iterator.c.

{
    self->msprev = 0;
    self->msframe = msPerFrame;
    self->firstFrame = firstFrame;
    self->lastFrame = lastFrame;
    self->aDir = dir;
    switch( dir )
    {
        case an_Stop:
        case an_ForwardOneshot:
        case an_ForwardLoop:
        case an_ForwardPingPong:
        case an_Random:
            self->iFrame = firstFrame;
            break;
        case an_BackwardOneshot:
        case an_BackwardLoop:
        case an_BackwardPingPong:
            self->iFrame = lastFrame;
            break;
    }
    return firstFrame;
}

bool Animator_pending

(

const Animator *

self

)

Return true if we're pending a oneshot event.

Parameters:

self

Animation we're cycling

Definition at line 151 of file iterator.c.

{
    if( self->aDir == an_ForwardOneshot )
        return self->iFrame <= self->lastFrame;
    else if( self->aDir == an_BackwardOneshot )
        return self->iFrame >= self->firstFrame;
    return false;
}

int Animator_set	(	Animator *	self,
		int	frame
	)

Set animation to single frame.

Parameters:

	self	Animation we're cycling
	frame	Frame to set

Definition at line 136 of file iterator.c.

{
    self->msprev = 0;
    self->msframe = 0;
    self->aDir = an_Stop;
    self->firstFrame = frame;
    self->lastFrame = frame;
    self->iFrame = frame;
    return frame;
}

bool LinePath_curr	(	const LinePath *	self,
		int *	x,
		int *	y,
		int *	z,
		unsigned	msCurrent
	)

Get current position in space, given time.

Parameters:

	self	Motion we're operating
	x,y,z	A place to put current position
	msCurrent	Current time

Returns:

true if moving or motion pending, false if 'finished' (after msFinish from LinePath_init)

Definition at line 70 of file iterator.c.

Referenced by LinePath_moveto().

{
    if( msCurrent <= self->begin )
    {
        *x = self->x1;
        *y = self->y1;
        *z = self->z1;
        return true;
    }
    else if( msCurrent >= self->end )
    {
        *x = self->x2;
        *y = self->y2;
        *z = self->z2;
        return false;
    }
    else
    {
        int total = (int)(1u + self->end - self->begin);
        int elapsed = (int)(msCurrent - self->begin);
        *x = self->x1 + ((self->x2-self->x1) * elapsed / total);
        *y = self->y1 + ((self->y2-self->y1) * elapsed / total);
        *z = self->z1 + ((self->z2-self->z1) * elapsed / total);
        return true;
    }
}

void LinePath_init	(	LinePath *	self,
		int	x1,
		int	y1,
		int	z1,
		unsigned	msBegin,
		int	x2,
		int	y2,
		int	z2,
		unsigned	msFinish
	)

Initialize linear motion.

Parameters:

	self	Motion we're setting up
	x1,y1,z1	Start position
	msBegin	Start time
	x2,y2,z2	End position
	msFinish	End time

Definition at line 19 of file iterator.c.

{
    self->begin = msBegin;
    self->end = msFinish;
    self->x1 = x1;
    self->y1 = y1;
    self->z1 = z1;
    self->x2 = x2;
    self->y2 = y2;
    self->z2 = z2;
}

void LinePath_moveto	(	LinePath *	self,
		int	x,
		int	y,
		int	z,
		unsigned	msCurrent,
		unsigned	msArrive
	)

Move from current position to target.

Parameters:

	self	Motion we're operating
	x,y,z	A place to set current position
	msCurrent	Current time
	msArrive	Time to arrive

Definition at line 53 of file iterator.c.

References LinePath_curr().

{
    LinePath_curr( self, &self->x1,&self->y1,&self->z1, msCurrent );
    self->begin = msCurrent;
    self->end = msArrive;
    self->x2 = x;
    self->y2 = y;
    self->z2 = z;
}

Here is the call graph for this function:

void LinePath_setpos	(	LinePath *	self,
		int	x,
		int	y,
		int	z,
		unsigned	msCurrent
	)

Set current position in space, now.

Parameters:

	self	Motion we're operating
	x,y,z	A place to set current position
	msCurrent	Current time

Definition at line 37 of file iterator.c.

{
    self->begin = msCurrent;
    self->end = msCurrent;
    self->x2 = self->x1 = x;
    self->y2 = self->y1 = y;
    self->z2 = self->z1 = z;
}