kfbxanimlayer.h

Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXPLUGINS_KFBXANIMLAYER_H
00005 #define FBXFILESDK_KFBXPLUGINS_KFBXANIMLAYER_H
00006 
00007 /**************************************************************************************
00008 
00009  Copyright (C) 2009 - 2010 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 #include <fbxfilesdk/fbxfilesdk_def.h>
00042 
00043 #include <fbxfilesdk/fbxcore/fbxcollection/kfbxcollection.h>
00044 
00045 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00046 
00047 class KFbxAnimCurveNode;
00048 
00055 class KFBX_DLL KFbxAnimLayer : public KFbxCollection
00056 {
00057     KFBXOBJECT_DECLARE(KFbxAnimLayer, KFbxCollection);
00058 
00059 public:
00061     //
00062     // Properties
00063     //
00065 
00072     KFbxTypedProperty<fbxDouble1>       Weight;
00073 
00079     KFbxTypedProperty<fbxBool1>         Mute;
00080 
00087     KFbxTypedProperty<fbxBool1>         Solo;
00088 
00095     KFbxTypedProperty<fbxBool1>         Lock;
00096 
00104     KFbxTypedProperty<fbxDouble3>       Color;
00105 
00112     KFbxTypedProperty<fbxEnum>          BlendMode;
00113 
00121     KFbxTypedProperty<fbxEnum>          RotationAccumulationMode;
00122 
00130     KFbxTypedProperty<fbxEnum>          ScaleAccumulationMode;
00131 
00133     void Reset();
00134 
00144 
00150         void SetBlendModeBypass(EFbxType pType, bool pState);
00151 
00156         bool GetBlendModeBypass(EFbxType pType);
00157 
00159 
00160 
00163     typedef enum
00164     {
00165         eBlendModeAdditive,             
00167         eBlendModeOverride,             
00169         eBlendModeOverridePassthrough   
00176     } EBlendMode;
00177     
00180     typedef enum
00181     {
00182         eRotAccuModeByLayer,        
00184         eRotAccuModeByChannel       
00186     } ERotationAccumulationMode;
00187 
00190     typedef enum
00191     {
00192         eScaleAccuModeMultiply, 
00195         eScaleAccuModeAdditive 
00196     } EScaleAccumulationMode;
00197 
00210         KFbxAnimCurveNode* CreateCurveNode(KFbxProperty& pProperty);
00212 
00213 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00215     //  WARNING!
00216     //  Anything beyond these lines may not be documented accurately and is 
00217     //  subject to change without notice.
00219 
00220 protected:
00221     KFbxAnimLayer(KFbxSdkManager& pManager, char const* pName, KError* pError=0);
00222 
00223     virtual KFbxAnimLayer* GetAnimLayer();
00224 
00225 private:
00226     bool ConstructProperties(bool pForceSet);
00227 
00228     KFbxTypedProperty<fbxULongLong1>    mBlendModeBypass;   
00229 
00230     mutable KError* mError;
00231 
00232     friend class KFbxObject;
00233 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00234 };
00235 
00236 typedef KFbxAnimLayer* HKKFbxAnimLayer;
00237 
00238 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00239 
00240 #endif // FBXFILESDK_KFBXPLUGINS_KFBXANIMLAYER_H
00241