kfbxanimstack.h

Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXPLUGINS_KFBXANIMSTACK_H
00005 #define FBXFILESDK_KFBXPLUGINS_KFBXANIMSTACK_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/components/kbaselib/klib/ktime.h>
00044 #include <fbxfilesdk/fbxcore/fbxcollection/kfbxcollection.h>
00045 
00046 // these symbols are defined for backward compatibility
00047 #define KFBXTAKENODE_DEFAULT_NAME           "Default"
00048 #define KFBXTAKENODE_ROOT_CURVE_NODE_NAME   "Defaults"
00049 
00050 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00051 
00052 class KFbxTakeInfo;
00053 class KFbxThumbnail;
00054 class KFbxAnimEvaluator;
00055 
00062 class KFBX_DLL KFbxAnimStack : public KFbxCollection
00063 {
00064     KFBXOBJECT_DECLARE(KFbxAnimStack, KFbxCollection);
00065 
00066 public:
00068     //
00069     // Properties
00070     //
00072 
00078     KFbxTypedProperty<fbxString> Description;
00079 
00088     KFbxTypedProperty<fbxTime> LocalStart;
00089 
00098     KFbxTypedProperty<fbxTime> LocalStop;
00099 
00106     KFbxTypedProperty<fbxTime> ReferenceStart;
00107 
00114     KFbxTypedProperty<fbxTime> ReferenceStop;
00115   
00119     void Reset(const KFbxTakeInfo* pTakeInfo = NULL);
00120 
00129         KTimeSpan GetLocalTimeSpan() const;
00130 
00134         void SetLocalTimeSpan(KTimeSpan& pTimeSpan);
00135 
00139         KTimeSpan GetReferenceTimeSpan() const;
00140 
00144         void SetReferenceTimeSpan(KTimeSpan& pTimeSpan);
00145 
00151         KFbxThumbnail* GetTakeThumbnail();
00152 
00158         void SetTakeThumbnail(KFbxThumbnail* pTakeThumbnail);
00159 
00174         bool BakeLayers(KFbxAnimEvaluator* pEvaluator, KTime pStart, KTime pStop, KTime pPeriod);
00175                         
00177 
00178 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00180     //  WARNING!
00181     //    Anything beyond these lines may not be documented accurately and is 
00182     //     subject to change without notice.
00184     virtual KFbxObject& Copy(const KFbxObject& pObject);
00185 
00186 protected:
00187     KFbxThumbnail* mTakeThumbnail;    
00188     KFbxAnimStack(KFbxSdkManager& pManager, char const* pName, KError* pError=0);
00189 
00190     virtual bool ConstructProperties(bool pForceSet);
00191     virtual KFbxAnimStack* GetAnimStack();
00192 
00193 private:
00194 
00195     mutable KError*                             mError;
00196         
00197     friend class KFbxObject;
00198 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00199 };
00200 
00201 typedef KFbxAnimStack* HKKFbxAnimStack;
00202 
00203 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00204 
00205 #endif // FBXFILESDK_KFBXPLUGINS_KFBXANIMSTACK_H
00206