FBX SDK Reference Guide: kfbximplementation.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXPLUGINS_KFBXIMPLEMENTATION_H 
00005 #define FBXFILESDK_KFBXPLUGINS_KFBXIMPLEMENTATION_H
00006 
00007 /**************************************************************************************
00008 
00009  Copyright © 2006 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/components/kbaselib/kaydara.h>
00044 #include <fbxfilesdk/kfbxplugins/kfbxsdkmanager.h>
00045 #include <fbxfilesdk/kfbxplugins/kfbxobject.h>
00046 
00047 #include <fbxfilesdk/components/kbaselib/klib/kdynamicarray.h>
00048 #include <fbxfilesdk/components/kbaselib/klib/kpair.h>
00049 
00050 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00051 
00052 class KFbxBindingOperator;
00053 class KFbxBindingTable;
00054 
00055 class KFBX_DLL KFbxImplementation : public KFbxObject
00056 {
00057     KFBXOBJECT_DECLARE(KFbxImplementation,KFbxObject);
00058 
00059 public:
00060     // Predefined shader languages
00061     static const char* sHLSL;
00062     static const char* sGLSL;
00063     static const char* sCGFX;
00064     static const char* sMentalRaySL;
00065 
00066     // Predefined rendering apis
00067     static const char* sDirectX;
00068     static const char* sOpenGL;
00069     static const char* sMentalRay;
00070     static const char* sPreview;
00071 
00073     // Shader description
00075 
00076     // Shader Language
00077     KFbxTypedProperty<fbxString>            Language;
00078 
00079     // Shader Language version
00080     KFbxTypedProperty<fbxString>            LanguageVersion;
00081 
00082     // Render API
00083     KFbxTypedProperty<fbxString>            RenderAPI;
00084 
00085     // Render API version
00086     KFbxTypedProperty<fbxString>            RenderAPIVersion;
00087 
00089     // Binding description
00091 
00092     // Root
00093     KFbxTypedProperty<fbxString>            RootBindingName;
00094 
00095     // Constants
00096     KFbxProperty GetConstants() const;
00097 
00103     KFbxBindingTable* AddNewTable( char const* pTargetName, char const* pTargetType );
00104 
00108     KFbxBindingTable const* GetRootTable() const;
00109     KFbxBindingTable* GetRootTable();
00110     
00114     int GetTableCount() const;
00115 
00120     KFbxBindingTable const* GetTable( int pIndex ) const;
00121     KFbxBindingTable* GetTable( int pIndex );
00122 
00127     KFbxBindingTable const* GetTableByTargetName( char const* pName ) const;
00128     KFbxBindingTable* GetTableByTargetName( char const* pName );
00129 
00134     KFbxBindingTable const* GetTableByTargetType( char const* pTargetName ) const;
00135     KFbxBindingTable* GetTableByTargetType( char const* pTargetName );
00136 
00137     
00143     KFbxBindingOperator* AddNewBindingOperator( char const* pTargetName, char const* pFunctionName );
00144 
00148     int GetBindingOperatorCount() const;
00149 
00154     KFbxBindingOperator const* GetOperatorByTargetName( char const* pTargetName ) const;
00155 
00157     // Static values
00159 
00160     // property names
00161     static const char* sLanguage;
00162     static const char* sLanguageVersion;
00163     static const char* sRenderAPI;                  
00164     static const char* sRenderAPIVersion;
00165     static const char* sRootBindingName;
00166     static const char* sConstants;
00167 
00168     // property default values
00169     static const char* sDefaultType;
00170     static const char* sDefaultLanguage;
00171     static const char* sDefaultLanguageVersion;
00172     static const char* sDefaultRenderAPI;
00173     static const char* sDefaultRenderAPIVersion;
00174     static const char* sDefaultRootBindingName;
00175 
00177 //
00178 //  WARNING!
00179 //
00180 //  Anything beyond these lines may not be documented accurately and is 
00181 //  subject to change without notice.
00182 //
00184 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00185 
00186 public:
00187 
00188     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00189 
00190 protected:
00191 
00192     // Constructor / Destructor
00193     KFbxImplementation(KFbxSdkManager& pManager, char const* pName);
00194     virtual ~KFbxImplementation();
00195     virtual bool ConstructProperties(bool pForceSet);
00196     virtual void Destruct   (bool pRecursive, bool pDependents);
00197 
00198     virtual KFbxImplementation& operator= (KFbxImplementation const& pImplementation);
00199 
00200 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00201 };
00202 
00203 
00204 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00205 
00206 #endif // FBXFILESDK_KFBXPLUGINS_KFBXIMPLEMENTATION_H
00207