source: cpp/frams/genetics/geneprops.h @ 1326

// This file is a part of Framsticks SDK.  http://www.framsticks.com/
// Copyright (C) 1999-2024  Maciej Komosinski and Szymon Ulatowski.
// See LICENSE.txt for details.

#ifndef _GENEPROPS_H
#define _GENEPROPS_H

#include <common/nonstd_math.h>
#include <frams/model/model.h>





#define F14_MODIFIERS_BASIC "LlRrCcQqFfMm"
#define F14_MODIFIERS_RARE "EeWwSsAaIi" //An expdef would need to handle many of these properly/specifically to ensure reasonable behavior, and hardly any expdef does. Modifying initial energy of a creature as a result of its genes (Ee) is in general not a good idea, but may make sense in some specific competitive biological simulations. Weight (Ww) works only in water, and in water sinking/going up should usually be caused by real "intentional" activity of a creature, not by its inherited weight. Stamina (Ss) is no longer needed as destructive collisions are not supported, and even if they were, some expdef would need to impose reasonable restrictions on the value of this parameter (e.g. similar to normalizeBiol4()) so there is some cost associated with it, and the specific consequences of destructions should be defined as needed. For assimilation (Aa), there is a dedicated parameter in CreaturesGroup. Ingestion (Ii) influences how fast energy is transferred to Parts of a creature, and optimizing this property may make sense in experiments where energy is present in the environment and can be ingested - if needed, this modifier should be enabled for mutation.
#define F14_MODIFIERS_COLOR "DdGgBb"
#define F14_MODIFIERS_COLOR_SPORADIC "D(0.01)d(0.01)G(0.01)g(0.01)B(0.01)b(0.01)" //add a small chance so that color mutations can rarely occur. Functionally they are neutral so we do not want to waste computational resources on creating and evaluating such duplicate individuals, but it is nice to have visually distinct "lineages" by allowing propagated color genes to be extremely rarely modified. Also, if these color modifiers have positive probability, all newly created sticks are assigned a random color immediately on creation.

#define F14_MODIFIERS     F14_MODIFIERS_BASIC  F14_MODIFIERS_RARE  F14_MODIFIERS_COLOR



class GenePropsOp
{
public:
        virtual ~GenePropsOp() {}
        virtual double increase(double value) const = 0;
        virtual double decrease(double value) const = 0;
        void apply(double &value, char modif) const;
};

class GenePropsOp_Legacy : public GenePropsOp
{
        double minvalue, maxvalue, defvalue, change, revchange;
public:
        GenePropsOp_Legacy(double minvalue, double maxvalue, double defvalue, double change, double revchange = -1);
        double increase(double value) const;
        double decrease(double value) const;
        friend class GenePropsOps_AllChange05;
};

class GenePropsOp_NormalizedAndScaled : public GenePropsOp
{
        GenePropsOp_Legacy normalized;
public:
        GenePropsOp_NormalizedAndScaled(double change) :normalized(-1, 1, 0, change) {}
        virtual double scale(double value) const { return value; }
        virtual double scaleInv(double value) const { return value; }
        double increase(double value) const { return scale(normalized.increase(scaleInv(value))); }
        double decrease(double value) const { return scale(normalized.decrease(scaleInv(value))); }
};

class GenePropsOp_Exponential : public GenePropsOp_NormalizedAndScaled
{
        double a, b, c;
        double log_a;
        bool linear;
public:
        GenePropsOp_Exponential(double minvalue, double maxvalue, double defvalue, double change = 0.5);
        double scale(double) const;
        double scaleInv(double) const;
};

class GenePropsOps
{
public:
        ~GenePropsOps();

        GenePropsOp* length;
        GenePropsOp* curvedness;
        GenePropsOp* weight;
        GenePropsOp* friction;
        GenePropsOp* muscle_power;
        GenePropsOp* assimilation;
        GenePropsOp* stamina;
        GenePropsOp* ingestion;
        GenePropsOp* twist;
        GenePropsOp* energy;
        GenePropsOp* cred, *cgreen, *cblue;
        bool use_normalizebiol4;
};

class GenePropsOps_Legacy : public GenePropsOps
{
public:
        GenePropsOps_Legacy();
};

/**
* Just as legacy (before 2023-06), but the influence of each modifier is uniform and simpler (no normalizeBiol4()).
* This is what is currently used in Framsticks.
*/
class GenePropsOps_AllChange05 : public GenePropsOps_Legacy
{
public:
        GenePropsOps_AllChange05();
};

/**
* Just an experiment with a different scaling of the influence of individual modifier characters to cover
* the entire range of parameter values. After investigations we decided that it does not
* provide any advantages over "AllChange05".
*/
class GenePropsOps_Exponential : public GenePropsOps
{
public:
        GenePropsOps_Exponential();
};

/**
 * Contains physical, biological and other properties of a Part and a Joint (as handled
 * by the f1 and f4 encodings), except for rotation. The constructor initializes properties with
 * default values. In order to change a property, the executeModifier() method
 * should be called. Modification of length, curvedness and twist properties
 * usually affects further sticks, so new sticks should have properties of
 * parents (prop) modified with the prop.propagateAlong() method.
 * "Biological" properties (assimilation, stamina, muscle strength and
 * ingestion) can be normalized after modification with normalizeBiol4().
 * See also geneprops_test.cpp
 */
struct GeneProps
{
public:
        double length;            ///<incremented by L, decremented by l. Physical property, length of stick
        double curvedness;        ///<incremented by C, decremented by c. Curvedness of sticks
        double weight;            ///<incremented by W, decremented by w. Physical property, weight of stick (in water environment light sticks swim on the surface)
        double friction;          ///<incremented by F, decremented by f. Physical property, friction of a stick (sticks will slide on the ground or stick to it)

        double muscle_power;      ///<incremented by M, decremented by m. Biological property, muscle strength (muscle speed). Strong muscles act with bigger force, gain higher speed, can resist bigger stress, and use more energy
        double assimilation;      ///<incremented by A, decremented by a. Biological property, assimilation, photosynthesis (a vertical stick can assimilate twice as much as horizontal one)
        double stamina;           ///<incremented by S, decremented by s. Biological property, stamina (increases chance of survival during fights)
        double ingestion;         ///<incremented by I, decremented by i. Biological property, ingestion (ability to gain/transfer energy from food)

        double twist;             ///<incremented by Q, decremented by q. Twist of a stick
        double energy;            ///<incremented by E, decremented by e. Energy of a creature

        double muscle_bend_range; ///<Used only by conv_f1
        bool muscle_reset_range;  ///<Used only by conv_f1

        double cred;              ///<incremented by D, decremented by d. Part's red color proportion
        double cgreen;            ///<incremented by B, decremented by b. Part's green color proportion
        double cblue;             ///<incremented by G, decremented by g. Part's blue color proportion

        static GeneProps standard_values;
        
        static GenePropsOps* getDefaultOps();
        static void setDefaultOps(GenePropsOps* ops);

        static GenePropsOps* getAllChange05Ops();
        static GenePropsOps* getLegacyOps();
        
        /**
         * Constructor initializing all properties with default values.
         */
        GeneProps();

        /**
         * Normalizes biological properties (muscle_power, assimilation, stamina, and ingestion).
         * This method is called in executeModifier() when any of the biological properties is modified
         * and \a use_normalizebiol4 is true. All values of those properties sum up to 1.
         */
        void normalizeBiol4();

        /**
         * Checks whether the given character is property modifier. If yes, the property
         * is modified and properties are normalized when needed.
         * @param modif character that might be a property modifier
         * @return 0 if the provided character was property modifier, -1 otherwise
         */
        int executeModifier(char modif, GenePropsOps* ops = NULL);

        /**
         * Adjusts current properties for the next stick. In order to set
         * new properties to the created stick, the copy of the previous stick should be created,
         * and propagateAlong() should be used for that copy.
         * @param use_reset_range true if this method should modify muscle_bend_range (used in f1 conversion).
         */
        void propagateAlong(bool use_f1_muscle_reset_range, GenePropsOps* ops = NULL);
};

#endif // _GENEPROPS_H