Mixer.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 _MIXER_H
00025 #define _MIXER_H
00026 
00027 #include "Template.h"
00028 
00029 // Forward declaration
00030 class CSLAction;
00031 class CSLTrack;
00032 
00047 class XSIEXPORT CSLMixer
00048     : public CSLTemplate
00049 {
00050 public:
00056     CSLMixer(CSLScene* in_pScene, CSLModel *in_pModel, CdotXSITemplate* in_pTemplate);
00057     virtual ~CSLMixer();
00058     
00062     virtual SI_Error Synchronize();
00063 
00067     CSLTemplate::ETemplateType Type(){ return CSLTemplate::XSI_MIXER; }
00068 
00072     SI_Bool GetActive();
00073 
00077     SI_Void SetActive( SI_Bool in_bNew );
00078 
00082     SI_Bool GetAutoTransition();
00083 
00087     SI_Void SetAutoTransition( SI_Bool in_bNew );
00088 
00097     SI_Bool GetMaintainContinuity();
00098 
00108     SI_Void SetMaintainContinuity( SI_Bool in_bNew );
00109 
00116     SI_Bool GetNormalize();
00117 
00125     SI_Void SetNormalize( SI_Bool in_bNew );
00126 
00135     SI_Bool GetQuaternionMixing();
00136 
00145     SI_Void SetQuaternionMixing( SI_Bool in_bNew );
00146 
00150     SI_Bool GetRemoveSpins();
00151 
00162     SI_Void SetRemoveSpins( SI_Bool in_bNew );
00163 
00164     // Actions functionality //////////////////////////////////////////////////
00165 
00171     SI_Error RemoveAction( SI_Int in_nIndex );
00172 
00178     SI_Error RemoveAction( CSLAction *in_pToRemove );
00179 
00183     CSLAction** GetActionList();
00184 
00188     SI_Int GetActionCount();
00189 
00193     virtual CSLAction* AddAction();
00194 
00198     SI_Error ClearActions();
00199 
00204     CSLAction* ConnectAction(CSLAction* in_pNewAction);
00205 
00210     CSLAction* FindAction(SI_Char* in_pActionName);
00211 
00212     // Tracks functionality //////////////////////////////////////////////////
00213     
00219     SI_Error RemoveTrack( SI_Int in_nIndex );
00220 
00226     SI_Error RemoveTrack( CSLTrack *io_pToRemove );
00227 
00231     CSLTrack** GetTrackList();
00232 
00236     SI_Int GetTrackCount();
00237 
00241     CSLTrack* AddTrack();
00242 
00246     SI_Error ClearTracks();
00247 
00252     CSLTrack* ConnectTrack(CSLTrack* in_pNewTrack);
00253     
00254     CSLBoolProxy* GetAutoTransitionProxy() { return &m_AutoTransition; };
00255     CSLBoolProxy* GetActiveProxy() { return &m_Active; };
00256     CSLBoolProxy* GetNormalizeProxy() { return &m_Normalize; };
00257     CSLBoolProxy* GetQuaternionMixingProxy() { return &m_QuaternionMixing; };
00258     CSLBoolProxy* GetRemoveSpinsProxy() { return &m_RemoveSpins; };
00259     CSLBoolProxy* GetMaintainContinuityProxy() { return &m_MaintainContinuity; };
00260 
00261 private:
00262     CSLBoolProxy m_AutoTransition;
00263     CSLBoolProxy m_Active;
00264     CSLBoolProxy m_Normalize;
00265     CSLBoolProxy m_QuaternionMixing;
00266     CSLBoolProxy m_RemoveSpins;
00267     CSLBoolProxy m_MaintainContinuity;
00268     CSIBCArray<CSLAction *> m_Actions;
00269     CSIBCArray<CSLTrack *> m_Tracks;
00270 
00271     SI_Void *m_pReserved;
00272 };
00273 
00274 #endif // _MIXER_H