// 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 NICOLORDATA_H
#define NICOLORDATA_H

#include <NiObject.h>
#include "NiAnimationLibType.h"
#include "NiColorKey.h"

NiSmartPointer(NiColorData);

class NIANIMATION_ENTRY NiColorData : public NiObject
{
    NiDeclareRTTI;
    NiDeclareStream;
    NiDeclareViewerStrings;

public:
    NiColorData ();
    virtual ~NiColorData ();

    // color key access
    unsigned int GetNumKeys () const;
    NiColorKey* GetAnim (unsigned int& uiNumKeys,
        NiColorKey::KeyType& eType, unsigned char& ucSize) const;

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

    // For swapping rotation animation sequences at runtime.  The method
    // neither deletes the old data nor makes internal copies of the new
    // data. 
    void SetAnim (NiColorKey* pkKeys, unsigned int uiNumKeys,
        NiColorKey::KeyType eType);

    // *** begin Emergent internal use only ***
    void GuaranteeKeysAtStartAndEnd(float fStartTime, float fEndTime);
    NiColorDataPtr GetSequenceData(float fStartTime, float fEndTime);
    // *** end Emergent internal use only ***

protected:
    unsigned int m_uiNumKeys;
    NiColorKey* m_pkKeys;
    NiColorKey::KeyType m_eType;
    unsigned char m_ucKeySize;
};

#include "NiColorData.inl"

#endif