barsuift.simLife.environment.Sun 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

The newest version!

/**
 * barsuift-simlife is a life simulator program
 * 
 * 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.environment;

import java.math.BigDecimal;

import barsuift.simLife.Persistent;
import barsuift.simLife.j3d.environment.Sun3D;
import barsuift.simLife.message.Publisher;

/**
 * Class representing the sun.
 */
public interface Sun extends Publisher, Persistent {

    /**
     * This is the energy provided by a 100% brightness sun on 1 m?
     */
    public static final BigDecimal ENERGY_DENSITY = new BigDecimal(150);

    public Sun3D getSun3D();

    public BigDecimal getBrightness();

    public void setBrightness(BigDecimal brightness) throws IllegalArgumentException;

    /**
     * Rise angle, in percent.
     * 
     * 

     * 0 means sun is full east, lighting only along the X axis
     * 50 means sun is at its zenith position (neither east nor west). no X direction
     * 100 means sun is full west, lighting only along the reverted X axis
     * 
     * 
     */
    public BigDecimal getRiseAngle();

    public void setRiseAngle(BigDecimal riseAngle);

    /**
     * Zenith angle, in percent.
     * 
     * 

     * 0 means sun is always at the horizon
     * 50 means sun is at 45? (Pi/4)
     * 100 means sun is at its zenith position. no Z direction
     * 
     * 
     */
    public BigDecimal getZenithAngle();

    public void setZenithAngle(BigDecimal zenithAngle);

}