// EMERGENT GAME TECHNOLOGIES PROPRIETARY INFORMATION
//
// This software is supplied under the terms of a license agreement or
// nondisclosure agreement with Emergent Game Technologies and may not
// be copied or disclosed except in accordance with the terms of that
// agreement.
//
//      Copyright (c) 1996-2007 Emergent Game Technologies.
//      All Rights Reserved.
//
// Emergent Game Technologies, Chapel Hill, North Carolina 27517
// http://www.emergent.net

#ifndef NIPATHCONTROLLER_H
#define NIPATHCONTROLLER_H

#include <NiAVObject.h>
#include <NiTimeController.h>
#include "NiPosData.h"
#include "NiFloatData.h"

NiSmartPointer(NiPathController);

// This class has been deprecated as of Gamebryo 1.2. 
// Equivalent functionality can be found with an NiTransformController
// containing an NiPathInterpolator.

class NIANIMATION_ENTRY NiPathController : public NiTimeController
{
    NiDeclareRTTI;
    NiDeclareClone(NiPathController);
    NiDeclareStream;
    NiDeclareViewerStrings;
    NiDeclareFlags(unsigned short);

public:
    virtual ~NiPathController();

    // updates
    virtual void Update(float fTime);

    // shared data access
    void SetPathData(NiPosData* pkPathData);
    NiPosData* GetPathData();
    void SetPctData(NiFloatData* pkPctData);
    NiFloatData* GetPctData();

    // path data access
    void GetPathData(NiPosKey*& pkPathKeys, unsigned int& uiNumKeys,
        NiPosKey::KeyType& eType, unsigned char& ucSize) const;

    // For swapping animation sequences at runtime. The NiPosData object 
    //   assumes ownership of the data array being passed in, and has the 
    //   responsibility for deleting it when finished with it.
    void ReplacePathData(NiPosKey* pkPathKeys, unsigned int uiNumKeys,
        NiPosKey::KeyType ePathType);

    // percent data access
    void GetPctData(NiFloatKey*& pkPctData, unsigned int& uiNumKeys,
        NiFloatKey::KeyType& eType, unsigned char& ucSize) const;

    // For swapping animation sequences at runtime. The NiFloatData object 
    //   assumes ownership of the data array being passed in, and has the 
    //   responsibility for deleting it when finished with it.
    void ReplacePctData(NiFloatKey* pkPctKeys, unsigned int uiNumKeys,
        NiFloatKey::KeyType eType);

    // control option data member access methods
    void SetAllowFlip(bool bAllowFlip);
    bool GetAllowFlip() const;

    void SetBank(bool bBank);
    bool GetBank() const;

    enum BankDir { NEGATIVE = -1, POSITIVE = 1 };
    void SetBankDir(BankDir eDir);
    BankDir GetBankDir() const;

    void SetConstVelocity(bool bConstVelocity);
    bool GetConstVelocity() const;

    void SetFollow(bool bFollow);
    bool GetFollow() const;

    void SetMaxBankAngle(float fAngle);
    float GetMaxBankAngle() const;

    void SetSmoothing(float fSmooth);
    float GetSmoothing() const;

    void SetFollowAxis(short sAxis);
    short GetFollowAxis() const;

    void SetFlip(bool bFlip);
    bool GetFlip() const;

    bool GetCurveTypeOpen() const;

    float GetTotalPathLength() const;

    virtual bool IsTransformController() const;

    // *** begin Emergent internal use only ***
    void SetCurveTypeOpen(bool bOpen);
    virtual void ProcessClone(NiCloningProcess& kCloning);
    // *** end Emergent internal use only ***

protected:
    // Protected constructor to prevent instantiation of this class outside
    // of stream loading.
    NiPathController(NiPosData* pkPathData = 0, NiFloatData* pkPctData = 0);

    // --- Begin NIF conversion code
    // Deprecated flags - use new flag code
    enum
    {
        MAX_POS = 12
    };
    // --- End NIF conversion code

    // flags
    enum
    {
        CVDATAUPDATE_MASK   = 0x0001,
        OPENCURVE_MASK      = 0x0002,
        ALLOWFLIP_MASK      = 0x0004,
        BANK_MASK           = 0x0008,
        CONSTVELOCITY_MASK  = 0x0010,
        FOLLOW_MASK         = 0x0020,
        FLIP_MASK           = 0x0040
    };

    NiPoint3 GenPathInterp(int iI1, int iI2, float fNormTime);
    void CalcRefFrame(unsigned int uiI1, unsigned int uiI2, float fNormTime,
        NiMatrix3& refFrame);
    void GetPercentLoc(float fPercent, unsigned int& uiI1,
        unsigned int& uiI2, float& fNormTime);
    void GetLoc(float fTime, unsigned int& uiI1, unsigned int& uiI2,
        float& fNormTime);

    // constant velocity related routines
    void SetConstantVelocityData();
    float PathSpeed(int iI0, int iI1, float fTime) const;
    float PathLength(int iI0, int iI1, float fTime) const;

    void SetCVDataNeedsUpdate(bool bUpdate);
    bool GetCVDataNeedsUpdate() const;
 
    unsigned int m_uiLastPathIdx;
    unsigned int m_uiLastPctIdx;

    NiPosDataPtr m_spPathData;
    NiFloatDataPtr m_spPctData;

    // reparameterization by arc length
    mutable float* m_pfPartialLength;
    mutable float m_fTotalLength;

    float m_fMaxBankAngle;
    float m_fSmoothing;
    short m_sFollowAxis;
    float m_fMaxCurvature;
    BankDir m_eBankDir;

    // debugging
    virtual bool TargetIsRequiredType() const;
};

#include "NiPathController.inl"

#endif