paramdesc.h

Go to the documentation of this file.

/* === S Y N F I G ========================================================= */
/* ========================================================================= */

/* === S T A R T =========================================================== */

#ifndef __SYNFIG_PARAMDESC_H
#define __SYNFIG_PARAMDESC_H

/* === H E A D E R S ======================================================= */

#include "string.h"
#include "real.h"
#include "color.h"
#include "interpolation.h"
#include <list>

/* === M A C R O S ========================================================= */

/* === T Y P E D E F S ===================================================== */

/* === C L A S S E S & S T R U C T S ======================================= */

namespace synfig {

class ValueBase;

class ParamDesc
{
public:

    struct EnumData
    {
        int value;
        String name;
        String local_name;
        EnumData(int value, const String &name, const String &local_name):
            value(value),
            name(name),
            local_name(local_name)
        {
        }
    };

    /*
 -- ** -- D A T A -------------------------------------------------------------
    */

private:
    String name_;           
    String local_name_;     
    String desc_;           
    String group_;          
    String hint_;           
    String origin_;         
    String connect_;
    String box_;
    Real scalar_;           
    bool exponential_;      
    bool critical_;
    bool hidden_;
    bool invisible_duck_;
    bool is_distance_;
    bool animation_only_;
    bool static_;
    Interpolation interpolation_;

    std::list<EnumData> enum_list_;

    /*
 -- ** -- C O N S T R U C T O R S ---------------------------------------------
    */

public:

    ParamDesc(const String &a="IM_A_BUG_SO_REPORT_ME"):
        name_           (a),
        local_name_     (a),
        scalar_         (1.0),
        exponential_        (false),
        critical_       (true),
        hidden_         (false),
        invisible_duck_ (false),
        is_distance_    (false),
        animation_only_ (false),
        static_         (false),
        interpolation_  (INTERPOLATION_UNDEFINED)
    { }

    ParamDesc(const ValueBase&, const String &a);

    /*
 -- ** -- M E M B E R   F U N C T I O N S -------------------------------------
    */

public:

    const std::list<EnumData> &get_enum_list()const { return enum_list_; }

    ParamDesc &set_local_name(const String &n) { local_name_=n; return *this; }

    ParamDesc &set_description(const String &d) { desc_=d; return *this; }

    ParamDesc &set_group(const String &n) { group_=n; return *this; }

    ParamDesc &set_hint(const String &h) { hint_=h; return *this; }

    ParamDesc &set_connect(const String &h) { connect_=h; return *this; }

    ParamDesc &set_box(const String &h) { box_=h; return *this; }

    ParamDesc &set_invisible_duck(bool x=true) { invisible_duck_=x; return *this; }

    bool get_invisible_duck() { return invisible_duck_; }


    ParamDesc &set_animation_only(bool x=true) { animation_only_=x; return *this; }

    bool get_animation_only() { return animation_only_; }


    ParamDesc &set_origin(const String &h) { origin_=h; return *this; }


    ParamDesc &set_scalar(const Real &n) { scalar_=n; return *this; }
    

    ParamDesc &set_exponential(bool x=true) { exponential_=x; return *this; }

    ParamDesc &not_critical() { critical_=false; return *this; }

    ParamDesc &hidden() { hidden_=true; return *this; }


    ParamDesc &read_only() { return *this; }


    ParamDesc &write_only() { return *this; }


    ParamDesc &add_enum_value(int val, const String &enum_name,const String &enum_local_name)
        { enum_list_.push_back(EnumData(val,enum_name,enum_local_name)); return *this; }

    const String &get_local_name()const { return local_name_; }

    const String &get_name()const { return name_; }

    const String &get_description()const { return desc_; }

    const String &get_group()const { return group_; }

    const String &get_hint()const { return hint_; }

    const String &get_origin()const { return origin_; }

    const String &get_connect()const { return connect_; }

    const String &get_box()const { return box_; }

    const Real &get_scalar()const { return scalar_; }
    

    bool get_exponential()const {return exponential_; }

    bool get_critical()const { return critical_; }

    bool get_hidden()const { return hidden_; }
    
    bool get_static()const { return static_; }
    ParamDesc &set_static(bool s) { static_=s; return *this; }

    Interpolation get_interpolation()const { return interpolation_; }
    ParamDesc &set_interpolation(Interpolation i) { interpolation_=i; return *this; }

    ParamDesc& set_is_distance(bool x=true) { is_distance_=x; return *this;}
    bool get_is_distance()const { return is_distance_; }
}; // END of class ParamDesc

class ParamVocab : public std::list< ParamDesc >
{
};

}; // END of namespace synfig

/* === E N D =============================================================== */

#endif