FBX SDK Reference Guide: kfbxquaternion.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXMATH_KFBXQUATERNION_H
00005 #define FBXFILESDK_KFBXMATH_KFBXQUATERNION_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 
00043 
00044 #include <fbxfilesdk/components/kbaselib/kaydaradef_h.h>
00045 #include <fbxfilesdk/components/kbaselib/kaydara.h>
00046 
00047 #include <fbxfilesdk/kfbxmath/kfbxvector4.h>
00048 
00049 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00050 
00054 class KFBX_DLL KFbxQuaternion : public fbxDouble4
00055     {
00056 
00057     public:
00058 
00063 
00065         KFbxQuaternion();
00066 
00070         KFbxQuaternion(const KFbxQuaternion& pV);
00071 
00078         KFbxQuaternion(double pX, double pY, double pZ, double pW = 1.0);
00079         
00081         ~KFbxQuaternion();
00082 
00084 
00089         
00093         KFbxQuaternion& operator=(const KFbxQuaternion& pQuaternion);
00094         
00100         double& operator[](int pIndex);
00101 
00107         double GetAt(int pIndex);   
00108 
00114         void SetAt(int pIndex, double pValue);
00115 
00122         void Set(double pX, double pY, double pZ, double pW = 1.0);
00123         
00125 
00130         
00136         KFbxQuaternion operator+(double pValue);
00137 
00143         KFbxQuaternion operator-(double pValue);
00144 
00150         KFbxQuaternion operator*(double pValue);
00151 
00157         KFbxQuaternion operator/(double pValue);
00158 
00164         KFbxQuaternion& operator+=(double pValue);
00165 
00171         KFbxQuaternion& operator-=(double pValue);
00172 
00178         KFbxQuaternion& operator*=(double pValue);
00179 
00185         KFbxQuaternion& operator/=(double pValue);
00186         
00188 
00193 
00197         KFbxQuaternion operator-();
00198         
00204         KFbxQuaternion operator+(KFbxQuaternion& pQuaternion);
00205 
00211         KFbxQuaternion operator-(KFbxQuaternion& pQuaternion);
00212 
00218         KFbxQuaternion operator*(KFbxQuaternion& pQuaternion);
00219 
00225         KFbxQuaternion operator/(KFbxQuaternion& pQuaternion);
00226 
00232         KFbxQuaternion& operator+=(KFbxQuaternion& pQuaternion);
00233 
00239         KFbxQuaternion& operator-=(KFbxQuaternion& pQuaternion);
00240 
00246         KFbxQuaternion& operator*=(KFbxQuaternion& pQuaternion);
00247         
00253         KFbxQuaternion& operator/=(KFbxQuaternion& pQuaternion);
00254 
00259         KFbxQuaternion Product(const KFbxQuaternion& pQuaternion);
00260 
00263         void           Normalize();
00264 
00268         void           Conjugate();
00269 
00273         void           ComposeSphericalXYZ(KFbxVector4 pEuler);
00274 
00278         KFbxVector4    DecomposeSphericalXYZ();
00279         
00281 
00286 
00291         bool operator==(KFbxQuaternion& pV);
00292         bool operator==(KFbxQuaternion const& pV) const;
00293         
00298         bool operator!=(KFbxQuaternion& pV);
00299         bool operator!=(KFbxQuaternion const& pV) const;
00300         
00302 
00307 
00309         operator double* ();
00310         
00312 
00313 
00315     //
00316     //  WARNING!
00317     //
00318     //  Anything beyond these lines may not be documented accurately and is 
00319     //  subject to change without notice.
00320     //
00322 
00323     #ifndef DOXYGEN_SHOULD_SKIP_THIS    
00324         void GetKFbxQuaternionFromPositionToPosition(KFbxVector4 &pP0,KFbxVector4 &pP1);
00325     #endif //doxygen
00326 
00327     };
00328 
00329     inline EFbxType FbxTypeOf( KFbxQuaternion const &pItem )    { return eDOUBLE4; }
00330 
00331 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00332 
00333 #endif // FBXFILESDK_KFBXMATH_KFBXQUATERNION_H
00334