fbxaxissystem.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2012 Autodesk, Inc.
   All rights reserved.
 
   Use of this software is subject to the terms of the Autodesk license agreement
   provided at the time of installation or download, or which otherwise accompanies
   this software in either electronic or hard copy form.
 
****************************************************************************************/

#ifndef _FBXSDK_SCENE_AXIS_SYSTEM_H_
#define _FBXSDK_SCENE_AXIS_SYSTEM_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/core/base/fbxarray.h>
#include <fbxsdk/core/base/fbxstring.h>
#include <fbxsdk/core/math/fbxmatrix.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

class FbxNode;
class FbxScene;
class FbxAnimCurveNode;

class FBXSDK_DLL FbxAxisSystem
{
public:

    enum EUpVector
    {
        eXAxis = 1,
        eYAxis = 2,
        eZAxis = 3
    };
    
    enum EFrontVector
    {
        eParityEven = 1,
        eParityOdd = 2
    };

    enum ECoordSystem
    {
        eRightHanded,
        eLeftHanded
    };

    enum EPreDefinedAxisSystem
    {
        eMayaZUp,           
        eMayaYUp,           
        eMax,               
        eMotionBuilder,     
        eOpenGL,            
        eDirectX,           
        eLightwave          
    };


    FbxAxisSystem(EUpVector pUpVector, EFrontVector pFrontVector, ECoordSystem pCoorSystem);

    FbxAxisSystem(const FbxAxisSystem& pAxisSystem);

    FbxAxisSystem(const EPreDefinedAxisSystem pAxisSystem);

    virtual ~FbxAxisSystem();


    bool operator==(const FbxAxisSystem& pAxisSystem)const;

    bool operator!=(const FbxAxisSystem& pAxisSystem)const;

    FbxAxisSystem& operator=(const FbxAxisSystem& pAxisSystem);


    static const FbxAxisSystem MayaZUp;

    static const FbxAxisSystem MayaYUp;

    static const FbxAxisSystem Max;

    static const FbxAxisSystem Motionbuilder;

    static const FbxAxisSystem OpenGL;

    static const FbxAxisSystem DirectX;

    static const FbxAxisSystem Lightwave;

    void ConvertScene(FbxScene* pScene) const;

    void ConvertScene(FbxScene* pScene, FbxNode* pFbxRoot) const;
    
    EFrontVector GetFrontVector( int & pSign ) const;

    EUpVector GetUpVector( int & pSign ) const;

    ECoordSystem GetCoorSystem() const;

    void ConvertChildren(FbxNode* pRoot, const FbxAxisSystem& pSrcSystem) const;

//
//  WARNING!
//
//    Anything beyond these lines may not be documented accurately and is 
//     subject to change without notice.
//
protected:
    class AxisDef
    {
    public:
        enum EAxis {eXAxis, eYAxis, eZAxis};

        EAxis   mAxis;
        int     mSign;

        bool operator==(const AxisDef& pAxis) const
        {
            return (mAxis == pAxis.mAxis) && (mSign == pAxis.mSign);
        }
    };

    AxisDef mUpVector;

    AxisDef mFrontVector;

    AxisDef mCoorSystem;

protected:
    // Conversion engine, here you will find all the step involved into the conversion

    void ConvertTProperty(FbxArray<FbxNode*>& pNodes, const FbxAxisSystem& pFrom) const;

    void ConvertCurveNodes(FbxArray<FbxAnimCurveNode*>& pCurveNodes, const FbxAxisSystem& pFrom) const;

    void AdjustPreRotation(FbxNode* pNode, const FbxMatrix& pConversionRM) const;

    void AdjustPivots(FbxNode* pNode, const FbxMatrix& pConversionRM) const;

    void GetConversionMatrix(const FbxAxisSystem& pFrom, FbxMatrix& pConversionRM) const;

    void AdjustLimits(FbxNode* pNode, const FbxMatrix& pConversionRM) const;

    void AdjustPoses(FbxScene* pScene, const FbxMatrix& pConversionRM) const;

    void AdjustCamera(FbxNode* pNode, const FbxMatrix& pConversionRM ) const;

    void AdjustCluster(FbxNode* pNode, const FbxMatrix& pConversionRM) const;

    void ConvertChildren(FbxNode* pRoot, const FbxAxisSystem& pSrcSystem, bool pSubChildrenOnly) const;

    friend class FbxGlobalSettings;
};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_SCENE_AXIS_SYSTEM_H_ */