/*
	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:   StarSystem
// Purpose:      Class that describes a star system. Holds information such as
//               the system's name, its coordinates, the market prices and such.
//               The star system information is generated randomnly from a seed
//               and sector information given.
//
//
//##############################################################################
//##############################################################################
//##############################################################################
//##############################################################################

#include "StarSystem.h"

//------------------------------------------------------------------------------
// Static constants
//------------------------------------------------------------------------------

const unsigned StarSystem::MAX_DANGER_LEVEL = 5;   // maximum danger level for a system

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

Name:     StarSystem::StarSystem
Purpose:  StarSystem constructor. Creates a random star system from the random
          seed given.
Params:   random seed for the system. Which sector the system is in.
Returns:  n/a

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

StarSystem::StarSystem( unsigned seed , unsigned sectorX , unsigned sectorY ) : goodsInventory( seed )
{
    // Save the sector the star is in:

    this->sectorX = sectorX;
    this->sectorY = sectorY;

    // Seed the random number generator with the seed given:

    mlRandomSeed(seed);

    // Now create a name generator:

    NameGenerator nameGenerator;

    // Get a name from the generator and save its pointer:

    const char * name = nameGenerator.createName();

    // Now get the lenght of the name:

    unsigned nameLenght = strlen(name);

    // Allocate memory for a copy of this name in the star system:

    this->name = new char[nameLenght + 1];

    // Copy the name given into this newly allocated memory:

    memcpy( this->name , name , nameLenght + 1 );

    // Decide on a random offset within the sector for the system:

    this->sectorOffsetX = Galaxy::SECTOR_SIZE / 4 + mlRandomInt() % Galaxy::SECTOR_SIZE / 2;
    this->sectorOffsetY = Galaxy::SECTOR_SIZE / 4 + mlRandomInt() % Galaxy::SECTOR_SIZE / 2;

    // Randomly decide on a star color and planet for the system: these do not neccesarily have
    // to be within the range of the actual number of predefined colors and planets available:

    this->backgroundPlanet      = mlRandomInt();
    this->backgroundStarColor   = mlRandomInt();

    // Decide on a random background generation seed for the system:

    this->backgroundSeed = mlRandomInt();

    // Decide on the danger level for the system:

    this->dangerLevel = mlRandomInt() % ( MAX_DANGER_LEVEL ) + 1;
}

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

Name:     StarSystem::StarSystem
Purpose:  StarSystem default constructor. Creates a null system with no name
Params:   none
Returns:  n/a

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

StarSystem::StarSystem()
{
    // Set the system name to null:

    this->name					= 0;
    this->backgroundPlanet		= 0;
    this->backgroundSeed		= 0;
    this->backgroundStarColor	= 0;
    this->sectorOffsetX			= 0;
    this->sectorOffsetY			= 0;
}

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

Name:     StarSystem::StarSystem
Purpose:  StarSystem copy constructor. Creates a deep copy of the given systems
          member variables.
Params:   System being copied from.
Returns:  n/a

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

StarSystem::StarSystem( const StarSystem & system )
{
    // Perform a shallow copy first of the systems member variables:

    memcpy( this , & system , sizeof(StarSystem) );

    // If copied system has a name then copy it:

    if ( system.name != 0 )
    {
        // Get the name lenght:

        int lenght = strlen( system.name );

        // Declare memory on the heap for this systems name:

        this->name = new char[ lenght + 1 ];

        // Copy the name:

        memcpy( this->name , system.name , lenght + 1 );
    }
}

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

Name:     StarSystem::operator =
Purpose:  StarSystem assignment operator. copies the system into this system.
Params:   System being copied from.
Returns:  none

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

void StarSystem::operator = ( const StarSystem & system )
{
    // Deallocate the string memory of this star system first:

    if ( this->name ) delete this->name;

    // Perform a shallow copy first of the systems member variables:

    memcpy( this , & system , sizeof(StarSystem) );

    // If copied system has a name then copy it:

    if ( system.name != 0 )
    {
        // Get the name lenght:

        unsigned lenght = strlen( system.name );

        // Declare memory on the heap for this systems name:

        this->name = new char[ lenght + 1 ];

        // Copy the name:

        memcpy( this->name , system.name , lenght );

        // Null terminate the name:

        this->name[lenght] = 0;
    }
}

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

Name:     StarSystem::operator ==
Purpose:  StarSystem equality operator. Both systems are considered equal when
          they lie on the same sector in the galaxy
Params:   System to compare equalness with
Returns:  none

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

bool StarSystem::operator == ( const StarSystem & system )
{
    // Return whether the two systems are equal

    return ( system.getSectorX() == sectorX ) && ( system.getSectorY() == sectorY );
}

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

Name:     StarSystem::~StarSystem
Purpose:  StarSystem destructor. frees allocated resources.
Params:   none
Returns:  n/a

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

StarSystem::~StarSystem()
{
    // If we have allocated space for a name then delete:

    if ( name ) delete[] name;
}

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

Name:     StarSystem::getStarColor
Purpose:  Gets the star color for the star system and saves to the array given:
Params:   array to save to.
Returns:  none

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

void StarSystem::getStarColor( float * color )
{
    // Abort on null pointer:

    if ( color == 0 ) return;

    // Decide on the star color:

    switch ( backgroundStarColor % 8 )
    {
        case 0:     color[0] = 1.00f; color[1] = 1.00f; color[2] = 1.00f; break;
        case 1:     color[0] = 1.00f; color[1] = 0.95f; color[2] = 0.60f; break;
        case 2:     color[0] = 1.00f; color[1] = 0.75f; color[2] = 0.30f; break;
        case 3:     color[0] = 1.00f; color[1] = 0.50f; color[2] = 0.20f; break;
        case 4:     color[0] = 0.90f; color[1] = 0.90f; color[2] = 1.00f; break;
        case 5:     color[0] = 0.60f; color[1] = 1.00f; color[2] = 1.00f; break;
        case 6:     color[0] = 0.40f; color[1] = 0.80f; color[2] = 1.00f; break;
        case 7:     color[0] = 0.80f; color[1] = 1.00f; color[2] = 0.90f; break;
        default:    color[0] = 1.00f; color[1] = 1.00f; color[2] = 1.00f; break;
    }
}

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

Name:     StarSystem::getPlanetTexture
Purpose:  Gets the planet texture for the system.
Params:   none
Returns:  Texture for the systems planet:

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

const GLTexture * StarSystem::getPlanetTexture()
{
    // Decide on background planet:

    switch ( backgroundPlanet % 8 )
    {
        case 0:     return GLTextureManager::getTexPlanet1();
        case 1:     return GLTextureManager::getTexPlanet2();
        case 2:     return GLTextureManager::getTexPlanet3();
        case 3:     return GLTextureManager::getTexPlanet4();
        case 4:     return GLTextureManager::getTexPlanet5();
        case 5:     return GLTextureManager::getTexPlanet6();
        case 6:     return GLTextureManager::getTexPlanet7();
        case 7:     return GLTextureManager::getTexPlanet8();
        default:    return GLTextureManager::getTexPlanet1();
    }
}

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

Name:     StarSystem::getPlanetLightColor
Purpose:  Gets the color of the light emminating from the planet of this system
Params:   array to save color to
Returns:  none

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

void StarSystem::getPlanetLightColor( float * color )
{
    // Abort on null pointer:

    if ( color == 0 ) return;

    // Decide on planet light color:

    switch ( backgroundPlanet % 8 )
    {
        case 0:     color[0] = 0.15f;   color[1] = 0.15f;   color[2] = 0.2f;    break;
        case 1:     color[0] = 0.2f;    color[1] = 0.15f;   color[2] = 0.0f;    break;
        case 2:     color[0] = 0.2f;    color[1] = 0.2f;    color[2] = 0.2f;    break;
        case 3:     color[0] = 0.15f;   color[1] = 0.15f;   color[2] = 0.0f;    break;
        case 4:     color[0] = 0.2f;    color[1] = 0.15f;   color[2] = 0.0f;    break;
        case 5:     color[0] = 0.1f;    color[1] = 0.1f;    color[2] = 0.2f;    break;
        case 6:     color[0] = 0.1f;    color[1] = 0.1f;    color[2] = 0.2f;    break;
        case 7:     color[0] = 0.15f;   color[1] = 0.15f;   color[2] = 0.1f;    break;
        default:    color[0] = 0.15f;   color[1] = 0.15f;   color[2] = 0.2f;    break;
    }
}
