FBX SDK Reference Guide: kfbxstreamoptions.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef _FBXSDK_KFBXSTREAMOPTIONS_H_
00005 #define _FBXSDK_KFBXSTREAMOPTIONS_H_
00006 
00007 /**************************************************************************************
00008 
00009  Copyright © 2001 - 2008 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 #include <kaydaradef.h>
00043 #ifndef KFBX_DLL 
00044     #define KFBX_DLL K_DLLIMPORT
00045 #endif
00046 
00047 #include <kfbxplugins/kfbxsdkmanager.h>
00048 #include <fbxfilesdk_nsbegin.h>
00049 
00050 
00056 class KFBX_DLL KFbxStreamOptions : public KFbxObject
00057 {
00058     KFBXOBJECT_DECLARE(KFbxStreamOptions,KFbxObject);
00059 
00060 public:
00061 
00062 
00065     virtual void Reset();
00066 
00072     KFbxProperty GetOption(KString& pName);
00073 
00074 
00079     KFbxProperty GetOption(const char* pName);
00080     
00081 
00087     template <class T> inline bool  SetOption(KString& pName, T const &pValue )
00088     {
00089          
00090         KFbxProperty lProperty=this->GetOption(pName);
00091         if(lProperty.IsValid() && FbxTypeOf(pValue) == lProperty.GetPropertyDataType().GetType())
00092         {
00093             lProperty.Set((void*)&pValue, FbxTypeOf(pValue));
00094             return true;
00095         }
00096         return false;
00097     }
00098 
00104     template <class T> inline bool  SetOption(const char* pName, T const &pValue )
00105     {
00106          
00107         KFbxProperty lProperty=this->GetOption(pName);
00108         if(lProperty.IsValid() && FbxTypeOf(pValue) == lProperty.GetPropertyDataType().GetType())
00109         {
00110             lProperty.Set((void*)&pValue, FbxTypeOf(pValue));
00111             return true;
00112         }
00113         return false;
00114     }
00115 
00120     bool SetOption(KFbxProperty pProperty);
00121 
00125     bool CopyFrom(const KFbxStreamOptions* pKFbxStreamOptionsSrc);
00126 
00128 //
00129 //  WARNING!
00130 //
00131 //  Anything beyond these lines may not be documented accurately and is 
00132 //  subject to change without notice.
00133 //
00135 
00136 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00137 
00138 
00139 protected:
00140 
00141     KFbxStreamOptions(KFbxSdkManager& pManager, char const* pName);
00142     virtual ~KFbxStreamOptions();
00143     virtual void Destruct(bool pRecursive, bool pDependents);
00144 
00145 public:
00146     //clone
00147     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00148 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00149 };
00150 #include <fbxfilesdk_nsend.h>
00151 #endif