EnvelopeList.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 _ENVELOPELIST_H
00025 #define _ENVELOPELIST_H
00026 
00027 #include "Template.h"
00028 
00029 // Forward declaration
00030 class CSLEnvelope;
00031  
00033 class XSIEXPORT CSLEnvelopeList
00034     : public CSLTemplate
00035 {
00036 public:
00043     CSLEnvelopeList(CSLScene* in_pScene, CSLModel *in_pModel, CdotXSITemplate* in_pTemplate);
00044 
00047     virtual ~CSLEnvelopeList();
00048 
00052     virtual CSLEnvelope* AddEnvelope();
00053 
00057     SI_Int GetEnvelopeCount();
00058 
00062     CSLEnvelope** Envelopes();
00063 
00068     SI_Error RemoveEnvelope(SI_Int in_nIndex);
00069 
00074     SI_Error RemoveEnvelope(CSLEnvelope* in_pEnvelope);
00075 
00079     SI_Error ClearEnvelopes();
00080 
00081     // Connection functions
00086     CSLEnvelope* ConnectEnvelope(CSLEnvelope* in_pNewEnvelope);
00087 
00092     virtual SI_Error Synchronize();
00093 
00097     virtual ETemplateType Type() { return SI_ENVELOPE_LIST; }
00098 
00099 private:
00100     CSIBCArray<CSLEnvelope *> m_Envelopes;
00101 
00102     void *m_pReserved;  // reserved for future extension
00103 };
00104 
00105 #endif