Public API Reference

ivaria/sequence.h

Go to the documentation of this file.

/*
    Copyright (C) 2001 by Jorrit Tyberghein

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_IVARIA_SEQUENCE_H__
#define __CS_IVARIA_SEQUENCE_H__

#include "csutil/scf_interface.h"

struct iSequenceOperation : public virtual iBase
{
  SCF_INTERFACE (iSequenceOperation, 2, 0, 0);
  virtual void Do (csTicks dt, iBase* params) = 0;

  virtual void CleanupSequences () = 0;
};

struct iSequenceCondition : public virtual iBase
{
  SCF_INTERFACE (iSequenceCondition, 1, 0, 0);

  virtual bool Condition (csTicks dt, iBase* params) = 0;
};

struct csSequenceOp
{
  csSequenceOp* next, * prev;
  csTicks time;
  csRef<iBase> params;
  csRef<iSequenceOperation> operation;
  // Unique id to identify all operations belonging to a running sequence.
  uint sequence_id;

  csSequenceOp () { }
  ~csSequenceOp () { }
};


struct iSequence : public virtual iBase
{
  SCF_INTERFACE (iSequence, 1, 0, 0);

  virtual csSequenceOp* GetFirstSequence () = 0;

  virtual void AddOperation (csTicks time, iSequenceOperation* operation,
        iBase* params = 0, uint sequence_id = 0) = 0;

  virtual void AddRunSequence (csTicks time, iSequence* sequence,
        iBase* params = 0, uint sequence_id = 0) = 0;

  virtual void AddCondition (csTicks time, iSequenceCondition* condition,
        iSequence* trueSequence, iSequence* falseSequence,
        iBase* params = 0, uint sequence_id = 0) = 0;

  virtual void AddLoop (csTicks time, iSequenceCondition* condition,
        iSequence* sequence, iBase* params = 0, uint sequence_id = 0) = 0;

  virtual void Clear () = 0;

  virtual bool IsEmpty () = 0;
};

struct iSequenceManager : public virtual iBase
{
  SCF_INTERFACE (iSequenceManager, 1, 0, 0);

  virtual void Clear () = 0;

  virtual bool IsEmpty () = 0;

  virtual void Suspend () = 0;

  virtual void Resume () = 0;

  virtual bool IsSuspended () = 0;

  virtual void TimeWarp (csTicks time, bool skip) = 0;

  virtual csTicks GetMainTime () const = 0;

  virtual csTicks GetDeltaTime () const = 0;

  virtual csPtr<iSequence> NewSequence () = 0;

  virtual void RunSequence (csTicks time, iSequence* sequence,
        iBase* params = 0, uint sequence_id = 0) = 0;

  virtual void DestroySequenceOperations (uint sequence_id) = 0;

  virtual uint GetUniqueID () = 0;
};

#endif // __CS_IVARIA_SEQUENCE_H__

---