/* DE1: $Id: r_things.h 2859 2006-02-18 20:18:07Z danij $
 * Copyright (C) 2003, 2004 Jaakko Keränen <jaakko.keranen@iki.fi>
 *
 * 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 2 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: http://www.opensource.org/
 *
 * Based on Hexen by Raven Software.
 */

/*
 * r_things.h: Object Management and Refresh
 */

#ifndef __DOOMSDAY_REFRESH_THINGS_H__
#define __DOOMSDAY_REFRESH_THINGS_H__

#include "p_data.h"
#include "r_data.h"

#define MAXVISSPRITES   8192

// These constants are used as the type of vissprite_s.
enum {
    VSPR_MASKED_WALL,
    VSPR_MAP_OBJECT,
    VSPR_HUD_MODEL,
    VSPR_SKY_MODEL,
    VSPR_PARTICLE_MODEL
};

// A vissprite_t is a thing or masked wall that will be drawn during
// a refresh.
typedef struct vissprite_s {
    struct vissprite_s *prev, *next;
    byte            type;          // True if this is a sprite (otherwise a wall segment).
    float           distance;      // Vissprites are sorted by distance.

    // An anonymous union for the data.
    union vissprite_data_u {
        struct vissprite_mobj_s {
            int             patch;
            subsector_t    *subsector;
            fixed_t         gx, gy; // for line side calculation
            fixed_t         gz, gzt;    // global bottom / top for silhouette clipping
            boolean         flip;  // Flip texture?
            float           v1[2], v2[2];   // The vertices (v1 is the left one).
            int             flags; // for color translation and shadow draw
            uint            id;
            int             selector;
            int             class; // player class (used in translation)
            fixed_t         floorclip;
            boolean         viewaligned;    // Align to view plane.
            float           secfloor, secceil;
            boolean         hasglow;
            byte            floorglow[3];   // Floor glow color.
            byte            ceilglow[3];    // Ceiling glow color.
            float           floorglowamount;
            float           ceilglowamount;
            byte            rgb[3]; // Sector light color.
            int             lightlevel;
            float           alpha;
            float           visoff[3];  // Last-minute offset to coords.
            struct modeldef_s *mf, *nextmf;
            float           yaw, pitch; // For models.
            float           inter; // Frame interpolation, 0..1
            struct lumobj_s *light; // For the halo (NULL if no halo).
            boolean         flooradjust; // Allow moving sprite to match visible floor.
        } mo;
        struct vissprite_wall_s {
            int             texture;
            boolean         masked;
            float           top;   // Top and bottom height.
            float           bottom;
            blendmode_t     blendmode; // Blendmode to be used when drawing
                                       // (two sided mid textures only)
            struct vissprite_wall_vertex_s {
                float           pos[2]; // x and y coordinates.
                unsigned char   color[4];
            } vertices[2];
            float           texc[2][2]; // u and v coordinates.
            struct dynlight_s *light;
        } wall;
    } data;
} vissprite_t;

// Sprites are patches with a special naming convention so they can be
// recognized by R_InitSprites.  The sprite and frame specified by a
// thing_t is range checked at run time.

// a sprite is a patch_t that is assumed to represent a three dimensional
// object and may have multiple rotations pre drawn.  Horizontal flipping
// is used to save space. Some sprites will only have one picture used
// for all views.

typedef struct {
    boolean         rotate;        // if false use 0 for any position
    int             lump[8];       // sprite lump to use for view angles 0-7
    byte            flip[8];       // flip (1 = flip) to use for view angles 0-7
} spriteframe_t;

typedef struct {
    int             numframes;
    spriteframe_t  *spriteframes;
} spritedef_t;

typedef struct {
    int             lump;          // Real lump number.
    short           width;
    short           height;
    short           offset;
    short           topoffset;
    float           flarex;        // Offset to flare.
    float           flarey;
    float           lumsize;
    float           tc[2][2];      // Prepared texture coordinates.
    DGLuint         tex;           // Name of the associated DGL texture.
    DGLuint         hudtex;        // Name of the HUD sprite texture.
    rgbcol_t        color;         // Average color, for lighting.
} spritelump_t;

extern spritedef_t *sprites;
extern int      numsprites;
extern spritelump_t *spritelumps;
extern int      numspritelumps;
extern int      pspOffX, pspOffY;
extern int      alwaysAlign;
extern float    weaponOffsetScale, weaponFOVShift;
extern int      weaponOffsetScaleY;
extern float    modelSpinSpeed;
extern int      r_maxmodelz, r_nospritez;
extern int      r_use_srvo, r_use_srvo_angle;
extern vissprite_t vissprites[MAXVISSPRITES], *vissprite_p;
extern vissprite_t vispsprites[DDMAXPSPRITES];
extern vissprite_t vsprsortedhead;

void            R_GetSpriteInfo(int sprite, int frame, spriteinfo_t *sprinfo);
void            R_GetPatchInfo(int lump, spriteinfo_t *info);
int             R_VisualRadius(struct mobj_s *mo);
fixed_t         R_GetBobOffset(struct mobj_s *mo);
float           R_MovementYaw(fixed_t momx, fixed_t momy);
float           R_MovementPitch(fixed_t momx, fixed_t momy, fixed_t momz);
void            R_ProjectSprite(struct mobj_s *thing);
void            R_ProjectPlayerSprites(void);
void            R_ProjectDecoration(struct mobj_s *source);
void            R_SortVisSprites(void);
void            R_AddSprites(sector_t *sec);
void            R_AddPSprites(void);
void            R_DrawSprites(void);
void            R_InitSprites(void);
void            R_ClearSprites(void);

void            R_ClipVisSprite(vissprite_t * vis, int xl, int xh);

#endif