GlobalMaterial.h

00001 //***************************************************************************************
00002 //
00003 // File supervisor: Softimage 3D Games & 3D Bridge team
00004 //
00005 // (c) Copyright 2001-2002 Avid Technology, Inc. . All rights reserved.
00006 //
00007 //***************************************************************************************
00008 
00009 /****************************************************************************************
00010 THIS CODE IS PUBLISHED AS A SAMPLE ONLY AND IS PROVIDED "AS IS".
00011 IN NO EVENT SHALL SOFTIMAGE, AVID TECHNOLOGY, INC. AND/OR THEIR RESPECTIVE
00012 SUPPLIERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
00013 DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
00014 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
00015 CONNECTION WITH THE USE OR PERFORMANCE OF THIS CODE .
00016 
00017 COPYRIGHT NOTICE. Copyright © 1999-2002 Avid Technology Inc. . All rights reserved. 
00018 
00019 SOFTIMAGE is a registered trademark of Avid Technology Inc. or its subsidiaries 
00020 or divisions. Windows NT is a registered trademark of Microsoft Corp. All other
00021 trademarks contained herein are the property of their respective owners. 
00022 ****************************************************************************************/
00023 
00024 #ifndef _GLOBALMATERIAL_H
00025 #define _GLOBALMATERIAL_H
00026 
00027 #include "Template.h"
00028 
00029 // Forward declaration
00030 class CSLBaseMaterial;
00031 
00033 class XSIEXPORT CSLGlobalMaterial
00034     : public CSLTemplate
00035 {
00036 public:
00038     enum EPropagationType
00039     {
00040         SI_BRANCH,      
00041         SI_NODE,        
00042         SI_INHERITED    
00043     };
00044 
00046 
00053     CSLGlobalMaterial
00054     (
00055         CSLScene* in_pScene, 
00056         CSLModel *in_pModel, 
00057         CdotXSITemplate* in_pTemplate
00058     );
00059 
00061     ~CSLGlobalMaterial();
00062 
00064 
00067     CSLBaseMaterial* GetMaterial();
00068 
00070 
00073     CSIBCString GetMaterialName();
00074 
00076 
00079     SI_Void SetMaterial( CSLBaseMaterial*  in_pNewMaterial );
00080 
00082 
00085     SI_Void SetMaterialName( const CSIBCString&  in_szNewMaterialName );
00086 
00088 
00091     EPropagationType GetPropagationType();
00092 
00094 
00097     SI_Void SetPropagationType( EPropagationType in_PropagationType );
00098 
00100 
00103     CSLTemplate::ETemplateType Type();
00104 
00106 
00109     SI_Error Synchronize();
00110 
00111 private:
00112     CSLBaseMaterial* m_pMaterial;
00113     CSIBCString m_szMaterialName;
00114     CSLStrEnumProxy<EPropagationType, SI_INHERITED>  m_PropagationType;
00115 
00116     // reserved for future use
00117     SI_Void *m_pReserved;
00118 };
00119 
00120 #endif