render_model.h

Go to the documentation of this file.

// render_model [mode] - Tag Definition              //
// --------                                         //
// Author: haloman30                               //
// Revision: 8                                    //
// --------                                      //
// Part of the Blamite Game Engine              //
// Copyright (c) Elaztek Studios 2013 - 2023   //
 
 
#pragma once
 
#include <string>
#include <blam/api/v1/types/tags.h>
#include <blam/api/v1/types/plugins.h>
 
#ifndef BLAM
#define BLAM
#endif
 
#define tag_mode "mode"
 
 
 
#pragma pack(push, 1)
struct render_model
{
    data_reference name; 
    struct bitfield16_flags
    {
        bool use_bounding_sphere : 1;
        bool auto_generate_bounds : 1;
        bool pad_bounding_box : 1;
        bool infinite_bounds : 1;
        bool unused4 : 1;
        bool unused5 : 1;
        bool unused6 : 1;
        bool unused7 : 1;
        bool unused8 : 1;
        bool unused9 : 1;
        bool unused10 : 1;
        bool unused11 : 1;
        bool unused12 : 1;
        bool unused13 : 1;
        bool unused14 : 1;
        bool unused15 : 1;
    };
 
    bitfield16_flags flags; 
    real bounding_sphere_radius;
    vector3 default_scale_modifier;
    TAG_BLOCK(materials,
    {
        tag_reference material;
        TAG_BLOCK(parameters,
        {
        });
        int32_t imported_material_index;
    });
    TAG_BLOCK(errors,
    {
        TAG_ENUM8(report_type,
        {
            comment,
            warning,
            error,
        });
 
        struct bitfield16_flags
        {
            bool rendered : 1;
            bool unused1 : 1;
            bool unused2 : 1;
            bool unused3 : 1;
            bool unused4 : 1;
            bool unused5 : 1;
            bool unused6 : 1;
            bool unused7 : 1;
            bool unused8 : 1;
            bool unused9 : 1;
            bool unused10 : 1;
            bool unused11 : 1;
            bool unused12 : 1;
            bool unused13 : 1;
            bool unused14 : 1;
            bool unused15 : 1;
        };
 
        bitfield16_flags flags; 
        data_reference text;
    });
    TAG_BLOCK(meshes,
    {
        data_reference name;
        struct bitfield16_flags
        {
            bool uses_32_bit_indices : 1;
            bool has_normals : 1;
            bool has_tangents : 1;
            bool unused3 : 1;
            bool unused4 : 1;
            bool unused5 : 1;
            bool unused6 : 1;
            bool unused7 : 1;
            bool unused8 : 1;
            bool unused9 : 1;
            bool unused10 : 1;
            bool unused11 : 1;
            bool unused12 : 1;
            bool unused13 : 1;
            bool unused14 : 1;
            bool unused15 : 1;
        };
 
        bitfield16_flags flags; 
        int32_t material_index;
        data_reference vertex_data;
        data_reference triangles_data;
        int8_t vertex_color_channels;
        int8_t uv_channels;
        vector3 extents_min;
        vector3 extents_max;
    });
    TAG_BLOCK(import_info,
    {
        int64_t source_filesize;
        data_reference source_filename;
        data_reference source_file_format;
    });
};
#pragma pack(pop)
 
class RenderModelTagClass : public BlamTagClass
{
public:
    RenderModelTagClass()
    {
        class_name_long = "render_model";
        class_name_short = "mode";
        version = 8;
 
        revisions = {
            {1, "haloman30", "Initial implementation."},
            {2, "haloman30", "Vertex data, triangle data, and texture coordinates are now stored as datarefs instead of tag blocks - in order to reduce filesize of decompiled tags"},
            {3, "haloman30", "* Added flags bitfield and material index to meshes block"},
            {4, "haloman30", "* Added a couple comments\n\n            * Added AABB min/max vectors to meshes block"},
            {5, "haloman30", "* Removed UVs block, as UV data is now stored with vertex data\n\n            * Added vertex color/UV channels fields"},
            {6, "haloman30", "* Added tangents/bitangents datarefs to meshes block"},
            {7, "haloman30", "* Added support for default scale modifier"},
            {8, "haloman30", "* Add support for shader [rmsh] tags"},
 
        };
 
        tag_size = 178;
 
        fields =
        {
            new DataReferenceField("name", "The name of the model"),
            new Bitfield16Field("flags", "",
            {
                "use bounding sphere instead of combined aabb",
                "automatically generate bounds at runtime",
                "add padding to bounding box",
                "infinite bounds",
            }),
            new RealField("bounding sphere radius", ""),
            new Vector3Field("default scale modifier", ""),
            new BlockField(68, "materials", "",
            {
                new TagReferenceField("material", "", { "mat""rmsh""rmsp"}),
                new BlockField(0, "parameters", "",
                {
                }),
                new Int32Field("imported material index", ""),
            }),
            new CommentField("Render Geometry",
            "All fields below should not be modified directly. This data is automatically updated when importing (or re-importing) a 3D model. As such, any changes made will be lost if the model is re-imported."),
            new BlockField(35, "errors", "",
            {
                new Enum8Field("report type", "",
                {
                    "comment",
                    "warning",
                    "error",
                }),
                new Bitfield16Field("flags", "",
                {
                    "rendered",
                }),
                new DataReferenceField("text", ""),
            }),
            new BlockField(128, "meshes", "",
            {
                new DataReferenceField("name", ""),
                new Bitfield16Field("flags", "",
                {
                    "uses 32-bit indices",
                    "has normals",
                    "has tangents",
                }),
                new Int32Field("material index", ""),
                new DataReferenceField("vertex data", ""),
                new DataReferenceField("triangles data", ""),
                new Int8Field("vertex color channels", ""),
                new Int8Field("uv channels", ""),
                new CommentField("Axis-Aligned Bounding Box (AABB) Extents",
                ""),
                new Vector3Field("extents min", ""),
                new Vector3Field("extents max", ""),
            }),
            new BlockField(72, "import info", "",
            {
                new Int64Field("source filesize", ""),
                new DataReferenceField("source filename", ""),
                new DataReferenceField("source file format", ""),
            }),
 
        };
    }
};
 
namespace Blam::Content::Tags
{
    BLAM render_model* GetRenderModelTag(std::string tag_path);
}