kfcurveutils.h

Go to the documentation of this file.

#ifndef FBXFILESDK_COMPONENTS_KFCURVE_KFCURVEUTILS_H
#define FBXFILESDK_COMPONENTS_KFCURVE_KFCURVEUTILS_H

/**************************************************************************************

 Copyright (C) 2001 - 2009 Autodesk, Inc. and/or its licensors.
 All Rights Reserved.

 The coded instructions, statements, computer programs, and/or related material 
 (collectively the "Data") in these files contain unpublished information 
 proprietary to Autodesk, Inc. and/or its licensors, which is protected by 
 Canada and United States of America federal copyright law and by international 
 treaties. 
 
 The Data may not be disclosed or distributed to third parties, in whole or in
 part, without the prior written consent of Autodesk, Inc. ("Autodesk").

 THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
 ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
 WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
 BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE, 
 NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE. 
 WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
 OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE. 
 
 IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
 OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
 OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
 SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
 OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
 HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
 FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
 ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
 WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
 OR DAMAGE. 

**************************************************************************************/
#include <fbxfilesdk/fbxfilesdk_def.h>

#include <fbxfilesdk/components/kfcurve/kfcurve.h>
#include <fbxfilesdk/components/kbaselib/klib/kerror.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

    class KFCurveNode;

    class KFBX_DLL KFCurveUtils
    {

    public:

        static bool CompareCurve(KFCurve* pCurveA, KFCurve* pCurveB);

        static bool GetGlobalInterpolation(kFCurveInterpolation& pGlobalInterpolation, KFCurve& pCurve);

        static bool GetGlobalTangeant(kFCurveTangeantMode& pGlobalTangent, KFCurve& pCurve);

        enum EInterpolationAndTangeant
        {
            eCONSTANT,
            eLINEAR,
            eCUBIC_AUTO,
            eCUBIC_AUTO_BREAK,
            eCUBIC_USER,
            eCUBIC_BREAK,
            eCUBIC_TCB,
            eINTERPOLATION_AND_TANGEANT_COUNT
        };

        static bool GetInterpolationAndTangeantCount(KFCurve& pCurve, int pArray[eINTERPOLATION_AND_TANGEANT_COUNT]);

        static KFCurveNode& ConvertCurveInterpolationRecursive
        (
            kFCurveInterpolation    pTargetGlobalInterpolation,
            kFCurveTangeantMode     pTargetGlobalTangent,
            KFCurveNode&            pCurveNode
        );

        static KFCurve& ConvertCurve
        (
            KFCurve& pSourceCurve,
            KFCurve& pTargetCurve,
            kFCurveInterpolation pTargetGlobalInterpolation,
            kFCurveTangeantMode pTargetGlobalTangent,
            KTime pFramePeriod
        );

        static void Resample
        (
            KFCurve &pSourceCurve,
            KFCurve &pTargetCurve,
            KTime &pStart,
            KTime &pStop,
            KTime &pPeriod,
            kFCurveInterpolation pInterpolation,
            kFCurveTangeantMode pTangentMode,
            bool pAddStopKey = false
        );

        static void Resample
        (
            KFCurve &pSourceCurve,
            KFCurve &pTargetCurve,
            KTime &pStart,
            KTime &pStop,
            KTime &pPeriod,
            bool pAddStopKey = false
        );

        static void Resample
        (
            KFCurve &pCurve,
            KTime   pPeriod,
            KTime   pStart = KTIME_MINUS_INFINITE,
            KTime   pStop = KTIME_INFINITE,
            bool    pKeysOnFrame = false
        );

        static void Merge(KFCurve &pCurveIn, KFCurve &pCurveMerge, KFCurve &pCurveOut);

        static KTime FindTimeOffsetBefore(KFCurve pCurve, KTime& pTime);

        static KTime FindTimeOffsetAfter(KFCurve pCurve, KTime& pTime);


        enum EError
        {
            // Interpolation & tangent methods
            eNoKey,
            eMultiple,

            // Curve sync methods
            eMultipleKeyCount,
            eUnsyncedKeys,

            // Filtering methods
            eLeftUnchanged,

            eErrorCount
        };

        static KError& GetError();

        static EError GetLastErrorID();

        static const char* GetLastErrorString();


    //
    //  WARNING!
    //
    //  Anything beyond these lines may not be documented accurately and is
    //  subject to change without notice.
    //

    #ifndef DOXYGEN_SHOULD_SKIP_THIS

    protected:

        KFCurveUtils();

        static KError smError;

    #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

    };

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_COMPONENTS_KFCURVE_KFCURVEUTILS_H