AnimModel.h

Go to the documentation of this file.

#pragma once
 
#include <graphics/Model.h>
#include <graphics/ModelResourceMgr.h>
#include <graphics/Renderer.h>
#include <graphics/SkeletalAnimation.h>
#include <graphics/TexturePatternAnimation.h>
#include <graphics/ShaderParamAnimation.h>
#include <graphics/VisibilityAnimation.h>
#include <graphics/ShapeAnimation.h>
 
#include <container/seadBuffer.h>
#include <container/seadPtrArray.h>
#include <heap/seadHeap.h>
 
class ModelResource;
 
class AnimModel
{
public:
    static AnimModel* create(
        ModelResource* mdl_res,
        Model* model,
        s32 skl_anim_num, s32 tex_anim_num, s32 shu_anim_num, s32 vis_anim_num, s32 sha_anim_num,
        sead::Heap* heap = nullptr,
        const sead::PtrArray<ModelResource>* anim_mdl_res_array = nullptr
    );
 
    static AnimModel* create(
        ModelResource* mdl_res,
        const sead::SafeString& name,
        s32 skl_anim_num, s32 tex_anim_num, s32 shu_anim_num, s32 vis_anim_num, s32 sha_anim_num,
        Model::BoundingMode bounding_mode = Model::cBoundingMode_Disable,
        sead::Heap* heap = nullptr,
        const sead::PtrArray<ModelResource>* anim_mdl_res_array = nullptr
    );
 
    static AnimModel* create(
        ModelResource* mdl_res,
        const sead::SafeString& name,
        s32 view_num,
        s32 skl_anim_num, s32 tex_anim_num, s32 shu_anim_num, s32 vis_anim_num, s32 sha_anim_num,
        Model::BoundingMode bounding_mode,
        sead::Heap* heap = nullptr,
        const sead::PtrArray<ModelResource>* anim_mdl_res_array = nullptr
    );
 
    static AnimModel* create(
        const sead::SafeString& resource_key,
        const sead::SafeString& name,
        s32 skl_anim_num = 0, s32 tex_anim_num = 0, s32 shu_anim_num = 0, s32 vis_anim_num = 0, s32 sha_anim_num = 0,
        Model::BoundingMode bounding_mode = Model::cBoundingMode_Disable,
        sead::Heap* heap = nullptr,
        const sead::PtrArray<ModelResource>* anim_mdl_res_array = nullptr
    );
 
    static AnimModel* create(
        const sead::SafeString& resource_key,
        const sead::SafeString& name,
        s32 view_num,
        s32 skl_anim_num, s32 tex_anim_num, s32 shu_anim_num, s32 vis_anim_num, s32 sha_anim_num,
        Model::BoundingMode bounding_mode,
        sead::Heap* heap = nullptr,
        const sead::PtrArray<ModelResource>* anim_mdl_res_array = nullptr
    );
 
    static void destroy(
        AnimModel*& anim_model
    );
 
public:
    // Address: 0x024D4798
    AnimModel(Model* model, s32 skl_anim_num, s32 tex_anim_num, s32 shu_anim_num, s32 vis_anim_num, s32 sha_anim_num);
 
    Model* getModel() const { return mModel; }
    ModelResource* getModelResource() const { return mModelResource; }
 
    void draw() const { Renderer::instance()->drawModel(this); }
    void setBaseModelMtx(const sead::Matrix34f& rt) { mModel->setBaseModelMtx(rt); }
    void setLocalScale(const sead::Vector3f& scale) { mModel->setLocalScale(scale); }
 
    void update(const sead::Vector3f& pos, const sead::Vector3u& rot, const sead::Vector3f& scale, bool animate = true)
    {
        sead::Matrix34f mtx;
        mtx.makeRTIdx(rot, pos);
        setBaseModelMtx(mtx);
        setLocalScale(scale);
        calc();
 
        if (animate)
            playAnmFrameCtrl();
    }
 
    SkeletalAnimation*          getSklAnim(u32 index) const { return mSklAnim[index]; }
    TexturePatternAnimation*    getTexAnim(u32 index) const { return mTexAnim[index]; }
    ShaderParamAnimation*       getShuAnim(u32 index) const { return mShuAnim[index]; }
    VisibilityAnimation*        getVisAnim(u32 index) const { return mVisAnim[index]; }
    ShapeAnimation*             getShaAnim(u32 index) const { return mShaAnim[index]; }
 
    void playSklAnim(const sead::SafeString& name, u32 idx = 0) { mSklAnim[idx]->play(mModelResource, name); }
    void playTexAnim(const sead::SafeString& name, u32 idx = 0) { mTexAnim[idx]->play(mModelResource, name); }
    void playColorAnim(const sead::SafeString& name, u32 idx = 0) { mShuAnim[idx]->playColorAnim(mModelResource, name); }
    void playTexSrtAnim(const sead::SafeString& name, u32 idx = 0) { mShuAnim[idx]->playTexSrtAnim(mModelResource, name); }
    void playBoneVisAnim(const sead::SafeString& name, u32 idx = 0) { mVisAnim[idx]->playBoneVisAnim(mModelResource, name); }
    void playMatVisAnim(const sead::SafeString& name, u32 idx = 0) { mVisAnim[idx]->playMatVisAnim(mModelResource, name); }
    void playShapeAnim(const sead::SafeString& name, u32 idx = 0) { mShaAnim[idx]->play(mModelResource, name); }
 
    // Address: 0x024D49A0
    void init(ModelResource* mdl_res, const sead::PtrArray<ModelResource>* anim_mdl_res_array = nullptr, sead::Heap* heap = nullptr);
 
    // Progress frame counters for all bound animations
    // Address: 0x024D4D20
    void playAnmFrameCtrl();
 
    // Apply animations & do world-space calculations
    // Note: "playAnmFrameCtrl" should be called at some point before this function
    // Address: 0x024D4E84
    void calc();
 
private:
    Model*                                  mModel;
    ModelResource*                          mModelResource;
    sead::Buffer<SkeletalAnimation*>        mSklAnim;
    sead::Buffer<TexturePatternAnimation*>  mTexAnim;
    sead::Buffer<ShaderParamAnimation*>     mShuAnim;
    sead::Buffer<VisibilityAnimation*>      mVisAnim;
    sead::Buffer<ShapeAnimation*>           mShaAnim;
};
static_assert(sizeof(AnimModel) == 0x30);
 
inline AnimModel* AnimModel::create(
    ModelResource* mdl_res,
    Model* model,
    s32 skl_anim_num, s32 tex_anim_num, s32 shu_anim_num, s32 vis_anim_num, s32 sha_anim_num,
    sead::Heap* heap,
    const sead::PtrArray<ModelResource>* anim_mdl_res_array
)
{
    AnimModel* anim_model = new (heap) AnimModel(model, skl_anim_num, tex_anim_num, shu_anim_num, vis_anim_num, sha_anim_num);
    anim_model->init(mdl_res, anim_mdl_res_array, heap);
    return anim_model;
}
 
inline AnimModel* AnimModel::create(
    ModelResource* mdl_res,
    const sead::SafeString& name,
    s32 skl_anim_num, s32 tex_anim_num, s32 shu_anim_num, s32 vis_anim_num, s32 sha_anim_num,
    Model::BoundingMode bounding_mode,
    sead::Heap* heap,
    const sead::PtrArray<ModelResource>* anim_mdl_res_array
)
{
    Model* model = ModelUtil::createG3d(*mdl_res, name, skl_anim_num, tex_anim_num, shu_anim_num, vis_anim_num, sha_anim_num, bounding_mode, heap);
    return create(mdl_res, model, skl_anim_num, tex_anim_num, shu_anim_num, vis_anim_num, sha_anim_num, heap, anim_mdl_res_array);
}
 
inline AnimModel* AnimModel::create(
    ModelResource* mdl_res,
    const sead::SafeString& name,
    s32 view_num,
    s32 skl_anim_num, s32 tex_anim_num, s32 shu_anim_num, s32 vis_anim_num, s32 sha_anim_num,
    Model::BoundingMode bounding_mode,
    sead::Heap* heap,
    const sead::PtrArray<ModelResource>* anim_mdl_res_array
)
{
    Model* model = ModelUtil::createG3d(*mdl_res, name, view_num, skl_anim_num, tex_anim_num, shu_anim_num, vis_anim_num, sha_anim_num, bounding_mode, heap);
    return create(mdl_res, model, skl_anim_num, tex_anim_num, shu_anim_num, vis_anim_num, sha_anim_num, heap, anim_mdl_res_array);
}
 
inline AnimModel* AnimModel::create(
    const sead::SafeString& resource_key,
    const sead::SafeString& name,
    s32 skl_anim_num, s32 tex_anim_num, s32 shu_anim_num, s32 vis_anim_num, s32 sha_anim_num,
    Model::BoundingMode bounding_mode,
    sead::Heap* heap,
    const sead::PtrArray<ModelResource>* anim_mdl_res_array
)
{
    ModelResource* mdl_res = ModelResourceMgr::instance()->getResource(resource_key);
    return create(mdl_res, name, skl_anim_num, tex_anim_num, shu_anim_num, vis_anim_num, sha_anim_num, bounding_mode, heap, anim_mdl_res_array);
}
 
inline AnimModel* AnimModel::create(
    const sead::SafeString& resource_key,
    const sead::SafeString& name,
    s32 view_num,
    s32 skl_anim_num, s32 tex_anim_num, s32 shu_anim_num, s32 vis_anim_num, s32 sha_anim_num,
    Model::BoundingMode bounding_mode,
    sead::Heap* heap,
    const sead::PtrArray<ModelResource>* anim_mdl_res_array
)
{
    ModelResource* mdl_res = ModelResourceMgr::instance()->getResource(resource_key);
    return create(mdl_res, name, view_num, skl_anim_num, tex_anim_num, shu_anim_num, vis_anim_num, sha_anim_num, bounding_mode, heap, anim_mdl_res_array);
}
 
inline void AnimModel::destroy(
    AnimModel*& anim_model
)
{
    if (anim_model != nullptr)
    {
        Model* model = anim_model->getModel();
 
        // TODO: This function may not be worth it,
        // since a lot of resources would need to be freed manually
        // for perfectly isolated destruction
        // (It's more worthwhile to make proper use of sead heaps)
 
        delete anim_model;
        anim_model = nullptr;
 
        delete model;
    }
}