r_mesh.cpp

Go to the documentation of this file.

/*
All original material Copyright (C) 2002-2022 UFO: Alien Invasion.

Copyright (C) 1997-2001 Id Software, Inc.

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, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

#include "r_local.h"
#include "r_lightmap.h"
#include "r_light.h"
#include "r_mesh.h"
#include "r_mesh_anim.h"
#include "r_error.h"
#include "r_draw.h"
#include "../battlescape/cl_particle.h"

static const float MESH_SHADOW_MAX_DISTANCE = 512.0;
static const float MESH_SHADOW_ALPHA = 0.3;

static void R_TransformModelDirect (modelInfo_t* mi)
{
    /* translate and rotate */
    glTranslatef(mi->origin[0], mi->origin[1], mi->origin[2]);

    glRotatef(mi->angles[0], 0, 0, 1);
    glRotatef(mi->angles[1], 0, 1, 0);
    glRotatef(mi->angles[2], 1, 0, 0);

    /* scale by parameters */
    if (mi->scale)
        glScalef(mi->scale[0], mi->scale[1], mi->scale[2]);
    if (mi->center)
        glTranslatef(mi->center[0], mi->center[1], mi->center[2]);
}

static void R_DrawMeshModelShell (const mAliasMesh_t* mesh, const vec4_t color)
{
    /* check whether rgb is set */
    if (!VectorNotEmpty(color))
        return;

    R_Color(color);

    R_BindTexture(r_envmaptextures[1]->texnum);

    R_EnableShell(true);

    glDrawArrays(GL_TRIANGLES, 0, mesh->num_tris * 3);

    refdef.batchCount++;

    R_EnableShell(false);

    R_Color(nullptr);
}

static void R_DrawAliasFrameLerp (mAliasModel_t* mod, mAliasMesh_t* mesh, float backlerp, int framenum, int oldframenum, const vec4_t shellColor)
{
    R_FillArrayData(mod, mesh, backlerp, framenum, oldframenum, false);

    R_EnableAnimation(mesh, backlerp, true);

    glDrawArrays(GL_TRIANGLES, 0, mesh->num_tris * 3);

    refdef.batchCount++;

    R_DrawMeshModelShell(mesh, shellColor);

    R_EnableAnimation(nullptr, 0.0, false);

    R_CheckError();
}

static void R_DrawAliasStatic (const mAliasMesh_t* mesh, const vec4_t shellColor)
{
    R_BindArray(GL_VERTEX_ARRAY, GL_FLOAT, mesh->verts);
    R_BindArray(GL_NORMAL_ARRAY, GL_FLOAT, mesh->normals);
    if (r_state.active_normalmap || r_state.dynamic_lighting_enabled)
        R_BindArray(GL_TANGENT_ARRAY, GL_FLOAT, mesh->tangents);
    R_BindArray(GL_TEXTURE_COORD_ARRAY, GL_FLOAT, mesh->texcoords);

    glDrawArrays(GL_TRIANGLES, 0, mesh->num_tris * 3);

    refdef.batchCount++;

    R_DrawMeshModelShell(mesh, shellColor);
}

static void R_ResetArraysAfterStaticMeshRender (void)
{
    R_BindDefaultArray(GL_VERTEX_ARRAY);
    R_BindDefaultArray(GL_NORMAL_ARRAY);
    if (r_state.active_normalmap || r_state.dynamic_lighting_enabled)
        R_BindDefaultArray(GL_TANGENT_ARRAY);
    R_BindDefaultArray(GL_TEXTURE_COORD_ARRAY);
}

static void R_DrawAliasStaticWithReset (const mAliasMesh_t* mesh, const vec4_t shellColor)
{
    R_DrawAliasStatic(mesh, shellColor);
    R_ResetArraysAfterStaticMeshRender();
}

static void R_ComputeGLMatrixFromTag (float* glMatrix, const mAliasTagOrientation_t* orient)
{
    glMatrix[0] = orient->axis[0][0];
    glMatrix[4] = orient->axis[1][0];
    glMatrix[8] = orient->axis[2][0];
    glMatrix[12] = orient->origin[0];

    glMatrix[1] = orient->axis[0][1];
    glMatrix[5] = orient->axis[1][1];
    glMatrix[9] = orient->axis[2][1];
    glMatrix[13] = orient->origin[1];

    glMatrix[2] = orient->axis[0][2];
    glMatrix[6] = orient->axis[1][2];
    glMatrix[10] = orient->axis[2][2];
    glMatrix[14] = orient->origin[2];

    glMatrix[3] = 0;
    glMatrix[7] = 0;
    glMatrix[11] = 0;
    glMatrix[15] = 1;
}

#define R_GetTagOrientByFrame(mod, tagIndex, frame) &(((mod)->alias.tags)[tagIndex].orient[frame])

void R_GetTags (const model_t* mod, const char* tagName, int currentFrame, int oldFrame, const mAliasTagOrientation_t** current, const mAliasTagOrientation_t** old)
{
    const int index = R_GetTagIndexByName(mod, tagName);
    if (index == -1) {
        *current = nullptr;
        *old = nullptr;
        Com_Printf("Could not get tags for tag %s of model %s\n", tagName, mod->name);
        return;
    }
    *current = R_GetTagOrientByFrame(mod, index, currentFrame);
    *old = R_GetTagOrientByFrame(mod, index, oldFrame);
}

bool R_GetTagMatrix (const model_t* mod, const char* tagName, int frame, float matrix[16])
{
    const int index = R_GetTagIndexByName(mod, tagName);
    mAliasTagOrientation_t* orient;

    if (index == -1) {
        Com_Printf("Could not get tag matrix for tag %s of model %s\n", tagName, mod->name);
        return false;
    }

    orient = R_GetTagOrientByFrame(mod, index, frame);
    R_ComputeGLMatrixFromTag(matrix, orient);
    return true;
}

void R_InterpolateTransform (float backLerp, int numframes, const mAliasTagOrientation_t* current, const mAliasTagOrientation_t* old, float* interpolated)
{
    /* right on a frame? */
    if (backLerp == 0.0) {
        R_ComputeGLMatrixFromTag(interpolated, current);
        return;
    }
    if (backLerp == 1.0) {
        R_ComputeGLMatrixFromTag(interpolated, old);
        return;
    }

    mAliasTagOrientation_t tag;
    const float frontLerp = 1.0 - backLerp;

    /* interpolate */
    for (int i = 0; i < 3; i++) {
        tag.origin[i] = old->origin[i] * backLerp + current->origin[i] * frontLerp;
        tag.axis[0][i] = old->axis[0][i] * backLerp + current->axis[0][i] * frontLerp;
        tag.axis[1][i] = old->axis[1][i] * backLerp + current->axis[1][i] * frontLerp;
        tag.axis[2][i] = old->axis[2][i] * backLerp + current->axis[2][i] * frontLerp;
    }
    VectorNormalizeFast(tag.axis[0]);
    VectorNormalizeFast(tag.axis[1]);
    VectorNormalizeFast(tag.axis[2]);

    R_ComputeGLMatrixFromTag(interpolated, &tag);
}

int R_GetTagIndexByName (const model_t* mod, const char* tagName)
{
    if (!mod)
        return -1;

    if (mod->alias.num_tags == 0)
        return -1;

    assert(tagName);

    /* find the right tag in the first frame - the index is the same in every other frame */
    for (int i = 0; i < mod->alias.num_tags; i++) {
        const mAliasTag_t* tag = &mod->alias.tags[i];
        if (Q_streq(tag->name, tagName)) {
            return i;
        }
    }

    return -1;
}

void R_ModelAutoScale (const vec2_t boxSize, modelInfo_t* mi, vec3_t scale, vec3_t center)
{
    const float width = mi->model->modBox.getWidthX();
    const float height = mi->model->modBox.getWidthZ();
    const float factorX = boxSize[0] / width;
    const float factorY = boxSize[1] / height;
    const float size = std::min(factorX, factorY);

    /* get center */
    mi->model->modBox.getCenter(center);
    VectorNegate(center, center);
    VectorSet(scale, size, size, size);

    mi->center = center;
    mi->scale = scale;
}

void R_DrawModelDirect (modelInfo_t* mi, modelInfo_t* pmi, const char* tagname)
{
    image_t* skin;
    mAliasMesh_t* mesh;

    if (Q_strnull(mi->name))
        return;

    /* register the model */
    mi->model = R_FindModel(mi->name);

    /* check if the model exists */
    if (!mi->model) {
        Com_Printf("No model found for '%s'\n", mi->name);
        return;
    }

    /* not yet fully loaded, so skip the rendering */
    if (!mi->model->loaded)
        return;

    skin = R_AliasModelState(mi->model, &mi->mesh, &mi->frame, &mi->oldframe, &mi->skin);
    if (skin == nullptr) {
        Com_Printf("Model '%s' is broken\n", mi->name);
        return;
    }

    glPushMatrix();
    glScalef(viddef.rx, viddef.ry, (viddef.rx + viddef.ry) / 2);

    R_Color(mi->color);

    if (pmi) {
        /* register the parent model */
        pmi->model = R_FindModel(pmi->name);

        /* transform - the next transform for the child model will be relative from the
         * parent model location now */
        R_TransformModelDirect(pmi);

        /* tag transformation */
        if (tagname) {
            const mAliasTagOrientation_t* current = nullptr;
            const mAliasTagOrientation_t* old = nullptr;
            R_GetTags(pmi->model, tagname, pmi->frame, pmi->oldframe, &current, &old);
            if (current != nullptr && old != nullptr) {
                float interpolated[16];

                /* do interpolation */
                R_InterpolateTransform(pmi->backlerp, pmi->model->alias.num_frames, current, old, interpolated);

                /* transform */
                glMultMatrixf(interpolated);
                R_CheckError();
            }
        }
    }

    /* transform */
    R_TransformModelDirect(mi);

    /* we have to reenable this here - we are in 2d mode here already */
    glEnable(GL_DEPTH_TEST);

    /* draw it */
    R_BindTexture(skin->texnum);

    /* draw the model */
    mesh = &mi->model->alias.meshes[0];
    refdef.aliasCount += mesh->num_tris;
    if (mi->model->alias.num_frames == 1)
        R_DrawAliasStaticWithReset(mesh, vec4_origin);
    else
        R_DrawAliasFrameLerp(&mi->model->alias, mesh, mi->backlerp, mi->frame, mi->oldframe, vec4_origin);

    /* show model bounding box */
    if (r_showbox->integer)
        R_DrawBoundingBox(mi->model->alias.frames[mi->frame].fBox);

    glDisable(GL_DEPTH_TEST);

    glPopMatrix();

    R_Color(nullptr);
}

void R_DrawModelParticle (modelInfo_t* mi)
{
    image_t* skin;
    mAliasMesh_t* mesh;

    /* check if the model exists */
    if (!mi->model || !mi->model->loaded)
        return;

    skin = R_AliasModelState(mi->model, &mi->mesh, &mi->frame, &mi->oldframe, &mi->skin);
    if (skin == nullptr) {
        Com_Printf("Model '%s' is broken\n", mi->name);
        return;
    }

    R_Color(mi->color);

    glPushMatrix();

    glTranslatef(mi->origin[0], mi->origin[1], mi->origin[2]);
    glRotatef(mi->angles[YAW], 0, 0, 1);
    glRotatef(mi->angles[PITCH], 0, 1, 0);
    glRotatef(-mi->angles[ROLL], 1, 0, 0);

    /* draw it */
    R_BindTexture(skin->texnum);

    /* draw the model */
    mesh = &mi->model->alias.meshes[0];
    refdef.aliasCount += mesh->num_tris;
    if (mi->model->alias.num_frames == 1)
        R_DrawAliasStaticWithReset(mesh, vec4_origin);
    else
        R_DrawAliasFrameLerp(&mi->model->alias, mesh, mi->backlerp, mi->frame, mi->oldframe, vec4_origin);

    /* show model bounding box */
    if (r_showbox->integer)
        R_DrawBoundingBox(mi->model->alias.frames[mi->frame].fBox);

    glPopMatrix();

    R_Color(nullptr);
}

bool R_CullMeshModel (const entity_t* e)
{
    int i;
    uint32_t aggregatemask;
    vec3_t mins, maxs, origin, angles;
    vec3_t vectors[3];
    vec4_t bbox[8];

    /* this is an approximation of the origin of the tagged model - we are
     * using the origin of the parent entity to check the culling for the model
     * that is placed relative to the tag */
    if (e->tagent) {
        VectorCopy(e->tagent->origin, origin);
        VectorCopy(e->tagent->angles, angles);
    } else {
        VectorCopy(e->origin, origin);
        VectorCopy(e->angles, angles);
    }

    /* determine scaled mins/maxs */
    for (i = 0; i < 3; i++) {
        if (e->scale[i]) {
            mins[i] = e->model->modBox.mins[i] * e->scale[i];
            maxs[i] = e->model->modBox.maxs[i] * e->scale[i];
        } else {
            mins[i] = e->model->modBox.mins[i];
            maxs[i] = e->model->modBox.maxs[i];
        }
    }

    /* rotate the bounding box */
    angles[YAW] = -angles[YAW];
    AngleVectors(angles, vectors[0], vectors[1], vectors[2]);

    /* compute translated and rotate bounding box */
    for (i = 0; i < 8; i++) {
        vec3_t tmp;

        tmp[0] = (i & 1) ? mins[0] : maxs[0];
        tmp[1] = (i & 2) ? mins[1] : maxs[1];
        tmp[2] = (i & 4) ? mins[2] : maxs[2];

        bbox[i][0] = DotProduct(vectors[0], tmp);
        bbox[i][1] = -DotProduct(vectors[1], tmp);
        bbox[i][2] = DotProduct(vectors[2], tmp);

        VectorAdd(origin, bbox[i], bbox[i]);
    }

    /* compute a full bounding box */
    aggregatemask = ~0;

    for (i = 0; i < 8; i++) {
        int mask = 0;
        const int size = lengthof(r_locals.frustum);

        for (int j = 0; j < size; j++) {
            const cBspPlane_t* bspPlane = &r_locals.frustum[j];
            /* get the distance between the frustum normal vector and the
             * current vector of the bounding box */
            const float f = DotProduct(bspPlane->normal, bbox[i]);
            if (f - bspPlane->dist < 0)
                mask |= (1 << j);
        }

        aggregatemask &= mask;
    }

    if (aggregatemask)
        return true;

    return false;
}

static mAliasMesh_t* R_GetLevelOfDetailForModel (const vec3_t origin, const mAliasModel_t* mod)
{
    if (mod->num_meshes == 1 || (refdef.rendererFlags & RDF_NOWORLDMODEL)) {
        return &mod->meshes[0];
    } else {
        vec3_t dist;
        vec_t length;

        /* get distance, set lod if available */
        VectorSubtract(refdef.viewOrigin, origin, dist);
        length = VectorLength(dist);
        if (mod->num_meshes > 3 && length > 700) {
            return &mod->meshes[3];
        } if (mod->num_meshes > 2 && length > 600) {
            return &mod->meshes[2];
        } else if (length > 500) {
            return &mod->meshes[1];
        }

        return &mod->meshes[0];
    }
}

static void R_DrawAliasTags (const mAliasModel_t* mod)
{
    const uint32_t color[] = {0xFF0000FF, 0xFF00FF00, 0xFFFF0000};
    glEnable(GL_LINE_SMOOTH);
    R_EnableTexture(&texunit_diffuse, false);
    R_EnableColorArray(true);

    for (int i = 0; i < mod->num_tags; i++) {
        const mAliasTag_t* tag = &mod->tags[i];
        for (int j = 0; j < 3; j++) {
            vec3_t out;
            const mAliasTagOrientation_t* o = &tag->orient[mod->curFrame];
            VectorMA(o->origin, 5, o->axis[j], out);
            const vec3_t points[] = { { o->origin[0], o->origin[1], o->origin[2] }, { out[0], out[1], out[2] } };
            GLbyte colorArray[8];

            memcpy(&colorArray[0], &color[j], 4);
            memcpy(&colorArray[4], &color[j], 4);

            R_BindArray(GL_COLOR_ARRAY, GL_UNSIGNED_BYTE, colorArray);
            R_BindArray(GL_VERTEX_ARRAY, GL_FLOAT, points);
            glDrawArrays(GL_LINE_STRIP, 0, 2);

            refdef.batchCount++;
        }
    }

    /* restore default array bindings */
    R_BindDefaultArray(GL_COLOR_ARRAY);
    R_BindDefaultArray(GL_VERTEX_ARRAY);

    R_EnableColorArray(false);
    R_EnableTexture(&texunit_diffuse, true);
    glDisable(GL_LINE_SMOOTH);
}

static mAliasMesh_t* R_DrawAliasModelBuffer (entity_t* e)
{
    mAliasModel_t* mod = &e->model->alias;
    mAliasMesh_t* lodMesh;

    R_ResetArrayState();

    lodMesh = R_GetLevelOfDetailForModel(e->origin, mod);
    refdef.aliasCount += lodMesh->num_tris;
    if (mod->num_frames == 1)
        R_DrawAliasStatic(lodMesh, e->shell);
    else
        R_DrawAliasFrameLerp(mod, lodMesh, e->as.backlerp, e->as.frame, e->as.oldframe, e->shell);

    if (r_drawtags->integer) {
        R_DrawAliasTags(mod);
    }

    return lodMesh;
}

static bool R_UpdateShadowOrigin (entity_t* e)
{
    vec3_t start, end;

    if (e->lighting == nullptr)
        return false;

    if (e->lighting->lastShadowedFrame == r_locals.frame)
        return true;

    VectorCopy(e->origin, start);
    VectorCopy(e->origin, end);

    end[2] = start[2] - MESH_SHADOW_MAX_DISTANCE;

    /* do the trace */
    R_Trace(Line(start, end), 0.0, MASK_SOLID);

    /* resolve the shadow origin and direction */
    if (refdef.trace.leafnum) {
        /* hit something */
        VectorCopy(refdef.trace.endpos, e->lighting->shadowOrigin);
        e->lighting->lastShadowedFrame = r_locals.frame;
        return true;
    }

    return false;
}

static void R_RotateForMeshShadow (const entity_t* e)
{
    if (!e) {
        glPopMatrix();
    } else {
        vec3_t origin;
        float height;

        R_TransformForEntity(e, e->lighting->shadowOrigin, origin);

        height = -origin[2];

        glPushMatrix();
        glTranslatef(0, 0, -height + 1.0);
        glRotatef(-e->angles[PITCH], 0.0, 1.0, 0.0);
        glScalef(1.0, 1.0, 0.0);
    }
}

static void R_DrawMeshShadow (entity_t* e, const mAliasMesh_t* mesh)
{
    vec4_t color;
    const bool oldBlend = r_state.blend_enabled;
    const bool lighting = r_state.lighting_enabled;
    r_program_t* program = r_state.active_program;

    if (!r_stencilshadows->integer)
        return;

    if (!r_shadows->value)
        return;

    if (r_wire->integer)
        return;

    if (e->flags & RF_NO_SHADOW)
        return;

    if (e->flags & RF_TRANSLUCENT)
        return;

    if (!R_UpdateShadowOrigin(e))
        return;

    if (e->lighting->shadowOrigin[2] > refdef.viewOrigin[2])
        return;

    Vector4Set(color, 0.0, 0.0, 0.0, r_shadows->value * MESH_SHADOW_ALPHA);
    R_Color(color);
    R_EnableTexture(&texunit_diffuse, false);
    R_EnableBlend(true);
    R_RotateForMeshShadow(e);
    R_EnableStencilTest(true);

    if (lighting)
        R_EnableLighting(nullptr, false);
    glDrawArrays(GL_TRIANGLES, 0, mesh->num_tris * 3);
    refdef.batchCount++;
    if (lighting)
        R_EnableLighting(program, true);

    R_EnableStencilTest(false);
    R_RotateForMeshShadow(nullptr);
    R_EnableBlend(oldBlend);
    R_EnableTexture(&texunit_diffuse, true);
    R_Color(nullptr);
}

void R_DrawAliasModel (entity_t* e)
{
    if (!e->model->loaded)
        return;
    mAliasModel_t* mod = &e->model->alias;
    /* the values are sane here already - see R_GetEntityLists */
    const image_t* skin = mod->meshes[e->as.mesh].skins[e->skinnum].skin;
    int i;
    float g;
    vec4_t color = {0.8, 0.8, 0.8, 1.0};
    mAliasMesh_t* mesh;

    /* IR goggles override color for entities that are affected */
    if ((refdef.rendererFlags & RDF_IRGOGGLES) && (e->flags & RF_IRGOGGLES))
        Vector4Set(e->shell, 1.0, 0.3, 0.3, 1.0);

    if (e->flags & RF_PULSE) {  /* and then adding in a pulse */
        const float f = 1.0 + sin((refdef.time + (e->model->alias.meshes[0].num_tris)) * 6.0) * 0.33;
        VectorScale(color, 1.0 + f, color);
    }

    g = 0.0;
    /* find brightest component */
    for (i = 0; i < 3; i++) {
        if (color[i] > g)  /* keep it */
            g = color[i];
    }

    /* scale it back to 1.0 */
    if (g > 1.0)
        VectorScale(color, 1.0 / g, color);

    R_Color(color);

    assert(skin->texnum > 0);
    R_BindTexture(skin->texnum);

    R_EnableGlowMap(skin->glowmap);

    R_UpdateLightList(e);
    R_EnableModelLights(e->lighting->lights, e->lighting->numLights, e->lighting->inShadow, true);

    if (r_debug_lights->integer) {
        for (i = 0; i < e->lighting->numLights && i < r_dynamic_lights->integer; i++)
            CL_ParticleSpawn("lightTracerDebug", 0, e->transform.matrix + 12, e->lighting->lights[i]->origin);
    }

    if (skin->normalmap)
        R_EnableBumpmap(skin->normalmap);

    if (skin->specularmap)
        R_EnableSpecularMap(skin->specularmap, true);

    if (skin->roughnessmap)
        R_EnableRoughnessMap(skin->roughnessmap, true);

    glPushMatrix();
    glMultMatrixf(e->transform.matrix);

    if (VectorNotEmpty(e->scale))
        glScalef(e->scale[0], e->scale[1], e->scale[2]);

    mesh = R_DrawAliasModelBuffer(e);

    if (r_state.specularmap_enabled)
        R_EnableSpecularMap(nullptr, false);

    if (r_state.roughnessmap_enabled)
        R_EnableRoughnessMap(nullptr, false);

    R_EnableModelLights(nullptr, 0, false, false);

    R_EnableGlowMap(nullptr);

    if (r_state.active_normalmap)
        R_EnableBumpmap(nullptr);

    R_DrawMeshShadow(e, mesh);

    if (mod->num_frames == 1)
        R_ResetArraysAfterStaticMeshRender();

    glPopMatrix();

    /* show model bounding box */
    if (r_showbox->integer)
        R_DrawBoundingBox(mod->frames[e->as.frame].fBox);

    R_Color(nullptr);
}