FBX SDK Reference Guide: kfbxstreamoptions.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXIO_KFBXSTREAMOPTIONS_H
00005 #define FBXFILESDK_KFBXIO_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 <fbxfilesdk/components/kbaselib/kaydaradef_h.h>
00043 #include <fbxfilesdk/kfbxplugins/kfbxsdkmanager.h>
00044 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00045 
00046 
00052 class KFBX_DLL KFbxStreamOptions : public KFbxObject
00053 {
00054     KFBXOBJECT_DECLARE(KFbxStreamOptions,KFbxObject);
00055 
00056 public:
00057 
00058 
00061     virtual void Reset();
00062 
00068     KFbxProperty GetOption(KString& pName);
00069 
00070 
00076     KFbxProperty GetOption(const char* pName);
00077     
00078 
00084     template <class T> inline bool  SetOption(KString& pName, T const &pValue )
00085     {
00086          
00087         KFbxProperty lProperty=this->GetOption(pName);
00088         if(lProperty.IsValid() && FbxTypeOf(pValue) == lProperty.GetPropertyDataType().GetType())
00089         {
00090             lProperty.Set((void*)&pValue, FbxTypeOf(pValue));
00091             return true;
00092         }
00093         return false;
00094     }
00095 
00101     template <class T> inline bool  SetOption(const char* pName, T const &pValue )
00102     {
00103          
00104         KFbxProperty lProperty=this->GetOption(pName);
00105         if(lProperty.IsValid() && FbxTypeOf(pValue) == lProperty.GetPropertyDataType().GetType())
00106         {
00107             lProperty.Set((void*)&pValue, FbxTypeOf(pValue));
00108             return true;
00109         }
00110         return false;
00111     }
00112 
00117     bool SetOption(KFbxProperty pProperty);
00118 
00122     bool CopyFrom(const KFbxStreamOptions* pKFbxStreamOptionsSrc);
00123 
00125 //
00126 //  WARNING!
00127 //
00128 //  Anything beyond these lines may not be documented accurately and is 
00129 //  subject to change without notice.
00130 //
00132 
00133 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00134 
00135 
00136 protected:
00137 
00138     KFbxStreamOptions(KFbxSdkManager& pManager, char const* pName);
00139     virtual ~KFbxStreamOptions();
00140     virtual void Destruct(bool pRecursive, bool pDependents);
00141 
00142 public:
00143     //clone
00144     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00145 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00146 };
00147 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00148 #endif // FBXFILESDK_KFBXIO_KFBXSTREAMOPTIONS_H
00149