kfbxtexture.h

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXTEXTURE_H
#define FBXFILESDK_KFBXPLUGINS_KFBXTEXTURE_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/components/kbaselib/kaydaradef_h.h>
#ifdef KARCH_DEV_MACOSX_CFM
    #include <CFURL.h>
    #include <Files.h>
#endif

// FBX includes
#include <fbxfilesdk/kfbxmath/kfbxvector2.h>
#include <fbxfilesdk/kfbxplugins/kfbxshadingnode.h>

// FBX namespace
#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

// Forward declaration
class KFbxVector4;
class KFbxLayerContainer;


class KFBX_DLL KFbxTexture : public KFbxShadingNode
{
    KFBXOBJECT_DECLARE(KFbxTexture,KFbxShadingNode);

    public:
        typedef enum
        { 
            eUMT_UV, 
            eUMT_XY, 
            eUMT_YZ, 
            eUMT_XZ, 
            eUMT_SPHERICAL,
            eUMT_CYLINDRICAL,
            eUMT_ENVIRONMENT,
            eUMT_PROJECTION,
            eUMT_BOX, // deprecated
            eUMT_FACE, // deprecated
            eUMT_NO_MAPPING,
        } EUnifiedMappingType;

        typedef enum 
        {
            eTEXTURE_USE_6_STANDARD,
            eTEXTURE_USE_6_SPHERICAL_REFLEXION_MAP,
            eTEXTURE_USE_6_SPHERE_REFLEXION_MAP,
            eTEXTURE_USE_6_SHADOW_MAP,
            eTEXTURE_USE_6_LIGHT_MAP,
            eTEXTURE_USE_6_BUMP_NORMAL_MAP
        } ETextureUse6;

        typedef enum 
        {
            eREPEAT,
            eCLAMP
        } EWrapMode;

        typedef enum 
        {
            eTRANSLUCENT,
            eADDITIVE,
            eMODULATE,
            eMODULATE2,
            eOVER
        } EBlendMode;

        typedef enum  
        {
            eLEFT = 0,
            eRIGHT,
            eTOP,
            eBOTTOM
        } EAlignMode;

        typedef enum 
        {
            eU = 0,
            eV,
            eW
        } ECoordinates;

        // Type description
        KFbxTypedProperty<ETextureUse6>         TextureTypeUse;
        KFbxTypedProperty<fbxDouble1>           Alpha;

        // Mapping information
        KFbxTypedProperty<EUnifiedMappingType>  CurrentMappingType;
        KFbxTypedProperty<EWrapMode>            WrapModeU;
        KFbxTypedProperty<EWrapMode>            WrapModeV;
        KFbxTypedProperty<fbxBool1>             UVSwap;

        // Texture positioning
        KFbxTypedProperty<fbxDouble3>           Translation;
        KFbxTypedProperty<fbxDouble3>           Rotation;
        KFbxTypedProperty<fbxDouble3>           Scaling;
        KFbxTypedProperty<fbxDouble3>           RotationPivot;
        KFbxTypedProperty<fbxDouble3>           ScalingPivot;

        // Material management
        KFbxTypedProperty<fbxBool1>             UseMaterial;
        KFbxTypedProperty<fbxBool1>             UseMipMap;

        // Blend mode
        KFbxTypedProperty<EBlendMode>   CurrentTextureBlendMode;

        // UV set to use.
        KFbxTypedProperty<fbxString>            UVSet;

    void Reset();

    bool SetFileName(char const* pName);

    bool SetRelativeFileName(char const* pName);

    #ifdef KARCH_DEV_MACOSX_CFM
    bool SetFile(const FSSpec &pMacFileSpec);
    bool SetFile(const FSRef &pMacFileRef);
    bool SetFile(const CFURLRef &pMacURL);
    #endif

    char const* GetFileName () const;

    char const* GetRelativeFileName() const;

    #ifdef KARCH_DEV_MACOSX_CFM
    bool GetFile(FSSpec &pMacFileSpec) const;
    bool GetFile(FSRef &pMacFileRef) const;
    bool GetFile(CFURLRef &pMacURL) const;
    #endif

    void SetSwapUV(bool pSwapUV);

    bool GetSwapUV() const;

    typedef enum    
    { 
        eNONE, 
        eRGB_INTENSITY, 
        eBLACK 
    } EAlphaSource;

    void SetAlphaSource(EAlphaSource pAlphaSource);

    EAlphaSource GetAlphaSource() const;

    void SetCropping(int pLeft, int pTop, int pRight, int pBottom);

    int GetCroppingLeft() const;

    int GetCroppingTop() const;

    int GetCroppingRight() const;

    int GetCroppingBottom() const;
    
    typedef enum    
    { 
        eNULL, 
        ePLANAR, 
        eSPHERICAL, 
        eCYLINDRICAL, 
        eBOX, 
        eFACE,
        eUV,
        eENVIRONMENT
    } EMappingType;

    void SetMappingType(EMappingType pMappingType);

    EMappingType GetMappingType() const;

    typedef enum   
    { 
        ePLANAR_NORMAL_X, 
        ePLANAR_NORMAL_Y, 
        ePLANAR_NORMAL_Z 
    } EPlanarMappingNormal;

    void SetPlanarMappingNormal(EPlanarMappingNormal pPlanarMappingNormal);

    EPlanarMappingNormal GetPlanarMappingNormal() const;

    typedef enum 
    {
        eMODEL_MATERIAL,
        eDEFAULT_MATERIAL
    } EMaterialUse;

    void SetMaterialUse(EMaterialUse pMaterialUse);

    EMaterialUse GetMaterialUse() const;

    typedef enum 
    {
        eSTANDARD,
        eSHADOW_MAP,
        eLIGHT_MAP,
        eSPHERICAL_REFLEXION_MAP,
        eSPHERE_REFLEXION_MAP,
        eBUMP_NORMAL_MAP
    } ETextureUse;

    void SetTextureUse(ETextureUse pTextureUse);

    ETextureUse GetTextureUse() const;


    void SetWrapMode(EWrapMode pWrapU, EWrapMode pWrapV);

    EWrapMode GetWrapModeU() const;

    EWrapMode GetWrapModeV() const;


    void SetBlendMode(EBlendMode pBlendMode);

    EBlendMode GetBlendMode() const;



        inline void SetDefaultT(const KFbxVector4& pT) { Translation.Set( pT ); }

    KFbxVector4& GetDefaultT(KFbxVector4& pT) const;

    inline void SetDefaultR(const KFbxVector4& pR) { Rotation.Set( fbxDouble3(pR[0],pR[1],pR[2]) ); }

    KFbxVector4& GetDefaultR(KFbxVector4& pR) const;

    inline void SetDefaultS(const KFbxVector4& pS) { Scaling.Set( fbxDouble3(pS[0],pS[1],pS[2]) ); }

    KFbxVector4& GetDefaultS(KFbxVector4& pS) const;

    void SetDefaultAlpha(double pAlpha);

    double GetDefaultAlpha() const;



    void SetTranslation(double pU,double pV);

    double GetTranslationU() const;

    double GetTranslationV() const;

    void SetRotation(double pU, double pV, double pW = 0.0);

    double GetRotationU() const;

    double GetRotationV() const;

    double GetRotationW() const;

    void SetScale(double pU,double pV);

    double GetScaleU() const;

    double GetScaleV() const;

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

#ifndef DOXYGEN_SHOULD_SKIP_THIS

    bool operator==(KFbxTexture const& pTexture) const;

    KString& GetMediaName();
    void SetMediaName(char const* pMediaName);

    void SetUVTranslation(KFbxVector2& pT);
    KFbxVector2& GetUVTranslation();
    void SetUVScaling(KFbxVector2& pS);
    KFbxVector2& GetUVScaling();

    KString GetTextureType();


    // Clone
    virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;

protected:
    KFbxTexture(KFbxSdkManager& pManager, char const* pName);  

    virtual void Construct(const KFbxTexture* pFrom);
    virtual bool ConstructProperties(bool pForceSet);

    KFbxTexture& operator=(KFbxTexture const& pTexture);

    virtual KStringList GetTypeFlags() const;
    
    void Init();
    void SyncVideoFileName(char const* pFileName);
    void SyncVideoRelativeFileName(char const* pFileName);

    int mTillingUV[2]; // not a prop
    int mCropping[4]; // not a prop

    EAlphaSource mAlphaSource; // now unused in MB (always set to None); not a prop
    EMappingType mMappingType; // CurrentMappingType
    EPlanarMappingNormal mPlanarMappingNormal; // CurrentMappingType

    KString mFileName;
    KString mRelativeFileName;
    KString mMediaName; // not a prop

    static KError smError;

    // Unsupported parameters in the FBX SDK, these are declared but not accessible.
    // They are used to keep imported and exported data identical.

    KFbxVector2 mUVScaling; // not a prop
    KFbxVector2 mUVTranslation; // not a prop

    friend class KFbxLayerContainer;

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

};

inline EFbxType FbxTypeOf( KFbxTexture::EUnifiedMappingType const &pItem )      { return eENUM; }
inline EFbxType FbxTypeOf( KFbxTexture::ETextureUse6 const &pItem )             { return eENUM; }
inline EFbxType FbxTypeOf( KFbxTexture::EWrapMode const &pItem )                { return eENUM; }
inline EFbxType FbxTypeOf( KFbxTexture::EBlendMode const &pItem )               { return eENUM; }

typedef KFbxTexture* HKFbxTexture;

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXTEXTURE_H