polycode-engine/Core/Contents/Include/PolySceneLight.h

/*
Copyright (C) 2011 by Ivan Safrin

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
 

#pragma once
#include "PolyGlobals.h"
#include "PolyEntity.h"

namespace Polycode {

	class Scene;
	class Camera;
	class Mesh;
	class Texture;
//	class ScenePrimitive;
	
	/**
	* 3D light source. Lights can be point or spot lights and can be set to different colors. 
	*/
	class _PolyExport SceneLight : public Entity {
		public:
		
			/**
			* Constructs a light with parameters.
			* @param type Type of light to create. Can be SceneLight::POINT_LIGHT or SceneLight::SPOT_LIGHT
			* @param parentScene Scene to light.
			* @param intensity Light color intensity
			* @param constantAttenuation Constant falloff attenuation value	
			* @param linearAttenuation Linear falloff attenuation value	
			* @param quadraticAttenuation Quadratic falloff attenuation value				
			*/ 
			SceneLight(int type, Scene *parentScene, Number intensity, Number constantAttenuation=1, Number linearAttenuation=1, Number quadraticAttenuation=1);
			virtual ~SceneLight();
		
			/*
			* Returns the light's intensity.
			*/
			Number getIntensity() const;

			/**
			* Sets the light's intensity
			* @param newIntensity New intensity value.
			*/
			void setIntensity(Number newIntensity);
						
			/**
			* Sets the attenuation values for the light.
			* @param constantAttenuation Constant falloff attenuation value	
			* @param linearAttenuation Linear falloff attenuation value	
			* @param quadraticAttenuation Quadratic falloff attenuation value
			* 
			*/
			void setAttenuation(Number constantAttenuation, Number linearAttenuation, Number quadraticAttenuation);			
						
			Number getConstantAttenuation() const { return constantAttenuation; }
			Number getLinearAttenuation() const { return linearAttenuation; }
			Number getQuadraticAttenuation() const { return quadraticAttenuation; }
									
			/*
			* Returns the light's type.
			*/			
			int getType() const;
			
			void renderDepthMap(Scene *scene);
			
			void Render();

			const Matrix4& getLightViewMatrix() const;
			
			static const int POINT_LIGHT = 0;
			static const int SPOT_LIGHT = 1;
			
			Texture *getZBufferTexture() const;
			
			/**
			* Color of the light.
			*/ 
			Color specularLightColor;
		
			/**
			* Sets the light color.
			* @param r Red value 0-1.
			* @param g Green value 0-1
			* @param b Blue value 0-1
			* @param a Alpha value 0-1									
			*/	
			void setSpecularLightColor(Number r, Number g, Number b, Number a) { specularLightColor.r = r; specularLightColor.g = g; specularLightColor.b = b; specularLightColor.a = a; }
						
			
			/**
			* Color of the light.
			*/ 
			Color lightColor;
		
			/**
			* Sets the light color.
			* @param r Red value 0-1.
			* @param g Green value 0-1
			* @param b Blue value 0-1
			* @param a Alpha value 0-1									
			*/	
			void setDiffuseLightColor(Number r, Number g, Number b) { lightColor.r = r; lightColor.g = g; lightColor.b = b; }
			
			
			
			/**
			* Sets both the specular and diffust light colors. Use setDiffuseLightColor and setSpecularLightColor to set the individual light colors.
			* @param r Red value 0-1.
			* @param g Green value 0-1
			* @param b Blue value 0-1
			* @param a Alpha value 0-1									
			*/	
			void setLightColor(Number r, Number g, Number b, Number a=1.0) { 
				setDiffuseLightColor(r,g,b);
				setSpecularLightColor(r,g,b,a);
			}
			
			
						
			
			/**
			* Sets the spotlight properties. These control the shape of the spotlight beam.
			* @param spotlightExponent Spotlight exponent size
			* @param spotlightCutoff Spotlight furstrum cutoff.
			*/
			void setSpotlightProperties(Number spotlightCutoff, Number spotlightExponent) {
				this->spotlightCutoff = spotlightCutoff;
                this->spotlightExponent = spotlightExponent;
			}
			
			Number getSpotlightCutoff() const { return spotlightCutoff; }
			Number getSpotlightExponent() const { return spotlightExponent; }
			
			/**
			* If this is called with 'true', the light will generate a shadow map.
			* @param val If set to true, enables this light to cast shadows.
			* @param resolution Resolution of the shadow map. (defaults to 256x256).
			*/
			void enableShadows(bool val, unsigned int resolution=256);
			
			/**
			* This sets the shadow map field of view. The larger the field of view, the more of the scene it encompasses, but the more quality it loses.
			* @param fov New field of view value.
			*/
			void setShadowMapFOV(Number fov);
		
            /**
             * Returns the light's shadow map field of view.
             */
            Number getShadowMapFOV() const;
        
            unsigned int getShadowMapResolution() const;
        
			/**
			* Returns true if shadows are enabled.
			*/
			bool areShadowsEnabled() const;
		
			/**
			* Returns the light type.
			*/
			int getLightType() const { return type; }
			
			void setLightImportance(int newImportance);
			int getLightImportance() const;
        
            void setLightType(int lightType);
		
            virtual Entity *Clone(bool deepClone, bool ignoreEditorOnly) const;
            virtual void applyClone(Entity *clone, bool deepClone, bool ignoreEditorOnly) const;
        
            Scene *getParentScene() const;
            void setParentScene(Scene *scene);
        
            Camera *getSpotlightCamera();
        
		protected:
		
			Number spotlightExponent;
			Number spotlightCutoff;
		
			int lightImportance;
		
			Number constantAttenuation;
			Number linearAttenuation;
			Number quadraticAttenuation;
		
			int type;
			Number intensity;
			
			Camera *spotCamera;
			Texture *zBufferTexture;

			Scene *parentScene;
			
			Matrix4 lightViewMatrix;
		
			unsigned int shadowMapRes;
			Number shadowMapFOV;	
			bool shadowsEnabled;
		
			Number distance;
			Mesh *lightMesh;
	};
}