light.h

Go to the documentation of this file.

//**************************************************************************/

// Copyright (c) 2008 Autodesk, Inc.

// All rights reserved.

//

// Use of this software is subject to the terms of the Autodesk license

// agreement provided at the time of installation or download, or which

// otherwise accompanies this software in either electronic or hard copy form.

//

//**************************************************************************/

// DESCRIPTION:

// CREATED: October 2008

//**************************************************************************/



namespace mudbox {




class MBDLL_DECL Light : virtual public GroupNode

{

    DECLARE_CLASS;



protected:







    Light( void );



public:



    enum LightType

    {

        LIGHT_DIRECTIONAL=0,

        LIGHT_POINT,

        LIGHT_SPOT,

        LIGHT_IBL,

        LIGHT_NONE,

    };




    virtual Color Diffuse( void ) const;

    


    virtual void SetDiffuse(

        const Color &cDiffuse       

        );

    


    virtual float Intensity( void ) const;

    


    virtual void SetIntensity(

        float fIntensity        

        );

    


    virtual bool IsLockedToCamera( void ) const;

    


    virtual void SetLockedToCamera(

        bool bOnOrOff   

        );

    


    virtual bool Render( void );

    


    virtual Manipulator *GetManipulator();

    


    virtual void ValidateShadowMap();

    


    virtual Texture *ShadowDepthMap();

    








    virtual const Matrix &ShadowMatrix() const;

    


    virtual bool CastShadow();

    








    virtual float ShadowBias();

    




    virtual LightType Type();

    




    virtual void SetAttenuation(float);

    




    virtual float Attenuation(void) const;

    








    virtual Matrix LockedToCameraMatrix() const;

    


    virtual Image *HDRImage() const;

    

    // \brief Returns the path to the associated HDRI image, if any.

    //

    // Returns a NULL pointer if this is not an HDRI light.  If a valid String pointer is returned, you should NOT delete it;

    // it is a pointer into the object data.

    virtual const QString *HDRImageFilename() const;

};



}; // end of namespace mudbox