FBX SDK Reference Guide: kfbxsystemunit.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef _KFbxSystemUnit_h
00005 #define _KFbxSystemUnit_h
00006 
00007 /**************************************************************************************
00008 
00009  Copyright  2001 - 2008 Autodesk, Inc. and/or its licensors.
00010  All Rights Reserved.
00011 
00012  The coded instructions, statements, computer programs, and/or related material 
00013  (collectively the "Data") in these files contain unpublished information 
00014  proprietary to Autodesk, Inc. and/or its licensors, which is protected by 
00015  Canada and United States of America federal copyright law and by international 
00016  treaties. 
00017  
00018  The Data may not be disclosed or distributed to third parties, in whole or in
00019  part, without the prior written consent of Autodesk, Inc. ("Autodesk").
00020 
00021  THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
00022  ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
00023  WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
00024  BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE, 
00025  NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE. 
00026  WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
00027  OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE. 
00028  
00029  IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
00030  OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
00031  OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
00032  SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
00033  OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
00034  HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
00035  FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
00036  ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
00037  WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
00038  OR DAMAGE. 
00039 
00040 **************************************************************************************/
00041 
00042 #include <kaydaradef.h>
00043 #ifndef KFBX_DLL 
00044     #define KFBX_DLL K_DLLIMPORT
00045 #endif
00046 
00047 #include <kaydara.h>
00048 
00049 #include <klib/kstring.h>
00050 #include <klib/karrayul.h>
00051 
00052 #include <fbxfilesdk_nsbegin.h>
00053 
00054 class KFbxGlobalSettings;
00055 class KFCurve;
00056 class KFbxXMatrix;
00057 class KFbxNode;
00058 class KFbxScene;
00059 
00063 class KFBX_DLL KFbxSystemUnit 
00064 {
00065 public:
00066 
00069     struct KFbxUnitConversionOptions
00070     {
00071         bool mConvertLightIntensity;        
00072         bool mConvertRrsNodes;  
00073     };
00074 
00080     KFbxSystemUnit(double pScaleFactor, double pMultiplier = 1.0);
00081     ~KFbxSystemUnit();
00082 
00083     // predefined units
00084     static const KFbxSystemUnit mm;
00085     static const KFbxSystemUnit dm;
00086     static const KFbxSystemUnit cm;
00087     static const KFbxSystemUnit m;
00088     static const KFbxSystemUnit km;
00089     static const KFbxSystemUnit Inch;
00090     static const KFbxSystemUnit Foot;
00091     static const KFbxSystemUnit Mile;
00092     static const KFbxSystemUnit Yard;
00093 
00094     #define KFbxSystemUnit_sPredefinedUnitCount 9
00095     static const KFbxSystemUnit *sPredefinedUnits; // points to an array of KFbxSystemUnit_sPredifinedUnitCount size
00096 
00097     static const KFbxUnitConversionOptions DefaultConversionOptions;
00098 
00103     void ConvertScene( KFbxScene* pScene, const KFbxUnitConversionOptions& pOptions = DefaultConversionOptions ) const;
00104 
00110     void ConvertChildren( KFbxNode* pRoot, const KFbxSystemUnit& pSrcUnit, const KFbxUnitConversionOptions& pOptions = DefaultConversionOptions ) const;
00111 
00120     void ConvertScene( KFbxScene* pScene, KFbxNode* pFbxRoot, const KFbxUnitConversionOptions& pOptions = DefaultConversionOptions ) const;
00121 
00127     double GetScaleFactor() const;
00128 
00131     KString GetScaleFactorAsString(bool pAbbreviated = true) const;
00132 
00135     KString GetScaleFactorAsString_Plurial() const;
00136 
00139     double GetMultiplier() const;
00140 
00141     bool operator ==(const KFbxSystemUnit& pOther) const;
00142     bool operator !=(const KFbxSystemUnit& pOther) const;
00143 
00146     double GetConversionFactorTo( const KFbxSystemUnit& pTarget ) const;
00147 
00150     double GetConversionFactorFrom( const KFbxSystemUnit& pSource ) const;
00151 
00153 //
00154 //  WARNING!
00155 //
00156 //  Anything beyond these lines may not be documented accurately and is 
00157 //  subject to change without notice.
00158 //
00160 
00161 protected:
00162     double mScaleFactor;
00163     double mMultiplier;
00164 
00165     void ApplyMultiplier(KFbxNode* pRoot, bool pSubChildrenOnly) const;
00166     void ConvertSTProperties(KArrayTemplate<KFbxNode*>& pNodes, double pConversionFactor) const;
00167     void ConvertSProperty(KArrayTemplate<KFbxNode*>& pNodes, double pConversionFactor) const;
00168     void ConvertFCurve(KArrayTemplate<KFCurve*>& pFCurves, double pConversionFactor) const;
00169     double GetConversionFactor( double pTargetScaleFactor, double pSourceScaleFactor) const;
00170     void AdjustPivots(KFbxNode* pNode, double pConversionFactor, KFbxXMatrix& pOriginalGlobalM ) const;
00171     void AdjustLimits(KFbxNode* pNode, double pConversionFactor) const;
00172     void AdjustPoses(KFbxScene* pScene, double pConversionFactor) const;
00173 
00174     void AdjustCluster(KFbxNode* pNode, double pConversionFactor) const;
00175     void AdjustLightIntensity(KFbxNode* pNode, const double pConversionFactor) const;
00176     void AdjustPhotometricLightProperties(KFbxNode* pNode, const double pConversionFactor) const;
00177     void AdjustCameraClipPlanes(KFbxNode* pNode, const double pConversionFactor) const;
00178 
00179     void ConvertChildren( KFbxNode* pRoot, const KFbxSystemUnit& pSrcUnit, bool pSubChildrenOnly, const KFbxUnitConversionOptions& pOptions ) const;
00180 
00181     friend class KFbxGlobalSettings;
00182 };
00183 
00184 #include <fbxfilesdk_nsend.h>
00185 
00186 #endif //_KFbxSystemUnit_h