CEL

Public API Reference

iCelSequenceFactory Struct Reference

A representation of a sequence factory. More...

#include <tools/sequences.h>

Inheritance diagram for iCelSequenceFactory:

List of all members.

Public Member Functions

virtual void AddDelay (const char *delay)=0
 Add a delay.
virtual void AddSeqOpFactory (iSeqOpFactory *seqopfact, const char *duration)=0
 Add a new operation factory at the specified time.
virtual const char * GetName () const =0
 Get the name of this factory.
virtual iSeqOpFactoryGetSeqOpFactory (size_t idx) const =0
 Get a specific seqop factory.
virtual size_t GetSeqOpFactoryCount () const =0
 Get the amount of seqop factories.
virtual const char * GetSeqOpFactoryDuration (size_t idx) const =0
 Return the parameter string for the duration.
virtual void RemoveSeqOpFactory (size_t idx)=0
 Remove a seqop factory.
virtual void SetName (const char *name)=0
 Set the name of this factory.
virtual void UpdateSeqOpFactory (size_t idx, iSeqOpFactory *seqopfact, const char *duration)=0
 Update an operation factory at a specific index.

Detailed Description

A representation of a sequence factory.

A sequence factory is basically a sequence of sequence operation factories.

Definition at line 191 of file sequences.h.


Member Function Documentation

virtual void iCelSequenceFactory::AddDelay ( const char *  delay  )  [pure virtual]

Add a delay.

Parameters:
delay is a the delay or a parameter.
virtual void iCelSequenceFactory::AddSeqOpFactory ( iSeqOpFactory seqopfact,
const char *  duration 
) [pure virtual]

Add a new operation factory at the specified time.

Parameters:
seqopfact is the factory to add.
duration is the duration of this operation. This can be a string representing a numerical value or a parameter ($x notation). The duration can be 0 in which case we have a single-stop event.
virtual const char* iCelSequenceFactory::GetName (  )  const [pure virtual]

Get the name of this factory.

virtual iSeqOpFactory* iCelSequenceFactory::GetSeqOpFactory ( size_t  idx  )  const [pure virtual]

Get a specific seqop factory.

Returns 0 if it is a delay.

virtual size_t iCelSequenceFactory::GetSeqOpFactoryCount (  )  const [pure virtual]

Get the amount of seqop factories.

virtual const char* iCelSequenceFactory::GetSeqOpFactoryDuration ( size_t  idx  )  const [pure virtual]

Return the parameter string for the duration.

virtual void iCelSequenceFactory::RemoveSeqOpFactory ( size_t  idx  )  [pure virtual]

Remove a seqop factory.

Note that a delay also counts as such a factory.

virtual void iCelSequenceFactory::SetName ( const char *  name  )  [pure virtual]

Set the name of this factory.

virtual void iCelSequenceFactory::UpdateSeqOpFactory ( size_t  idx,
iSeqOpFactory seqopfact,
const char *  duration 
) [pure virtual]

Update an operation factory at a specific index.


The documentation for this struct was generated from the following file:

Generated for CEL: Crystal Entity Layer 2.1 by doxygen 1.6.1