FBX SDK Reference Guide: kfbxstreamoptionsfbx.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef _FBXSDK_KFbxStreamOptionsFbxWriter_H_
00005 #define _FBXSDK_KFbxStreamOptionsFbxWriter_H_
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 
00042 #define KFBXSTREAMOPT_FBX_CURRENT_TAKE_NAME "CURRENT TAKE NAME"
00043 #define KFBXSTREAMOPT_FBX_PASSWORD "PASSWORD"
00044 #define KFBXSTREAMOPT_FBX_PASSWORD_ENABLE "PASSWORD ENABLE"
00045 #define KFBXSTREAMOPT_FBX_MODEL "MODEL"
00046 #define KFBXSTREAMOPT_FBX_TEXTURE "TEXTURE"
00047 #define KFBXSTREAMOPT_FBX_MATERIAL "MATERIAL"
00048 #define KFBXSTREAMOPT_FBX_MEDIA "MEDIA"
00049 #define KFBXSTREAMOPT_FBX_LINK "LINK"
00050 #define KFBXSTREAMOPT_FBX_SHAPE "SHAPE"
00051 #define KFBXSTREAMOPT_FBX_GOBO "GOBO"
00052 #define KFBXSTREAMOPT_FBX_ANIMATION "ANIMATION"
00053 #define KFBXSTREAMOPT_FBX_CHARACTER "CHARACTER"
00054 #define KFBXSTREAMOPT_FBX_GLOBAL_SETTINGS "GLOBAL SETTINGS"
00055 #define KFBXSTREAMOPT_FBX_PIVOT "PIVOT"
00056 #define KFBXSTREAMOPT_FBX_MERGE_LAYER_AND_TIMEWARP "MERGE LAYER AND TIMEWARP"
00057 #define KFBXSTREAMOPT_FBX_CONSTRAINT "CONSTRAINT"
00058 #define KFBXSTREAMOPT_FBX_EMBEDDED "EMBEDDED"
00059 #define KFBXSTREAMOPT_FBX_MODEL_COUNT "MODEL COUNT"
00060 #define KFBXSTREAMOPT_FBX_DEVICE_COUNT "DEVICE COUNT"
00061 #define KFBXSTREAMOPT_FBX_CHARACTER_COUNT "CHARACTER COUNT"
00062 #define KFBXSTREAMOPT_FBX_ACTOR_COUNT "ACTOR COUNT"
00063 #define KFBXSTREAMOPT_FBX_CONSTRAINT_COUNT "CONSTRAINT_COUNT"
00064 #define KFBXSTREAMOPT_FBX_MEDIA_COUNT "MEDIA COUNT"
00065 #define KFBXSTREAMOPT_FBX_TEMPLATE "TEMPLATE"
00066 // Clone every external objects into the document when exporting?    (default: ON)
00067 #define KFBXSTREAMOPT_FBX_COLLAPSE_EXTERNALS    "COLLAPSE EXTERNALS"
00068 // Can we compress arrays of sufficient size in files?               (default: ON)
00069 #define KFBXSTREAMOPT_FBX_COMPRESS_ARRAYS       "COMPRESS ARRAYS"
00070 
00071 // ADVANCED OPTIONS -- SHOULD PROBABLY NOT BE IN ANY UI
00072 
00073 // Property to skip when looking for things to embed.
00074 // If you have more than one property to ignore (as is often the case) then you must
00075 // create sub-properties.
00076 // Property names must be the full hiearchical property name (ie: parent|child|child)
00077 #define KFBXSTREAMOPT_FBX_EMBEDDED_PROPERTIES_SKIP  "EMBEDDED SKIP"
00078 
00079 // Compression level, from 0 (no compression) to 9 (eat your CPU)    (default: speed)
00080 #define KFBXSTREAMOPT_FBX_COMPRESS_LEVEL        "COMPRESS LEVEL"    
00081 
00082 // Minimum size before compression is even attempted, in bytes.     
00083 #define KFBXSTREAMOPT_FBX_COMPRESS_MINSIZE      "COMPRESS MINSIZE"
00084 
00085 #include <kaydaradef.h>
00086 #ifndef KFBX_DLL 
00087     #define KFBX_DLL K_DLLIMPORT
00088 #endif
00089 
00090 #include <kfbxplugins/kfbxsdkmanager.h>
00091 #include <kfbxio/kfbxstreamoptions.h>
00092 #include <kfbxplugins/kfbxobject.h>
00093 #include <klib/karrayul.h>
00094 #include <kfbxplugins/kfbxtakeinfo.h>
00095 #include <fbxcore/fbxcollection/kfbxdocumentinfo.h>
00096 
00097 
00098 
00099 #include <fbxfilesdk_nsbegin.h>
00100 
00129 class KFBX_DLL KFbxStreamOptionsFbxReader : public KFbxStreamOptions
00130 {
00131 
00132     KFBXOBJECT_DECLARE(KFbxStreamOptionsFbxReader,KFbxStreamOptions);
00133 public:
00134 
00162     void Reset();
00163 
00164 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00165 public:
00166     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00167     
00168     KArrayTemplate<HKFbxTakeInfo> mTakeInfo;
00169     HKFbxDocumentInfo mDocumentInfo;
00170     
00171 protected:
00172     KFbxStreamOptionsFbxReader(KFbxSdkManager& pManager, char const* pName);
00173     virtual ~KFbxStreamOptionsFbxReader();
00174     virtual void Construct(const KFbxStreamOptionsFbxReader* pFrom);
00175     virtual bool ConstructProperties(bool pForceSet);
00176     virtual void Destruct(bool pRecursive, bool pDependents);
00177 #endif
00178 };
00179 
00180 
00181 
00182 
00216 class KFBX_DLL KFbxStreamOptionsFbxWriter : public KFbxStreamOptions
00217 {
00218     KFBXOBJECT_DECLARE(KFbxStreamOptionsFbxWriter,KFbxStreamOptions);
00219 public:
00220     
00252     virtual void Reset();
00253 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00254 public:
00255     
00256     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00257     KArrayTemplate<HKFbxTakeInfo> mTakeInfo;
00258     HKFbxDocumentInfo mDocumentInfo;
00259 protected:
00260     KFbxStreamOptionsFbxWriter(KFbxSdkManager& pManager, char const* pName);
00261     virtual ~KFbxStreamOptionsFbxWriter();
00262     virtual void Construct(const KFbxStreamOptionsFbxWriter* pFrom);
00263     virtual bool ConstructProperties(bool pForceSet);
00264     virtual void Destruct(bool pRecursive, bool pDependents);
00265 #endif
00266 };
00267 
00268 
00269 
00270 
00271 #include <fbxfilesdk_nsend.h>
00272 #endif