ivaria/engseq.h
Go to the documentation of this file.00001 /* 00002 Copyright (C) 2002 by Jorrit Tyberghein 00003 00004 This library is free software; you can redistribute it and/or 00005 modify it under the terms of the GNU Library General Public 00006 License as published by the Free Software Foundation; either 00007 version 2 of the License, or (at your option) any later version. 00008 00009 This library is distributed in the hope that it will be useful, 00010 but WITHOUT ANY WARRANTY; without even the implied warranty of 00011 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00012 Library General Public License for more details. 00013 00014 You should have received a copy of the GNU Library General Public 00015 License along with this library; if not, write to the Free 00016 Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 00017 */ 00018 00019 #ifndef __CS_IVARIA_ENGSEQ_H__ 00020 #define __CS_IVARIA_ENGSEQ_H__ 00021 00022 #include "csutil/scf.h" 00023 00029 struct iLight; 00030 struct iMeshWrapper; 00031 struct iObject; 00032 struct iSector; 00033 struct iSharedVariable; 00034 00035 class csBox3; 00036 class csColor; 00037 class csSphere; 00038 class csVector3; 00039 00040 struct iSequence; 00041 struct iSequenceManager; 00042 struct iSequenceTrigger; 00043 struct iSequenceWrapper; 00044 00046 00049 enum 00050 { 00052 CS_SEQUENCE_LIGHTCHANGE_NONE = 0, 00054 CS_SEQUENCE_LIGHTCHANGE_LESS = 1, 00056 CS_SEQUENCE_LIGHTCHANGE_GREATER = 2 00057 }; 00059 00083 struct iParameterESM : public virtual iBase 00084 { 00085 SCF_INTERFACE (iParameterESM, 1, 0, 0); 00086 00093 virtual iBase* GetValue (iBase* params = 0) const = 0; 00094 00102 virtual bool IsConstant () const = 0; 00103 }; 00104 00129 struct iEngineSequenceParameters : public virtual iBase 00130 { 00131 SCF_INTERFACE (iEngineSequenceParameters, 1, 0, 0); 00132 00136 virtual size_t GetParameterCount () const = 0; 00137 00141 virtual iBase* GetParameter (size_t idx) const = 0; 00142 00146 virtual iBase* GetParameter (const char* name) const = 0; 00147 00151 virtual size_t GetParameterIdx (const char* name) const = 0; 00152 00156 virtual const char* GetParameterName (size_t idx) const = 0; 00157 00163 virtual void AddParameter (const char* name, iBase* def_value = 0) = 0; 00164 00168 virtual void SetParameter (size_t idx, iBase* value) = 0; 00169 00173 virtual void SetParameter (const char* name, iBase* value) = 0; 00174 00181 virtual csPtr<iParameterESM> CreateParameterESM (const char* name) = 0; 00182 }; 00183 00206 struct iSequenceWrapper : public virtual iBase 00207 { 00208 SCF_INTERFACE (iSequenceWrapper, 1, 0, 0); 00212 virtual iObject* QueryObject () = 0; 00213 00222 virtual iSequence* GetSequence () = 0; 00223 00231 virtual iEngineSequenceParameters* CreateBaseParameterBlock () = 0; 00232 00237 virtual iEngineSequenceParameters* GetBaseParameterBlock () = 0; 00238 00250 virtual csPtr<iEngineSequenceParameters> CreateParameterBlock () = 0; 00251 00263 virtual void AddOperationSetVariable (csTicks time, 00264 iSharedVariable* var, float value, float dvalue = 0) = 0; 00265 00278 virtual void AddOperationSetVariable (csTicks time, 00279 iSharedVariable* var, iSharedVariable* value, 00280 iSharedVariable* dvalue = 0) = 0; 00281 00288 virtual void AddOperationSetVariable (csTicks time, 00289 iSharedVariable* var, const csVector3& v) = 0; 00290 00297 virtual void AddOperationSetVariable (csTicks time, 00298 iSharedVariable* var, const csColor& c) = 0; 00299 00307 virtual void AddOperationSetMaterial (csTicks time, iParameterESM* mesh, 00308 iParameterESM* mat) = 0; 00309 00319 CS_DEPRECATED_METHOD_MSG("Deprecated since thing objects are deprecated.") 00320 virtual void AddOperationSetPolygonMaterial (csTicks time, 00321 iParameterESM* polygon, iParameterESM* mat) = 0; 00322 00330 virtual void AddOperationSetLight (csTicks time, iParameterESM* light, 00331 const csColor& color) = 0; 00332 00343 virtual void AddOperationFadeLight (csTicks time, iParameterESM* light, 00344 const csColor& color, csTicks duration) = 0; 00345 00355 virtual void AddOperationSetAmbient (csTicks time, iParameterESM* sector, 00356 const csColor& color, iSharedVariable *colorvar) = 0; 00357 00368 virtual void AddOperationFadeAmbient (csTicks time, iParameterESM* sector, 00369 const csColor& color, csTicks duration) = 0; 00370 00378 virtual void AddOperationRandomDelay (csTicks time, int min, int max) = 0; 00379 00387 virtual void AddOperationSetMeshColor (csTicks time, iParameterESM* mesh, 00388 const csColor& color) = 0; 00389 00400 virtual void AddOperationFadeMeshColor (csTicks time, iParameterESM* mesh, 00401 const csColor& color, csTicks duration) = 0; 00402 00411 virtual void AddOperationSetFog (csTicks time, iParameterESM* sector, 00412 const csColor& color, float density) = 0; 00413 00425 virtual void AddOperationFadeFog (csTicks time, iParameterESM* sector, 00426 const csColor& color, float density, csTicks duration) = 0; 00427 00450 virtual void AddOperationRotateDuration (csTicks time, iParameterESM* mesh, 00451 int axis1, float tot_angle1, 00452 int axis2, float tot_angle2, 00453 int axis3, float tot_angle3, 00454 const csVector3& offset, 00455 csTicks duration, bool relative = false) = 0; 00456 00467 virtual void AddOperationMoveDuration (csTicks time, iParameterESM* mesh, 00468 const csVector3& offset, csTicks duration) = 0; 00469 00477 virtual void AddOperationTriggerState (csTicks time, 00478 iParameterESM* trigger, bool en) = 0; 00479 00489 virtual void AddOperationCheckTrigger (csTicks time, 00490 iParameterESM* trigger, csTicks delay) = 0; 00491 00505 virtual void AddOperationTestTrigger (csTicks time, 00506 iParameterESM* trigger, 00507 iSequence* trueSequence, 00508 iSequence* falseSequence) = 0; 00509 }; 00510 00527 struct iSequenceTrigger : public virtual iBase 00528 { 00529 SCF_INTERFACE (iSequenceTrigger, 0, 0, 3); 00530 00534 virtual iObject* QueryObject () = 0; 00535 00539 virtual void AddConditionInSector (iSector* sector) = 0; 00540 00544 virtual void AddConditionInSector (iSector* sector, 00545 const csBox3& box) = 0; 00546 00550 virtual void AddConditionInSector (iSector* sector, 00551 const csSphere& sphere) = 0; 00552 00556 virtual void AddConditionSectorVisible (iSector* sector) = 0; 00557 00561 virtual void AddConditionMeshClick (iMeshWrapper* mesh) = 0; 00562 00574 virtual void AddConditionLightChange (iLight *whichlight, 00575 int oper, const csColor& color) = 0; 00576 00582 virtual void AddConditionManual () = 0; 00583 00588 virtual void SetEnabled (bool en) = 0; 00589 00593 virtual bool IsEnabled () const = 0; 00594 00598 virtual void ClearConditions () = 0; 00599 00603 virtual void Trigger () = 0; 00604 00608 virtual void SetParameters (iEngineSequenceParameters* params) = 0; 00609 00613 virtual iEngineSequenceParameters* GetParameters () const = 0; 00614 00621 virtual void FireSequence (csTicks delay, iSequenceWrapper* seq) = 0; 00622 00626 virtual iSequenceWrapper* GetFiredSequence () = 0; 00627 00633 virtual void TestConditions (csTicks delay) = 0; 00634 00642 virtual bool CheckState () = 0; 00643 00659 virtual void ForceFire (bool now = false) = 0; 00660 }; 00661 00679 struct iSequenceTimedOperation : public virtual iBase 00680 { 00681 SCF_INTERFACE (iSequenceTimedOperation, 1, 0, 0); 00682 00686 virtual void Do (float time, iBase* params) = 0; 00687 }; 00688 00700 struct iEngineSequenceManager : public virtual iBase 00701 { 00702 SCF_INTERFACE (iEngineSequenceManager, 1, 0, 0); 00703 00708 virtual iSequenceManager* GetSequenceManager () = 0; 00709 00713 virtual csPtr<iParameterESM> CreateParameterESM (iBase* value) = 0; 00714 00715 //----------------------------------------------------------------------- 00716 00720 virtual csPtr<iSequenceTrigger> CreateTrigger (const char* name) = 0; 00721 00725 virtual void RemoveTrigger (iSequenceTrigger* trigger) = 0; 00726 00730 virtual void RemoveTriggers () = 0; 00731 00735 virtual size_t GetTriggerCount () const = 0; 00736 00740 virtual iSequenceTrigger* GetTrigger (size_t idx) const = 0; 00741 00745 virtual iSequenceTrigger* FindTriggerByName (const char* name) const = 0; 00746 00753 virtual bool FireTriggerByName (const char *name, bool now = false) const = 0; 00754 00755 //----------------------------------------------------------------------- 00756 00760 virtual csPtr<iSequenceWrapper> CreateSequence (const char* name) = 0; 00761 00765 virtual void RemoveSequence (iSequenceWrapper* seq) = 0; 00766 00770 virtual void RemoveSequences () = 0; 00771 00775 virtual size_t GetSequenceCount () const = 0; 00776 00780 virtual iSequenceWrapper* GetSequence (size_t idx) const = 0; 00781 00785 virtual iSequenceWrapper* FindSequenceByName (const char* name) const = 0; 00786 00790 virtual bool RunSequenceByName (const char *name,int delay) const = 0; 00791 00792 //----------------------------------------------------------------------- 00793 00808 virtual void FireTimedOperation (csTicks delta, csTicks duration, 00809 iSequenceTimedOperation* op, iBase* params = 0, 00810 uint sequence_id = 0) = 0; 00811 00815 virtual void DestroyTimedOperations (uint sequence_id) = 0; 00816 00817 //----------------------------------------------------------------------- 00818 }; 00819 00820 #endif // __CS_IVARIA_ENGSEQ_H__ 00821
Generated for Crystal Space 1.4.0 by doxygen 1.5.8