anim.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Object animation definitions
 */

#ifndef TINSEL_ANIM_H     // prevent multiple includes
#define TINSEL_ANIM_H

#include "tinsel/dw.h"  // for SCNHANDLE

namespace Tinsel {

struct OBJECT;

struct ANIM {
    int aniRate;        
    int aniDelta;       
    OBJECT *pObject;    
    uint32 hScript;     
    int scriptIndex;    
};

enum {
    ANI_END         = 0,    
    ANI_JUMP        = 1,    
    ANI_HFLIP       = 2,    
    ANI_VFLIP       = 3,    
    ANI_HVFLIP      = 4,    
    ANI_ADJUSTX     = 5,    
    ANI_ADJUSTY     = 6,    
    ANI_ADJUSTXY    = 7,    
    ANI_NOSLEEP     = 8,    
    ANI_CALL        = 9,    
    ANI_HIDE        = 10,   
    ANI_STOP        = 11    
};

union ANI_SCRIPT {
    int32 op;           
    uint32 hFrame;      
};


/*----------------------------------------------------------------------*\
|*          Anim Function Prototypes            *|
\*----------------------------------------------------------------------*/

enum SCRIPTSTATE {ScriptFinished, ScriptNoSleep, ScriptSleep};

SCRIPTSTATE DoNextFrame(    // Execute the next animation frame of a animation script
    ANIM *pAnim);       // animation data structure

void InitStepAnimScript(    // Init a ANIM struct for single stepping through a animation script
    ANIM *pAnim,        // animation data structure
    OBJECT *pAniObj,    // object to animate
    SCNHANDLE hNewScript,   // handle to script of multipart frames
    int aniSpeed);      // sets speed of animation in frames

SCRIPTSTATE StepAnimScript( // Execute the next command in a animation script
    ANIM *pAnim);       // animation data structure

void SkipFrames(        // Skip the specified number of frames
    ANIM *pAnim,        // animation data structure
    int numFrames);     // number of frames to skip

bool AboutToJumpOrEnd(ANIM *pAnim);

} // End of namespace Tinsel

#endif      // TINSEL_ANIM_H