3DLight.h

Go to the documentation of this file.

//! @file 3DLight.h
//! @brief C3DLight implementation for a light object
//!
//////////////////////////////////////////////////////////////////////
 
#if !defined(AFX_3DLIGHT_H__5C85DAE7_BE95_4F8B_B661_B0CF9BE55255__INCLUDED_)
#define AFX_3DLIGHT_H__5C85DAE7_BE95_4F8B_B661_B0CF9BE55255__INCLUDED_
 
#ifdef _MSC_VER
#pragma once
#endif // _MSC_VER
 
#include "3DBaseObject.h"
#include "3DObject.h"
 
BEGIN_MOOTOOLS_NAMESPACE
 
typedef enum _LIGHT_TYPE
{
    LIGHT_DIRECTIONAL = 0,
    LIGHT_OMNI,
    LIGHT_SPOT,
 
    NB_LIGHT_TYPES      //Keep it last !
} LIGHT_TYPE;
 
#define C3DLIGHT_KIND           MAKE_CUSTOM_ID('l','k','n','d')     // LIGHT_TYPE
#define C3DLIGHT_COLOR          MAKE_CUSTOM_ID('l','c','l','r')     // CRGBColor
#define C3DLIGHT_INTENSITY      MAKE_CUSTOM_ID('l','i','n','t')     // Double
#define C3DLIGHT_INNER_RADIUS   MAKE_CUSTOM_ID('l','i','n','r')     // Double
#define C3DLIGHT_OUTER_RADIUS   MAKE_CUSTOM_ID('l','o','u','r')     // Double
#define C3DLIGHT_INNER_ANGLE    MAKE_CUSTOM_ID('l','i','n','a')     // Double
#define C3DLIGHT_OUTER_ANGLE    MAKE_CUSTOM_ID('l','o','u','a')     // Double
 
// Defaults
 
#define DEFAULT_LIGHT_KIND LIGHT_DIRECTIONAL
#define DEFAULT_LIGHT_COLOR CRGBColor(1.0, 1.0, 1.0, 255)
#define DEFAULT_LIGHT_INTENSITY 1.0
#define DEFAULT_LIGHT_INNER_RADIUS 0.0              
#define DEFAULT_LIGHT_OUTER_RADIUS 0.0              // 0 or minus -> No limit !
#define DEFAULT_LIGHT_INNER_ANGLE 0.0
#define DEFAULT_LIGHT_OUTER_ANGLE DEG2RAD(30)
 
#define C3DLIGHT_RADIUS_INFINITE -1
 
//! @class C3DLight
//! @brief This class implements a light object in the scene (OBJECT_LIGHT)
class DLL_3DFUNCTION C3DLight : public C3DBaseObject
{
    DECLARE_SERIAL_XOBJECT(C3DLight);
 
public:
 
    int GetLightKind();
    void SetLightKind(int kind);
    CRGBColor GetColor();
    void SetColor(CRGBColor col);
    double GetIntensity();
    void SetIntensity(double v);
    double GetInnerRadius();
    void SetInnerRadius(double v);
    double GetOuterRadius();
    void SetOuterRadius(double v);
    void ClearAttenuation();
    double GetInnerAngle();
    void SetInnerAngle(double v);
    double GetOuterAngle();
    void SetOuterAngle(double v);
 
    C3DLight();
    virtual ~C3DLight();
 
    virtual bool IsFinalObject() const { return false; }
    virtual C3DBaseObject *GetFinalObject(bool detach = false, bool computeIfNeeded = true)
    {
        if(!displayable && computeIfNeeded)
        {
            switch(GetLightKind())
            {
            case LIGHT_DIRECTIONAL:
                GenerateDirectionalLight();
                break;
            case LIGHT_OMNI:
                GenerateOmniLight();
                break;
            case LIGHT_SPOT:
                GenerateSpotLight();
                break;
            default:
                XASSERT(0);
            }
 
            if (displayable)
                displayable->SetScene(scene); // Create a guid
        }
 
        return displayable;
    };
    
private:
 
    C3DObject* displayable;
 
    void GenerateOmniLight();
    void GenerateDirectionalLight();
    void GenerateSpotLight();
};
 
END_MOOTOOLS_NAMESPACE
 
#endif // !defined(AFX_3DLIGHT_H__5C85DAE7_BE95_4F8B_B661_B0CF9BE55255__INCLUDED_)