FBX SDK Reference Guide: kfbxsurfacematerial.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXPLUGINS_KFBXSURFACEMATERIAL_H
00005 #define FBXFILESDK_KFBXPLUGINS_KFBXSURFACEMATERIAL_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/components/kbaselib/kaydara.h>
00044 
00045 #include <fbxfilesdk/kfbxplugins/kfbxtakenodecontainer.h>
00046 #include <fbxfilesdk/kfbxplugins/kfbxcolor.h>
00047 #include <fbxfilesdk/kfbxplugins/kfbxgroupname.h>
00048 
00049 // FBX includes
00050 #include <fbxfilesdk/fbx3d/fbxshaders/kfbxshadingobject.h>
00051 
00052 // FBX namespace
00053 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00054 
00061 class KFBX_DLL KFbxSurfaceMaterial : public KFbxShadingObject
00062 {
00063     KFBXOBJECT_DECLARE(KFbxSurfaceMaterial,KFbxShadingObject);
00064 
00065 public:
00070 
00071     static char const* sShadingModel;
00072     static char const* sMultiLayer;
00073     
00074     static char const* sEmissive;
00075     static char const* sEmissiveFactor;
00076     
00077     static char const* sAmbient;
00078     static char const* sAmbientFactor;
00079     
00080     static char const* sDiffuse;
00081     static char const* sDiffuseFactor;
00082     
00083     static char const* sSpecular;
00084     static char const* sSpecularFactor;
00085     static char const* sShininess;
00086     
00087     static char const* sBump;
00088     static char const* sNormalMap;
00089     static char const* sBumpFactor;
00090 
00091     static char const* sTransparentColor;
00092     static char const* sTransparencyFactor;
00093     
00094     static char const* sReflection;
00095     static char const* sReflectionFactor;
00096     
00098 
00103 
00105     void Reset();
00106     
00110     KFbxPropertyString GetShadingModel() const;
00111 
00115     KFbxPropertyBool1 GetMultiLayer() const;
00116     
00118 
00120     // Static values
00122 
00123     // Default property values
00124     static fbxBool1     sMultiLayerDefault;
00125     static char const*  sShadingModelDefault;
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     // Clone
00139     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType = eDEEP_CLONE) const;
00140 
00141 protected:
00142     bool SetColorParameter(KFbxProperty pProperty, KFbxColor const& pColor);
00143     bool GetColorParameter(KFbxProperty pProperty, KFbxColor& pColor) const;
00144     bool SetDoubleParameter(KFbxProperty pProperty, double pDouble);
00145     bool GetDoubleParameter(KFbxProperty pProperty, double pDouble) const;
00146     
00147     KFbxSurfaceMaterial(KFbxSdkManager& pManager, char const* pName);
00148     virtual ~KFbxSurfaceMaterial();
00149 
00150     virtual bool ConstructProperties(bool pForceSet);
00151     virtual void Destruct(bool pRecursive, bool pDependents);
00152 
00154     KFbxSurfaceMaterial& operator=(KFbxSurfaceMaterial const& pMaterial);
00155 
00156 public:
00157     // Comparison operator
00158     bool operator==(KFbxSurfaceMaterial const& pMaterial) const;
00159 
00160     // From KFbxObject
00161     virtual KString     GetTypeName() const;
00162     virtual KStringList GetTypeFlags() const;
00163 
00164 protected:
00165     KFbxPropertyString ShadingModel;
00166     KFbxPropertyBool1 MultiLayer;
00167 
00168     friend class KFbxLayerContainer;
00169 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS 
00170 };
00171 
00172 typedef KFbxSurfaceMaterial* HKFbxSurfaceMaterial;
00173 
00174 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00175 
00176 #endif // FBXFILESDK_KFBXPLUGINS_KFBXSURFACEMATERIAL_H
00177