CustomParamInfo.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 _CUSTOMPARAMINFO_H
00025 #define _CUSTOMPARAMINFO_H
00026 
00027 #include "Template.h"
00028 #include "VariantParameter.h"
00029 
00030 class CSLCustomPSet;
00031 
00033 
00045 class XSIEXPORT CSLXSICustomParamInfo
00046     : public CSLTemplate
00047 {
00048     friend CSLXSICustomParamInfo* CSLCustomParameter::ConnectCustomParamInfo(CSLXSICustomParamInfo*);
00049 public:
00059     typedef enum
00060     {
00061         SI_ANIMATABLE           = 1,    
00062         SI_READ_ONLY            = 2,    
00063         SI_PERSISTABLE          = 4,    
00064         SI_NOT_INSPECTABLE      = 8,    
00065         SI_SILENT               = 16,   
00066         SI_NOT_PSET_PERSISTABLE = 128,  
00067         SI_TEXTURABLE           = 256,  
00068     } ECapabilitiesFlag;
00069 
00076     CSLXSICustomParamInfo(CSLScene* in_pScene, CSLModel *in_pModel, CdotXSITemplate* in_pTemplate, CSLVariantParameter *in_pParameter = 0);
00077     virtual ~CSLXSICustomParamInfo();
00078 
00079     SI_Error Synchronize();
00080 
00084     ETemplateType Type(){ return XSI_CUSTOM_PARAM_INFO; }
00085 
00091     SI_Error GetMinValue( SI_TinyVariant &out_Value );
00092 
00096     CSLVariantProxy& GetMinValue();
00097 
00103     SI_Error SetMinValue( const CSLVariantProxy &in_Value );
00104 
00110     SI_Error SetMinValue( const SI_TinyVariant &in_Value );
00111     
00117     SI_Error GetMaxValue( SI_TinyVariant &out_Value );
00118 
00122     CSLVariantProxy& GetMaxValue();
00123     
00129     SI_Error SetMaxValue( const CSLVariantProxy &in_Value );
00130 
00136     SI_Error SetMaxValue( const SI_TinyVariant &in_Value );
00137 
00154     SI_ULong GetCapabilities();
00155 
00172     SI_Void SetCapabilities( SI_ULong in_ulValue );
00173 
00174 private:
00175     void SetParameter( CSLVariantParameter *in_pParam ){ m_pParameter = in_pParam; }
00176     CSLVariantProxy m_MinValue;
00177     CSLVariantProxy m_MaxValue;
00178     CSLULongProxy m_Capabilities;
00179     
00180     CSLVariantParameter *m_pParameter;
00181 
00182     SI_Void *m_pReserved;
00183 };
00184 
00185 #endif