barsuift.simLife.tree.TreeLeaf Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of simLifeCoreAPI Show documentation

API of the simLifeCore module for the simLife project

There is a newer version: 0.0.5

/**
 * barsuift-simlife is a life simulator programm
 * 
 * Copyright (C) 2010 Cyrille GACHOT
 * 
 * This file is part of barsuift-simlife.
 * 
 * barsuift-simlife 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 3 of the License, or (at your option) any later
 * version.
 * 
 * barsuift-simlife 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 General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU General Public License along with barsuift-simlife. If not, see
 * .
 */
package barsuift.simLife.tree;

import java.math.BigDecimal;

import barsuift.simLife.IObservable;
import barsuift.simLife.LivingPart;
import barsuift.simLife.Percent;
import barsuift.simLife.j3d.tree.TreeLeaf3D;

public interface TreeLeaf extends LivingPart, IObservable {

    public boolean isTooWeak();

    public TreeLeaf3D getTreeLeaf3D();

    public TreeLeafState getState();

    /**
     * Return the efficiency of the leaf. This efficiency impacts the amount of solar energy which can be collected.
     * 
     * @return the efficiency
     */
    public Percent getEfficiency();

    /**
     * Return the energy of the leaf
     * 
     * @return the energy
     */
    public BigDecimal getEnergy();

    /**
     * Return the free energy in the leaf, and set its value to 0
     * 
     * @return the free energy
     */
    public BigDecimal collectFreeEnergy();

}