imrPhysicalSkyLight.h

Go to the documentation of this file.

//*****************************************************************************/
// Copyright (c) 1998-2007 Autodesk, Inc.
// All rights reserved.
// 
// These coded instructions, statements, and computer programs contain
// unpublished proprietary information written by Autodesk, Inc., and are
// protected by Federal copyright law. They may not be disclosed to third
// parties or copied or duplicated in any form, in whole or in part, without
// the prior written consent of Autodesk, Inc.
//*****************************************************************************/
/*===========================================================================*\
 | 
 |  AUTH:   Claude RObillard
 |          Taken from SkyLight.cpp 8/20/01
 |          Chloe Mignot: 05/04/2007 moved to src\include
\*===========================================================================*/

#pragma once

#include "..\baseinterface.h"
#include "..\maxtypes.h"
#include "..\acolor.h"
// forward declarations
class Interval;

#define MRPHYSSKY_LIGHT_OBJECT_CLASSID  Class_ID(0x26ee3350, 0x799b5b56)

#define MRPHYSSKY_LIGHT_INTERFACECLASS_ID Interface_ID(0x23a857ab, 0x5fad4778)


class IMRPhysicalSkyInterface : public BaseInterface {
public:
    enum SkyModel { eHaze = 0, ePerez, eCIE};
    enum CIEModel { eOvercastSky = 0, eClearSky};

    virtual Interface_ID GetID() { return MRPHYSSKY_LIGHT_INTERFACECLASS_ID; };
    
    virtual ~IMRPhysicalSkyInterface() {};



    virtual float  getMultiplier   (TimeValue &t, Interval &valid) const = 0;
    virtual bool   setMultiplier   (TimeValue t, float multiplier) = 0;




    virtual float  getHaze(TimeValue &t, Interval &valid) const = 0;
    virtual bool   setHaze(TimeValue t, float haze) = 0;



    virtual float  getRedBlueShift (TimeValue &t, Interval &valid) const = 0;
    virtual bool   setRedBlueShift (TimeValue t, float redBlueShift) = 0;



    virtual float  getSaturation   (TimeValue &t, Interval &valid) const = 0;   
    virtual bool   setSaturation   (TimeValue t, float saturation) = 0; 



    virtual AColor getGroundColor  (TimeValue &t, Interval &valid) const = 0;
    virtual bool   setGroundColor  (TimeValue t, AColor groundColor) = 0;



    virtual AColor getNightColor   (TimeValue &t, Interval &valid) const = 0;
    virtual bool   setNightColor   (TimeValue t, AColor nightColor) = 0;



    virtual float  getHorizonBlur  (TimeValue &t, Interval &valid) const = 0;
    virtual bool   setHorizonBlur  (TimeValue t, float horizonBlur) = 0;



    virtual float  getHorizonHeight(TimeValue &t, Interval &valid) const = 0;
    virtual bool   setHorizonHeight(TimeValue t, float horizonHeight) = 0;



    virtual bool   getAerialPerspective(TimeValue &t, Interval &valid) const = 0;
    virtual bool   setAerialPerspective(TimeValue t, bool aerialPerspective) = 0;   



    virtual float  getVisibilityDistance(TimeValue &t, Interval &valid) const = 0;
    virtual bool   setVisibilityDistance(TimeValue t, float visibilityDistance) = 0;



    virtual SkyModel getSkyModel(TimeValue &t, Interval &valid) const = 0;
    virtual bool    setSkyModel(TimeValue t, SkyModel skyModel) = 0;



    virtual float  getPerezDiffuseHorizIlluminance(TimeValue &t, Interval &valid) const = 0;
    virtual bool   setPerezDiffuseHorizIlluminance(TimeValue t, float perezDiffuseHorizIlluminance) = 0;



    virtual float  getPerezDirectNormalIlluminance(TimeValue &t, Interval &valid) const = 0;
    virtual bool   setPerezDirectNormalIlluminance(TimeValue t, float perezDirectNormalIlluminance) = 0;



    virtual float  getCIEDiffuseHorizIlluminance(TimeValue &t, Interval &valid) const = 0;
    virtual bool   setCIEDiffuseHorizIlluminance(TimeValue t, float cieDiffuseHorizIlluminance) = 0;



    virtual CIEModel getCIEModel(TimeValue &t,Interval &valid) const = 0;
    virtual bool setCIEModel(TimeValue t,CIEModel model) =0;

    virtual void getPerezABCDE(float &A, float &B, float &C, float &D,float &E,TimeValue t, Interval &valid) const = 0;

};

#define MRPHYSSKY_LIGHT_INTERFACECLASS2_ID Interface_ID(0x3e3e5a80, 0x157908fb)


class IMRPhysicalSkyInterface2 : public IMRPhysicalSkyInterface {
public:

    /* \brief Retrieves the unique identifier of this interface
    */
    virtual Interface_ID GetID() { return MRPHYSSKY_LIGHT_INTERFACECLASS2_ID; }



    virtual float  getCIEDirectNormalIlluminance(TimeValue &t, Interval &valid) const = 0;
    virtual bool   setCIEDirectNormalIlluminance(TimeValue t, float CIEDirectNormalIlluminance) = 0;
};