kfbxstreamoptionsfbx.h

Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXIO_KFBXSTREAMOPTIONSFBX_H
00005 #define FBXFILESDK_KFBXIO_KFBXSTREAMOPTIONSFBX_H
00006 
00007 /**************************************************************************************
00008 
00009  Copyright (C) 2001 - 2009 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 //#define KFBXSTREAMOPT_FBX_CURRENT_TAKE_NAME "CURRENT TAKE NAME"
00044 //#define KFBXSTREAMOPT_FBX_PASSWORD "PASSWORD"
00045 //#define KFBXSTREAMOPT_FBX_PASSWORD_ENABLE "PASSWORD ENABLE"
00046 //#define KFBXSTREAMOPT_FBX_MODEL "MODEL"
00047 //#define KFBXSTREAMOPT_FBX_TEXTURE "TEXTURE"
00048 //#define KFBXSTREAMOPT_FBX_MATERIAL "MATERIAL"
00049 //#define KFBXSTREAMOPT_FBX_MEDIA "MEDIA"
00050 //#define KFBXSTREAMOPT_FBX_LINK "LINK"
00051 //#define KFBXSTREAMOPT_FBX_SHAPE "SHAPE"
00052 //#define KFBXSTREAMOPT_FBX_GOBO "GOBO"
00053 //#define KFBXSTREAMOPT_FBX_ANIMATION "ANIMATION"
00054 //#define KFBXSTREAMOPT_FBX_CHARACTER "CHARACTER"
00055 //#define KFBXSTREAMOPT_FBX_GLOBAL_SETTINGS "GLOBAL SETTINGS"
00056 //#define KFBXSTREAMOPT_FBX_PIVOT "PIVOT"
00057 //#define KFBXSTREAMOPT_FBX_MERGE_LAYER_AND_TIMEWARP "MERGE LAYER AND TIMEWARP"
00058 //#define KFBXSTREAMOPT_FBX_CONSTRAINT "CONSTRAINT"
00059 //#define KFBXSTREAMOPT_FBX_EMBEDDED "EMBEDDED"
00060 
00061 //#define KFBXSTREAMOPT_FBX_MODEL_COUNT "MODEL COUNT"
00062 //#define KFBXSTREAMOPT_FBX_DEVICE_COUNT "DEVICE COUNT"
00063 //#define KFBXSTREAMOPT_FBX_CHARACTER_COUNT "CHARACTER COUNT"
00064 //#define KFBXSTREAMOPT_FBX_ACTOR_COUNT "ACTOR COUNT"
00065 //#define KFBXSTREAMOPT_FBX_CONSTRAINT_COUNT "CONSTRAINT_COUNT"
00066 //#define KFBXSTREAMOPT_FBX_MEDIA_COUNT "MEDIA COUNT"
00067 //#define KFBXSTREAMOPT_FBX_TEMPLATE "TEMPLATE"
00068 
00069 // Clone every external objects into the document when exporting?    (default: ON)
00070 //#define KFBXSTREAMOPT_FBX_COLLAPSE_EXTERNALS    "COLLAPSE EXTERNALS"
00071 // Can we compress arrays of sufficient size in files?               (default: ON)
00072 //#define KFBXSTREAMOPT_FBX_COMPRESS_ARRAYS       "COMPRESS ARRAYS"
00073 
00074 // ADVANCED OPTIONS -- SHOULD PROBABLY NOT BE IN ANY UI
00075 
00076 // Property to skip when looking for things to embed.
00077 // If you have more than one property to ignore (as is often the case) then you must
00078 // create sub-properties.
00079 // Property names must be the full hiearchical property name (ie: parent|child|child)
00080 //#define KFBXSTREAMOPT_FBX_EMBEDDED_PROPERTIES_SKIP  "EMBEDDED SKIP"
00081 
00082 // Compression level, from 0 (no compression) to 9 (eat your CPU)    (default: speed)
00083 //#define KFBXSTREAMOPT_FBX_COMPRESS_LEVEL        "COMPRESS LEVEL"    
00084 
00085 // Minimum size before compression is even attempted, in bytes.     
00086 //#define KFBXSTREAMOPT_FBX_COMPRESS_MINSIZE      "COMPRESS MINSIZE"
00087 
00088 #include <fbxfilesdk/components/kbaselib/kaydaradef_h.h>
00089 #include <fbxfilesdk/kfbxplugins/kfbxsdkmanager.h>
00090 #include <fbxfilesdk/kfbxio/kfbxstreamoptions.h>
00091 #include <fbxfilesdk/kfbxplugins/kfbxobject.h>
00092 #include <fbxfilesdk/components/kbaselib/klib/karrayul.h>
00093 #include <fbxfilesdk/kfbxplugins/kfbxtakeinfo.h>
00094 #include <fbxfilesdk/fbxcore/fbxcollection/kfbxdocumentinfo.h>
00095 
00096 
00097 
00098 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00099 
00103  // * The content of KfbxStreamOptionsFbx is stored in the inherited Property of its parent (KFbxStreamOptions).
00104  // * The import options include that:
00105  // * KFBXSTREAMOPT_FBX_CURRENT_TAKE_NAME    :Current take name 
00106  // * KFBXSTREAMOPT_FBX_PASSWORD             :The password
00107  // * KFBXSTREAMOPT_FBX_PASSWORD_ENABLE      :If password enable
00108  // * KFBXSTREAMOPT_FBX_MODEL                :If model import
00109  // * KFBXSTREAMOPT_FBX_TEXTURE              :If texture import
00110  // * KFBXSTREAMOPT_FBX_MATERIAL             :If material import
00111  // * KFBXSTREAMOPT_FBX_MEDIA                :If media import
00112  // * KFBXSTREAMOPT_FBX_LINK                 :If link import
00113  // * KFBXSTREAMOPT_FBX_SHAPE                :If shape import
00114  // * KFBXSTREAMOPT_FBX_GOBO                 :If gobo import
00115  // * KFBXSTREAMOPT_FBX_ANIMATION            :If animation import
00116  // * KFBXSTREAMOPT_FBX_CHARACTER            :If character import
00117  // * KFBXSTREAMOPT_FBX_GLOBAL_SETTINGS      :If global settings import
00118  // * KFBXSTREAMOPT_FBX_PIVOT                :If pivot import
00119  // * KFBXSTREAMOPT_FBX_MERGE_LAYER_AND_TIMEWARP  :If merge layer and timewarp
00120  // * KFBXSTREAMOPT_FBX_CONSTRAINT           :If constrain import
00121  // * KFBXSTREAMOPT_FBX_MODEL_COUNT          :The count of model
00122  // * KFBXSTREAMOPT_FBX_DEVICE_COUNT         :The count of device
00123  // * KFBXSTREAMOPT_FBX_CHARACTER_COUNT      :The count of character
00124  // * KFBXSTREAMOPT_FBX_ACTOR_COUNT          :The count of actor
00125  // * KFBXSTREAMOPT_FBX_CONSTRAINT_COUNT     :The count of constrain
00126  // * KFBXSTREAMOPT_FBX_MEDIA_COUNT          :The count of media
00127  // * KFBXSTREAMOPT_FBX_TEMPLATE             :If template import
00128   
00129   
00130 class KFBX_DLL KFbxStreamOptionsFbxReader : public KFbxStreamOptions
00131 {
00132 
00133     KFBXOBJECT_DECLARE(KFbxStreamOptionsFbxReader,KFbxStreamOptions);
00134 public:
00135 
00138 //  *The default values is :
00139 //  * KFBXSTREAMOPT_FBX_CURRENT_TAKE_NAME    :Null
00140 //  * KFBXSTREAMOPT_FBX_PASSWORD             :Null
00141 //  * KFBXSTREAMOPT_FBX_PASSWORD_ENABLE      :false
00142 //  * KFBXSTREAMOPT_FBX_MODEL                :true
00143 //  * KFBXSTREAMOPT_FBX_TEXTURE              :true
00144 //  * KFBXSTREAMOPT_FBX_MATERIAL             :true
00145 //  * KFBXSTREAMOPT_FBX_MEDIA                :true
00146 //  * KFBXSTREAMOPT_FBX_LINK                 :true
00147 //  * KFBXSTREAMOPT_FBX_SHAPE                :true
00148 //  * KFBXSTREAMOPT_FBX_GOBO                 :true
00149 //  * KFBXSTREAMOPT_FBX_ANIMATION            :true
00150 //  * KFBXSTREAMOPT_FBX_CHARACTER            :true
00151 //  * KFBXSTREAMOPT_FBX_GLOBAL_SETTINGS      :true
00152 //  * KFBXSTREAMOPT_FBX_PIVOT                :true
00153 //  * KFBXSTREAMOPT_FBX_MERGE_LAYER_AND_TIMEWARP  :false
00154 //  * KFBXSTREAMOPT_FBX_CONSTRAINT           :true
00155 //  * KFBXSTREAMOPT_FBX_MODEL_COUNT          :0
00156 //  * KFBXSTREAMOPT_FBX_DEVICE_COUNT         :0
00157 //  * KFBXSTREAMOPT_FBX_CHARACTER_COUNT      :0
00158 //  * KFBXSTREAMOPT_FBX_ACTOR_COUNT          :0
00159 //  * KFBXSTREAMOPT_FBX_CONSTRAINT_COUNT     :0
00160 //  * KFBXSTREAMOPT_FBX_MEDIA_COUNT          :0
00161 //  * KFBXSTREAMOPT_FBX_TEMPLATE             :false
00162  
00163     
00164     void Reset();
00165 
00166 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00167 public:
00168     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00169     
00170     KArrayTemplate<HKFbxTakeInfo> mTakeInfo;
00171     HKFbxDocumentInfo mDocumentInfo;
00172     
00173 protected:
00174     KFbxStreamOptionsFbxReader(KFbxSdkManager& pManager, char const* pName);
00175     virtual void Construct(const KFbxStreamOptionsFbxReader* pFrom);
00176     virtual bool ConstructProperties(bool pForceSet);
00177     virtual void Destruct(bool pRecursive, bool pDependents);
00178 #endif
00179 };
00180 
00181 
00182 
00183 
00186 //  * The content of KfbxStreamOptionsFbx is stored in the inherited Property of its parent (KFbxStreamOptions).
00187 //  * The export options include that:
00188 //  * KFBXSTREAMOPT_FBX_CURRENT_TAKE_NAME    :Current take name 
00189 //  * KFBXSTREAMOPT_FBX_PASSWORD             :The password
00190 //  * KFBXSTREAMOPT_FBX_PASSWORD_ENABLE      :If password enable
00191 //  * KFBXSTREAMOPT_FBX_MODEL                :If model export
00192 //  * KFBXSTREAMOPT_FBX_TEXTURE              :If texture export
00193 //  * KFBXSTREAMOPT_FBX_MATERIAL             :If material export
00194 //  * KFBXSTREAMOPT_FBX_MEDIA                :If media export
00195 //  * KFBXSTREAMOPT_FBX_LINK                 :If link export
00196 //  * KFBXSTREAMOPT_FBX_SHAPE                :If shape export
00197 //  * KFBXSTREAMOPT_FBX_GOBO                 :If gobo export
00198 //  * KFBXSTREAMOPT_FBX_ANIMATION            :If animation export
00199 //  * KFBXSTREAMOPT_FBX_CHARACTER            :If character export
00200 //  * KFBXSTREAMOPT_FBX_GLOBAL_SETTINGS      :If global settings export
00201 //  * KFBXSTREAMOPT_FBX_PIVOT                :If pivot export
00202 //  * KFBXSTREAMOPT_FBX_EMBEDDED             :If embedded
00203 //  * KFBXSTREAMOPT_FBX_CONSTRAINT           :If constrain export
00204 //  * KFBXSTREAMOPT_FBX_TEMPLATE             :If template export
00205 //  * KFBXSTREAMOPT_FBX_MODEL_COUNT          :The count of model
00206 //  * KFBXSTREAMOPT_FBX_DEVICE_COUNT         :The count of device
00207 //  * KFBXSTREAMOPT_FBX_CHARACTER_COUNT      :The count of character
00208 //  * KFBXSTREAMOPT_FBX_ACTOR_COUNT          :The count of actor
00209 //  * KFBXSTREAMOPT_FBX_CONSTRAINT_COUNT     :The count of constrain
00210 //  * KFBXSTREAMOPT_FBX_MEDIA_COUNT          :The count of media
00211 //  * KFBXSTREAMOPT_FBX_COLLAPSE_EXTERNALS   :Clone every external objects into the document when exporting
00212 //  * KFBXSTREAMOPT_FBX_COMPRESS_ARRAYS      :If compress arrays of sufficient size in files
00213 //  * KFBXSTREAMOPT_FBX_EMBEDDED_PROPERTIES_SKIP   :Property to skip when looking for things to embed.
00214 //  * KFBXSTREAMOPT_FBX_COMPRESS_LEVEL       :Compression level, from 0 (no compression) to 9
00215 //  * KFBXSTREAMOPT_FBX_COMPRESS_MINSIZE     :Minimum size before compression
00216   
00217  
00218 class KFBX_DLL KFbxStreamOptionsFbxWriter : public KFbxStreamOptions
00219 {
00220     KFBXOBJECT_DECLARE(KFbxStreamOptionsFbxWriter,KFbxStreamOptions);
00221 public:
00222     
00225 //  *The default values is :
00226 //  * KFBXSTREAMOPT_FBX_CURRENT_TAKE_NAME    :Null
00227 //  * KFBXSTREAMOPT_FBX_PASSWORD             :Null
00228 //  * KFBXSTREAMOPT_FBX_PASSWORD_ENABLE      :false
00229 //  * KFBXSTREAMOPT_FBX_MODEL                :true
00230 //  * KFBXSTREAMOPT_FBX_TEXTURE              :true
00231 //  * KFBXSTREAMOPT_FBX_MATERIAL             :true
00232 //  * KFBXSTREAMOPT_FBX_MEDIA                :true
00233 //  * KFBXSTREAMOPT_FBX_LINK                 :true
00234 //  * KFBXSTREAMOPT_FBX_SHAPE                :true
00235 //  * KFBXSTREAMOPT_FBX_GOBO                 :true
00236 //  * KFBXSTREAMOPT_FBX_ANIMATION            :true
00237 //  * KFBXSTREAMOPT_FBX_CHARACTER            :true
00238 //  * KFBXSTREAMOPT_FBX_GLOBAL_SETTINGS      :true
00239 //  * KFBXSTREAMOPT_FBX_PIVOT                :true
00240 //  * KFBXSTREAMOPT_FBX_EMBEDDED             :false
00241 //  * KFBXSTREAMOPT_FBX_CONSTRAINT           :true
00242 //  * KFBXSTREAMOPT_FBX_MODEL_COUNT          :0
00243 //  * KFBXSTREAMOPT_FBX_DEVICE_COUNT         :0
00244 //  * KFBXSTREAMOPT_FBX_CHARACTER_COUNT      :0
00245 //  * KFBXSTREAMOPT_FBX_ACTOR_COUNT          :0
00246 //  * KFBXSTREAMOPT_FBX_CONSTRAINT_COUNT     :0
00247 //  * KFBXSTREAMOPT_FBX_MEDIA_COUNT          :0
00248 //  * KFBXSTREAMOPT_FBX_TEMPLATE             :false
00249 //  * KFBXSTREAMOPT_FBX_COLLAPSE_EXTERNALS   :true
00250 //  * KFBXSTREAMOPT_FBX_COMPRESS_ARRAYS      :true
00251 //  * KFBXSTREAMOPT_FBX_EMBEDDED_PROPERTIES_SKIP  :Null
00252 //  * KFBXSTREAMOPT_FBX_COMPRESS_LEVEL       :1
00253 //  * KFBXSTREAMOPT_FBX_COMPRESS_MINSIZE     :1024
00254   
00255     virtual void Reset();
00256 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00257 public:
00258     
00259     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00260     KArrayTemplate<HKFbxTakeInfo> mTakeInfo;
00261     HKFbxDocumentInfo mDocumentInfo;
00262 protected:
00263     KFbxStreamOptionsFbxWriter(KFbxSdkManager& pManager, char const* pName);
00264     virtual void Construct(const KFbxStreamOptionsFbxWriter* pFrom);
00265     virtual bool ConstructProperties(bool pForceSet);
00266     virtual void Destruct(bool pRecursive, bool pDependents);
00267 #endif
00268 };
00269 
00270 
00271 
00272 
00273 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00274 #endif // FBXFILESDK_KFBXIO_KFBXSTREAMOPTIONSFBX_H
00275