/*
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
* its licensors.
*
* For complete copyright and license terms please see the LICENSE at the root of this
* distribution (the "License"). All use of this software is governed by the License,
* or, if provided, by the license below or the license accompanying this file. Do not
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
*/
// Original file Copyright Crytek GMBH or its affiliates, used under license.

// Description : declaration of struct CryEngineDecalInfo.

// Note:
//    3D Engine and Character Animation subsystems (as well as perhaps
//    some others) transfer data about the decals that need to be spawned
//    via this structure. This is to avoid passing many parameters through
//    each function call, and to save on copying these parameters when just
//    simply passing the structure from one function to another.

#ifndef CRYINCLUDE_CRYCOMMON_CRYENGINEDECALINFO_H
#define CRYINCLUDE_CRYCOMMON_CRYENGINEDECALINFO_H
#pragma once

#include "Cry_Math.h"

// Summary:
//     Structure containing common parameters that describe a decal

struct SDecalOwnerInfo
{
    SDecalOwnerInfo() { memset(this, 0, sizeof(*this)); nRenderNodeSlotId = nRenderNodeSlotSubObjectId = -1; }
    struct IStatObj* GetOwner(Matrix34A& objMat);

    struct IRenderNode*    pRenderNode;                             // Owner (decal will be attached to or wrapped around of this object)
    PodArray<struct SRNInfo>* pDecalReceivers;
    int                                     nRenderNodeSlotId;  // is set internally by 3dengine
    int                                     nRenderNodeSlotSubObjectId; // is set internally by 3dengine
    int                   nMatID;
};

struct CryEngineDecalInfo
{
    SDecalOwnerInfo             ownerInfo;
    Vec3                  vPos;                                         // Decal position (world coordinates)
    Vec3                  vNormal;                                  // Decal/face normal
    float                                   fSize;                                      // Decal size
    float                                   fLifeTime;                              // Decal life time (in seconds)
    float                                   fAngle;                                     // Angle of rotation
    struct IStatObj*           pIStatObj;                             // Decal geometry
    Vec3                  vHitDirection;                        // Direction from weapon/player position to decal position (bullet direction)
    float                                   fGrowTime, fGrowTimeAlpha;// Used for blood pools
    unsigned int          nGroupId;               // Used for multi-component decals
    bool                                    bSkipOverlappingTest;           // Always spawn decals even if there are a lot of other decals in same place
    bool                                    bAssemble;                              // Assemble to bigger decals if more than 1 decal is on the same place
    bool                                    bForceEdge;                             // force the decal to the nearest edge of the owner mesh and project it accordingly
    bool                                    bForceSingleOwner;              // Do not attempt to cast the decal into the environment even if it's large enough
    bool                                    bDeferred;
    uint8                                   sortPrio;
    char szMaterialName[_MAX_PATH]; // name of material used for rendering the decal (in favor of szTextureName/nTid and the default decal shader)
    bool preventDecalOnGround;              // mainly for decal placement support
    const Matrix33* pExplicitRightUpFront;  // mainly for decal placement support

    void GetMemoryUsage(ICrySizer* pSizer) const{}

    // the constructor fills in some non-obligatory fields; the other fields must be filled in by the client
    CryEngineDecalInfo ()
    {
        memset(this, 0, sizeof(*this));
        ownerInfo.nRenderNodeSlotId = ownerInfo.nRenderNodeSlotSubObjectId = -1;
        sortPrio = 255;
    }
};

#endif // CRYINCLUDE_CRYCOMMON_CRYENGINEDECALINFO_H