/*
	Rogue Trader.
	Copyright (c) 2007, Darragh Coy.
	All rights reserved.
	Original work(s), source code & author(s) details available at: http://www.darraghcoy.com

	Redistribution and use in source and binary forms, with or without modification, are permitted 
	provided that the following conditions are met:

		* 	Redistributions of source code must retain the above copyright notice, this list of 
			conditions and the following disclaimer.
		* 	Redistributions in binary form must reproduce the above copyright notice, this list of 
			conditions and the following disclaimer in the documentation.
		* 	Neither the name of the author nor the names of contributors may be used to endorse or 
			promote products derived from this software without specific prior written permission.
		* 	The use of any third party libraries, modules or data files provided with the source 
			form of the program must follow and respect the individual licensing terms of these 
			components. You do not have permission to modify or circumvent the licensing terms for 
			provided third party components unless the third party licenses specifically allow this. 
			If you do not agree to the terms of provided third party components then you do not have 
			permission to use them in your derived work(s).
		* 	The terms of this license do not apply to separate (but related) distributions if supplied 
			by the author(s), only to the contents of this source distribution, derived works, and the 
			binaries produced by either modified or unmodified versions of the source code. The terms 
			of this license do not also apply to any third party libraries or components provided with 
			the source distribution. Such third party elements are licensed under their own separate 
			agreements.

	THIS SOFTWARE IS PROVIDED BY DARRAGH COY ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, 
	BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
	ARE DISCLAIMED. IN NO EVENT SHALL DARRAGH COY BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
	EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 
	OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 
	OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
	IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

//##############################################################################
//##############################################################################
//##############################################################################
//##############################################################################
//
//
// Class Name:   Light
// Purpose:      Simple class that describes a light.
//
//
//##############################################################################
//##############################################################################
//##############################################################################
//##############################################################################

#include "Light.h"

/*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

Name:     Light::Light()
Purpose:  Default constructor for a light. Initialises settings to their defaults.
Params:   none
Returns:  n/a

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*/

Light::Light()
{
    // Set the LightScene the light belongs to as null initially. A light can only be in one LightScene at a time.

    scene = 0;

    // Reset all light attributes to the defaults

    reset();
}

/*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

Name:     Light::reset()
Purpose:  Resets all light attributes to their defaults.
Params:   none
Returns:  none

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*/

void Light::reset()
{
    pos[0] = 0;     // Initialise position to default: w (pos[3]) is always 1 for a positional light source
    pos[1] = 0;
    pos[2] = 0;
    pos[3] = 1;

    col[0] = 1;     // Initialise color to default: alpha, which is col[3] always is at 1.
    col[1] = 1;
    col[2] = 1;
    col[3] = 1;

    strenght = 1;  // Default light strenght is 1
}

/*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

Name:     Light::setColor()
Purpose:  Sets the light's color to the color given
Params:   RGB color to set light color to.
Returns:  none

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*/

void Light::setColor( float r , float g, float b )
{
    // Clamp color from 0-1 range:

    if ( r < 0 ) r = 0; if ( r > 1 ) r = 1;
    if ( g < 0 ) g = 0; if ( g > 1 ) g = 1;
    if ( b < 0 ) b = 0; if ( b > 1 ) b = 1;

    // Set light color

    this->col[0] = r;
    this->col[1] = g;
    this->col[2] = b;
}

/*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

Name:     Light::setPosition()
Purpose:  Sets the light's position to position given.
Params:   Position to set to.
Returns:  none

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*/

void Light::setPosition( float x , float y, float z )
{
    // If light is directional then abort

    if ( isDirectional() ) return;

    // Set light position:

    this->pos[0] = x;
    this->pos[1] = y;
    this->pos[2] = z;
}

/*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

Name:     Light::setDirection()
Purpose:  Sets the light's direction to direction given.
Params:   Direction to set to.
Returns:  none

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*/

void Light::setDirection( float x , float y, float z )
{
    // If light is positional then abort

    if ( isDirectional() == false ) return;

    // Set light direction:

    this->pos[0] = x;
    this->pos[1] = y;
    this->pos[2] = z;

    // Normalise the direction

    float lenght = sqrtf( x*x + y*y + z*z );

    // Only normalise if lenght is not zero

    if ( lenght > 0 )
    {
        this->pos[0] /= lenght;
        this->pos[1] /= lenght;
        this->pos[2] /= lenght;
    }
}


/*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

Name:     Light::setStrenght()
Purpose:  Sets the light's strenght to value given.
Params:   radius.
Returns:  none

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*/

void Light::setStrenght( float strenght )
{
    // If radius is zero or less then make equal to one

    if ( strenght <= 0 ) strenght = 1; else this->strenght = strenght;
}

/*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

Name:     Light::setDirectional()
Purpose:  Sets whether the light is directional or not.
Params:   If the light is directional.
Returns:  none

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*/

void Light::setDirectional( bool directional )
{
    // If the light is directional then the w coordinate of the position will be zero,
    // otherwise it will be 1 if the light is positional.

    if ( directional ) pos[3] = 0; else pos[3] = 1;
}

/*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

Name:     Light::getPosition()
Purpose:  Stores the xyz components of the lights position in the array given
Params:   array to save to
Returns:  none

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*/

void Light::getPosition( float * position )
{
    // Abort on null pointer

    if ( position == 0 ) return;

    // Otherwise save xyz components

    position[0] = this->pos[0];
    position[1] = this->pos[1];
    position[2] = this->pos[2];
}

/*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

Name:     Light::getColor()
Purpose:  Stores the rgb components of the lights color in the array given
Params:   array to save to
Returns:  none

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*/

void Light::getColor( float * color )
{
    // Abort on null pointer

    if ( color == 0 ) return;

    // Otherwise save rgb components

    color[0] = this->col[0];
    color[1] = this->col[1];
    color[2] = this->col[2];
}


