barsuift.simLife.j3d.universe.environment.Sun3D Maven / Gradle / Ivy

Go to download

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

API of the display 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.j3d.universe.environment;

import javax.media.j3d.DirectionalLight;

import barsuift.simLife.IObservable;
import barsuift.simLife.Percent;




public interface Sun3D extends IObservable {

    /**
     * Computes the white factor, based on the position (rise and zenith angles). The lower the sun is, the lower the
     * white factor.
     * 
     * 

     * When the white factor is 100%, the sun is white (Red = Green = Blue).
     * When the white factor is 0%, the sun is red (Red = 100%, Green = Blue = 0%).
     * 
     * 
     * 
     * Concretely, here is the computation :

     * whiteFactor = sqrt(abs(sinus(riseAngle) * sinus(zenithAngle)))
     * 
     * 
     * @return the white factor
     */
    public Percent getWhiteFactor();

    public DirectionalLight getLight();

}