ShaderInstanceData.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 _SHADER_INSTANCE_DATA_H
00025 #define _SHADER_INSTANCE_DATA_H
00026 
00027 #include "Template.h"
00028 
00029 class CSLVariantParameter;
00030 
00032 class XSIEXPORT CSLShaderInstanceData
00033     : public CSLTemplate
00034 {
00035 public:
00036 
00043     CSLShaderInstanceData
00044     (
00045         CSLScene* in_pScene, 
00046         CSLModel *in_pModel, 
00047         CdotXSITemplate* in_pTemplate
00048     );
00049 
00052     ~CSLShaderInstanceData();
00053 
00055 
00058     inline ETemplateType Type();
00059 
00063     SI_Error Synchronize();
00064 
00065     // Reference Functionality ////////////////////////////////////////////////////
00066     
00068 
00071     CSLModel* GetReference();
00072 
00074 
00077     SI_Void SetReference( CSLModel* in_pReferedModel);
00078 
00079 
00080     // Parameters Functionality ///////////////////////////////////////////////
00081 
00085     CSLVariantParameter* AddParameter();
00086 
00091     SI_Error RemoveParameter( SI_Int in_nIndex );
00092 
00097     SI_Error RemoveParameter( CSLVariantParameter* in_pToRemove );
00098 
00102     SI_Error ClearParameters();
00103 
00108     CSLVariantParameter* ConnectParameter( CSLVariantParameter* in_pToConnect );
00109 
00113     CSLVariantParameter** GetParameterList();
00114 
00118     SI_Int GetParameterCount();
00119 
00124     virtual CSLAnimatableType* ParameterFromName(SI_Char *in_szName);
00125 
00131     CSLAnimatableType* ParameterFromType(EFCurveType in_Type, SI_Char *in_szParameterName);
00132 
00133 private:
00134     CSLModel *m_pReferedModel;
00135     CSIBCArray<CSLVariantParameter *> m_Parameters;
00136 
00137     SI_Void *m_pReserved;   // reserved for future extension
00138 };
00139 
00140 
00141 #endif // _SHADER_INSTANCE_DATA_H