Logo Search packages:      
Sourcecode: kdenlive version File versions


                         effectdesc.h  -  description
   begin                : Sun Feb 9 2003
   copyright            : (C) 2003 by Jason Wood
   email                : jasonwood@blueyonder.co.uk

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


#include <qstring.h>
#include <qptrlist.h>
#include <qptrvector.h>

/**A description of an effect. Specifies it's name, the parameters that it takes, the number and type of inputs, etc.
  *@author Jason Wood


class Effect;
class EffectParamDesc;

class EffectDesc {
    EffectDesc(const QString & name, const QString stringId, const QString & tag, const QString & description, const QString & author, EFFECTTYPE type, bool mono = false);

      /** Returns the name of this effect. */
    const QString & name() const;
      /** Returns the description of this effect. */
    const QString & tag() const;
      /** Returns the full text description of this effect. */
    const QString & description() const;
      /** Returns the author name of this effect. */
    const QString & author() const;
      /** Returns the type of this effect (audio/video). */
    EFFECTTYPE type() const;
    const QString & stringId() const;
    bool isMono() const;

      /** Adds an input to this description. An input might be a video stream, and audio stream, or it may require both. */
    void addInput(const QString & name, bool video, bool audio);
      /** Adds an new parameter to this description. Examples of parameters could be opacity level, text, colour, font, etc. */
    void addParameter(EffectParamDesc * param);
    uint numParameters() const;
    EffectParamDesc *parameter(uint index) const;

      /** Creates an effect with the correct number of parameters for this effect description. Use the given preset if one exists.*/
    Effect *createEffect();
      /** Revoke copy ctor */
     EffectDesc(const EffectDesc & copy);
      /** Revoke operator= */
    const EffectDesc & operator=(const Effect & rhs);

      /** The name of this effect, used by the renderer to process the effect. */
    QString m_name;
      /** The description of this effect, text that will be displayed in the effect list */
    QString m_tag;
      /** The full text description of this effect */
    QString m_description;
      /** The author of this effect */
    QString m_author;
      /** The type of this effect (is it audio or video) */
    EFFECTTYPE m_type;
    QString m_id;
    bool m_mono;

     QPtrVector < EffectParamDesc > m_params;


Generated by  Doxygen 1.6.0   Back to index