fbxsystemunit.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2015 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_CORE_SYSTEM_UNIT_H_
#define _FBXSDK_CORE_SYSTEM_UNIT_H_

#include <fbxsdk/fbxsdk_def.h>

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

#include <fbxsdk/fbxsdk_nsbegin.h>

class FbxAMatrix;
class FbxScene;
class FbxNode;
class FbxAnimCurveNode;

class FBXSDK_DLL FbxSystemUnit 
{
public:

    struct ConversionOptions
    {
        bool mConvertRrsNodes;  

        bool mConvertLimits;

        bool mConvertClusters;

        bool mConvertLightIntensity;    

        bool mConvertPhotometricLProperties;

        bool mConvertCameraClipPlanes;
    };

    FbxSystemUnit();

    FbxSystemUnit(double pScaleFactor, double pMultiplier = 1.0);

    ~FbxSystemUnit();

    static const FbxSystemUnit mm;

    static const FbxSystemUnit dm;

    static const FbxSystemUnit cm;

    static const FbxSystemUnit m;

    static const FbxSystemUnit km;

    static const FbxSystemUnit Inch;

    static const FbxSystemUnit Foot;
    
    static const FbxSystemUnit Mile;

    static const FbxSystemUnit Yard;

    #define FBXSDK_SYSTEM_UNIT_PREDEF_COUNT 9

    static const FbxSystemUnit *sPredefinedUnits;

    static const ConversionOptions DefaultConversionOptions;

    void ConvertScene( FbxScene* pScene, const ConversionOptions& pOptions = DefaultConversionOptions ) const;

    void ConvertChildren( FbxNode* pRoot, const FbxSystemUnit& pSrcUnit, const ConversionOptions& pOptions = DefaultConversionOptions ) const;

    void ConvertScene( FbxScene* pScene, FbxNode* pFbxRoot, const ConversionOptions& pOptions = DefaultConversionOptions ) const;

    double GetScaleFactor() const;

    FbxString GetScaleFactorAsString(bool pAbbreviated = true) const;

    FbxString GetScaleFactorAsString_Plurial() const;

    double GetMultiplier() const;

    bool operator==(const FbxSystemUnit& pOther) const;

    bool operator!=(const FbxSystemUnit& pOther) const;

    FbxSystemUnit& operator=(const FbxSystemUnit& pSystemUnit);

    double GetConversionFactorTo( const FbxSystemUnit& pTarget ) const;

    double GetConversionFactorFrom( const FbxSystemUnit& pSource ) const;

/*****************************************************************************************************************************
** WARNING! Anything beyond these lines is for internal use, may not be documented and is subject to change without notice! **
*****************************************************************************************************************************/
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
    void ApplyMultiplier(FbxNode* pRoot, bool pSubChildrenOnly) const;
    void ConvertSTProperties(FbxArray<FbxNode*>& pNodes, double pConversionFactor) const;
    void ConvertSProperty(FbxArray<FbxNode*>& pNodes, double pConversionFactor) const;
    void ConvertAnimCurveNode(FbxArray<FbxAnimCurveNode*>& pFCurves, double pConversionFactor) const;
    double GetConversionFactor(double pTargetScaleFactor, double pSourceScaleFactor) const;
    void AdjustPivots(FbxNode* pNode, double pConversionFactor, FbxAMatrix& pOriginalGlobalM ) const;
    void AdjustLimits(FbxNode* pNode, double pConversionFactor) const;
    void AdjustPoses(FbxScene* pScene, double pConversionFactor) const;
    void AdjustCluster(FbxNode* pNode, double pConversionFactor) const;
    void AdjustLightIntensity(FbxNode* pNode, const double pConversionFactor) const;
    void AdjustPhotometricLightProperties(FbxNode* pNode, const double pConversionFactor) const;
    void AdjustCameraClipPlanes(FbxNode* pNode, const double pConversionFactor) const;
    void ConvertChildren(FbxNode* pRoot, const FbxSystemUnit& pSrcUnit, bool pSubChildrenOnly, const ConversionOptions& pOptions) const;

    double mScaleFactor;
    double mMultiplier;

    friend class FbxGlobalSettings;
#endif /* !DOXYGEN_SHOULD_SKIP_THIS *****************************************************************************************/
};

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_CORE_SYSTEM_UNIT_H_ */