/*
* 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.

// Decription : Parameters for the morphing functions in ICharacterInstance interface


#ifndef CRYINCLUDE_CRYCOMMON_CRYCHARMORPHPARAMS_H
#define CRYINCLUDE_CRYCOMMON_CRYCHARMORPHPARAMS_H
#pragma once

// StartMorph will accept this
struct CryCharMorphParams
{
    CryCharMorphParams (
        float _fBlendIn = 0.15f,
        float _fLength = 0,
        float _fBlendOut = 0.15f,
        float _fAmplitude = 1,
        float _fStartTime = 0,
        float _fSpeed = 1,
        uint32 _nFlags = 0
        )
    {
        m_fBlendIn      = _fBlendIn;
        m_fLength           =   _fLength;
        m_fBlendOut     =   _fBlendOut;
        m_fAmplitude    =   _fAmplitude;
        m_fStartTime    =   _fStartTime;
        m_fSpeed            =   _fSpeed;
        m_nFlags            =   _nFlags;
        m_fBalance    = 0.0f;
    }

    // the blend-in time
    f32 m_fBlendIn;
    // the time to stay in static position
    f32 m_fLength;
    // the blend-out time
    f32 m_fBlendOut;
    // the maximum amplitude
    f32 m_fAmplitude;
    // the initial time phase from which to start morphing, within the cycle
    f32 m_fStartTime;
    // multiplier of speed of the update; 1 is default:
    f32 m_fSpeed;
    // Balance between left/right morph target from -1 to 1.
    f32 m_fBalance;

    enum FlagsEnum
    {
        // with this flag set, the morph will not be time-updated (it'll be frozen at the point where it is)
        FLAGS_FREEZE            = 0x01,
        FLAGS_NO_BLENDOUT = 0x02,
        FLAGS_INSTANTANEOUS = 0x04
    };

    // optional flags, as specified by the FlagsEnum
    uint32 m_nFlags;
};

#endif // CRYINCLUDE_CRYCOMMON_CRYCHARMORPHPARAMS_H