FBX SDK Reference Guide: kfbxdocumentinfo.h Source File
Go to the documentation of this file.
00001 
00003 #ifndef _FBXSDK_DOCUMENT_INFO_H_
00004 #define _FBXSDK_DOCUMENT_INFO_H_
00005 
00006 /**************************************************************************************
00007 
00008  Copyright  2001 - 2008 Autodesk, Inc. and/or its licensors.
00009  All Rights Reserved.
00010 
00011  The coded instructions, statements, computer programs, and/or related material 
00012  (collectively the "Data") in these files contain unpublished information 
00013  proprietary to Autodesk, Inc. and/or its licensors, which is protected by 
00014  Canada and United States of America federal copyright law and by international 
00015  treaties. 
00016  
00017  The Data may not be disclosed or distributed to third parties, in whole or in
00018  part, without the prior written consent of Autodesk, Inc. ("Autodesk").
00019 
00020  THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
00021  ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
00022  WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
00023  BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE, 
00024  NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE. 
00025  WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
00026  OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE. 
00027  
00028  IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
00029  OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
00030  OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
00031  SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
00032  OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
00033  HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
00034  FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
00035  ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
00036  WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
00037  OR DAMAGE. 
00038 
00039 **************************************************************************************/
00040 
00041 #include <kaydaradef.h>
00042 #include <kaydara.h>
00043 #ifndef KFBX_DLL 
00044     #define KFBX_DLL K_DLLIMPORT
00045 #endif
00046 
00047 #include <klib/kstring.h>
00048 #include <kfbxplugins/kfbxobject.h>
00049 
00050 #ifndef MB_FBXSDK
00051     #include <kbaselib_nsuse.h>
00052 #endif
00053 
00054 class KStreamFbx; 
00055 
00056 #include <fbxfilesdk_nsbegin.h>
00057 
00058     class KFbxThumbnail;
00059     class KFbxSdkManager;
00060 
00063     class KFBX_DLL KFbxDocumentInfo : public KFbxObject
00064     {
00065         KFBXOBJECT_DECLARE(KFbxDocumentInfo,KFbxObject);
00066 
00071         public:
00072             KFbxTypedProperty<fbxString>    LastSavedUrl;
00073             KFbxTypedProperty<fbxString>    Url;
00074 
00076             // should be set once, when the file is created, and should be left alone
00077             // on subsequent save/reload operations.
00078             // 
00079             // Below are the default properties, but application vendors can add new
00080             // properties under this parent property.
00081             KFbxProperty                    Original;
00082 
00083             KFbxTypedProperty<fbxString>    Original_ApplicationVendor;     // "CompanyName"
00084             KFbxTypedProperty<fbxString>    Original_ApplicationName;       // "UberGizmo"
00085             KFbxTypedProperty<fbxString>    Original_ApplicationVersion;    // "2009.10"
00086 
00087             KFbxTypedProperty<fbxString>    Original_FileName;              // "foo.bar"
00088 
00090             KFbxTypedProperty<fbxDateTime>  Original_DateTime_GMT;
00091 
00093             // should be updated everytime a file is saved.
00094             // 
00095             // Below are the default properties, but application vendors can add new
00096             // properties under this parent property.
00097             // 
00098             // It is up to the file creator to set both the 'Original' and
00099             // 'Last Saved' properties.
00100             KFbxProperty                    LastSaved;
00101 
00102             KFbxTypedProperty<fbxString>    LastSaved_ApplicationVendor;
00103             KFbxTypedProperty<fbxString>    LastSaved_ApplicationName;
00104             KFbxTypedProperty<fbxString>    LastSaved_ApplicationVersion;
00105 
00107             KFbxTypedProperty<fbxDateTime>  LastSaved_DateTime_GMT;
00108 
00114             KFbxTypedProperty<fbxString>    EmbeddedUrl;
00116 
00117 
00123         public:
00125             KString mTitle;
00126 
00128             KString mSubject;
00129 
00131             KString mAuthor;
00132 
00134             KString mKeywords;
00135 
00137             KString mRevision;
00138 
00140             KString mComment;
00142 
00146 
00150             KFbxThumbnail* GetSceneThumbnail();
00151 
00155             void SetSceneThumbnail(KFbxThumbnail* pSceneThumbnail);
00157 
00162         void Clear();
00163 
00165         KFbxDocumentInfo& operator=(const KFbxDocumentInfo& pDocumentInfo);
00166 
00168         //
00169         //  WARNING!
00170         //
00171         //  Anything beyond these lines may not be documented accurately and is 
00172         //  subject to change without notice.
00173         //
00175         #ifndef DOXYGEN_SHOULD_SKIP_THIS
00176 
00177             public:
00178                 virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00179 
00180             protected:
00182                 KFbxDocumentInfo(KFbxSdkManager& pManager,char const *pName);
00183                 ~KFbxDocumentInfo();
00184                 virtual void Construct  (const KFbxDocumentInfo* pFrom);
00185                 virtual void Destruct   (bool pRecursive, bool pDependents);
00186                 bool    ConstructProperties(bool pForceSet);
00187 
00188                 KFbxThumbnail*  mSceneThumbnail;
00189 
00190                 friend class KStreamFbx;
00191             #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS 
00192     };
00193 
00194     typedef KFbxDocumentInfo* HKFbxDocumentInfo;
00195 
00196     // Backward compatibility
00197     // --------------------------------------------------------------
00198 
00199 //  typedef KFbxDocumentInfo* HKFbxDocumentInfo;
00200 //  typedef KFbxDocumentInfo* HKFbxDocumentInfo;
00201 
00202 #include <fbxfilesdk_nsend.h>
00203 
00204 #endif // #ifndef _FBXSDK_SCENE_INFO_H_
00205 
00206