scene.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/>.
 *
 * Scene parsing defines
 */

#ifndef TINSEL_SCENE_H
#define TINSEL_SCENE_H

#include "tinsel/dw.h"
#include "tinsel/events.h"

namespace Tinsel {

enum {
    MAX_NODES       = 32,   
    MAX_NOSCROLL    = 16,   
    MAX_ENTRANCE    = 25,   
    MAX_POLY        = 256,  
    MAX_ACTOR       = 32    
};

// ENTRANCE_STRUC bitflags
enum ENTRANCE_FLAGS {
    fCall = 0x00000001L,
    fHook = 0x00000002L
};

enum REFTYPE {
    REF_DEFAULT, REF_UP, REF_DOWN, REF_LEFT, REF_RIGHT, REF_POINT
};

enum TFTYPE {
    TF_NONE, TF_UP, TF_DOWN, TF_LEFT, TF_RIGHT, TF_FILM
};

enum MASK_TYPE{
    ACT_DEFAULT,
    ACT_MASK = -1,
    ACT_ALWAYS = -2
};

enum SCALE {
    SCALE_DEFAULT, SCALE_LARGE, SCALE_MEDIUM, SCALE_SMALL,
    SCALE_COMPACT, SCALE_TINY,
    SCALE_AUX1, SCALE_AUX2, SCALE_AUX3,
    SCALE_AUX4, SCALE_AUX5
};

enum REEL {
    REEL_DEFAULT, REEL_ALL, REEL_HORIZ, REEL_VERT
};

typedef enum { TRANS_DEF, TRANS_CUT, TRANS_FADE } TRANSITS;

// amount to shift scene handles by
#define SCNHANDLE_SHIFT (((TinselVersion >= 2) && !TinselV2Demo) ? 25 : 23)
#define OFFSETMASK (((TinselVersion >= 2) && !TinselV2Demo) ? 0x01ffffffL : 0x007fffffL)
#define HANDLEMASK (((TinselVersion >= 2) && !TinselV2Demo) ? 0xFE000000L : 0xFF800000L)

void DoHailScene(SCNHANDLE scene);

void WrapScene();

void StartNewScene(SCNHANDLE scene, int entry);

void EndScene();

void SendSceneTinselProcess(TINSEL_EVENT event);

void SetView(int id, int scale);

} // End of namespace Tinsel

#endif  // TINSEL_SCENE_H