kfbxsystemunit.h

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXSYSTEMUNIT_H
#define FBXFILESDK_KFBXPLUGINS_KFBXSYSTEMUNIT_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>
#include <fbxfilesdk/components/kbaselib/kaydara.h>

#include <fbxfilesdk/components/kbaselib/klib/kstring.h>
#include <fbxfilesdk/components/kbaselib/klib/karrayul.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxGlobalSettings;
class KFCurve;
class KFbxXMatrix;
class KFbxNode;
class KFbxScene;

class KFBX_DLL KFbxSystemUnit 
{
public:

    struct KFbxUnitConversionOptions
    {
        bool mConvertLightIntensity;        
        bool mConvertRrsNodes;  
    };

    KFbxSystemUnit(double pScaleFactor, double pMultiplier = 1.0);
    ~KFbxSystemUnit();

    // predefined units
    static const KFbxSystemUnit mm;
    static const KFbxSystemUnit dm;
    static const KFbxSystemUnit cm;
    static const KFbxSystemUnit m;
    static const KFbxSystemUnit km;
    static const KFbxSystemUnit Inch;
    static const KFbxSystemUnit Foot;
    static const KFbxSystemUnit Mile;
    static const KFbxSystemUnit Yard;

    #define KFbxSystemUnit_sPredefinedUnitCount 9
    static const KFbxSystemUnit *sPredefinedUnits; // points to an array of KFbxSystemUnit_sPredifinedUnitCount size

    static const KFbxUnitConversionOptions DefaultConversionOptions;

    void ConvertScene( KFbxScene* pScene, const KFbxUnitConversionOptions& pOptions = DefaultConversionOptions ) const;

    void ConvertChildren( KFbxNode* pRoot, const KFbxSystemUnit& pSrcUnit, const KFbxUnitConversionOptions& pOptions = DefaultConversionOptions ) const;

    void ConvertScene( KFbxScene* pScene, KFbxNode* pFbxRoot, const KFbxUnitConversionOptions& pOptions = DefaultConversionOptions ) const;

    double GetScaleFactor() const;

    KString GetScaleFactorAsString(bool pAbbreviated = true) const;

    KString GetScaleFactorAsString_Plurial() const;

    double GetMultiplier() const;

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

    double GetConversionFactorTo( const KFbxSystemUnit& pTarget ) const;

    double GetConversionFactorFrom( const KFbxSystemUnit& pSource ) const;

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

protected:
    double mScaleFactor;
    double mMultiplier;

    void ApplyMultiplier(KFbxNode* pRoot, bool pSubChildrenOnly) const;
    void ConvertSTProperties(KArrayTemplate<KFbxNode*>& pNodes, double pConversionFactor) const;
    void ConvertSProperty(KArrayTemplate<KFbxNode*>& pNodes, double pConversionFactor) const;
    void ConvertFCurve(KArrayTemplate<KFCurve*>& pFCurves, double pConversionFactor) const;
    double GetConversionFactor( double pTargetScaleFactor, double pSourceScaleFactor) const;
    void AdjustPivots(KFbxNode* pNode, double pConversionFactor, KFbxXMatrix& pOriginalGlobalM ) const;
    void AdjustLimits(KFbxNode* pNode, double pConversionFactor) const;
    void AdjustPoses(KFbxScene* pScene, double pConversionFactor) const;

    void AdjustCluster(KFbxNode* pNode, double pConversionFactor) const;
    void AdjustLightIntensity(KFbxNode* pNode, const double pConversionFactor) const;
    void AdjustPhotometricLightProperties(KFbxNode* pNode, const double pConversionFactor) const;
    void AdjustCameraClipPlanes(KFbxNode* pNode, const double pConversionFactor) const;

    void ConvertChildren( KFbxNode* pRoot, const KFbxSystemUnit& pSrcUnit, bool pSubChildrenOnly, const KFbxUnitConversionOptions& pOptions ) const;

    friend class KFbxGlobalSettings;
};

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXSYSTEMUNIT_H