kfbxfilterset.h

Go to the documentation of this file.

#ifndef _FBXSDK_FILTER_SET_H_
#define _FBXSDK_FILTER_SET_H_

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

 Copyright © 2002 - 2007 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 <kaydaradef.h>
#ifndef KFBX_DLL 
    #define KFBX_DLL K_DLLIMPORT
#endif

#include <kaydara.h>

#include <kcharacterdef/kcharacterdef_forward.h>
#ifndef MB_FBXSDK
#include <kcharacterdef/kcharacterdef_nsuse.h>
#endif

#include <fbxfilesdk_nsbegin.h>

class KFBX_DLL KFbxFilterSet
{

public:

    typedef enum 
    {
        eNoMode,        
        eOffOn,         
        eOffAutoUser,   
        eAutoUser       
    } EParameterModeType;

    typedef enum 
    { 
        eScalar,
        eVector
    } EParameterValueType;

    typedef enum 
    { 
        eNoUnit,
        ePercent,
        eSecond,
        eCentimeter,
        eDegree
    } EParameterUnit;

    void    Reset();

    void    SetParameterMode(int pParameterIndex, int pParameterMode);
    
    int    GetParameterMode(int pParameterIndex);
    
    void    SetParameterValue(int pParameterIndex, double pValue, int pIndex = 0);  

    double GetParameterValue(int pParameterIndex, int pIndex = 0);  

    
    static int                 GetParameterCount();

    static char*             GetParameterName(int pParameterIndex);
    
    static int                 GetParameterIndex(char* pParameterName);

    static EParameterModeType   GetParameterModeType(int pParameterIndex);

    static int                 GetParameterDefaultMode(int pParameterIndex);

    static EParameterValueType  GetParameterValueType(int pParameterIndex);

    static EParameterUnit       GetParameterUnit(int pParameterIndex);

    static double              GetParameterDefaultValue(int pParameterIndex);

    static double              GetParameterMinValue(int pParameterIndex);

    static double              GetParameterMaxValue(int pParameterIndex);    

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

#ifndef DOXYGEN_SHOULD_SKIP_THIS    

private:

    KFbxFilterSet();
    ~KFbxFilterSet();

    KFilterSetBase* mFilterSetBase;

    friend class KFbxCharacter;

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

};

#include <fbxfilesdk_nsend.h>

#endif // #ifndef _FBXSDK_FILTER_SET_H_