imrSkyPortalLight.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.
//*****************************************************************************/

#pragma once

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

#define PORTAL_LIGHT_OBJECT_CLASSID Class_ID(0x335c655c, 0x382151b1)
#define IID_MR_SKY_PORTAL_LIGHT Interface_ID(0x102804f9, 0x41d71b3f)


class IMrSkyPortalLight : public BaseInterface {
public:
    virtual Interface_ID GetID() { return IID_MR_SKY_PORTAL_LIGHT; };
    
    virtual ~IMrSkyPortalLight() {};



    virtual float GetMultiplier(const TimeValue t, Interval& valid) const = 0;

    virtual bool SetMultiplier(const TimeValue t, float multiplier) = 0;



    virtual AColor GetFilterColor(const TimeValue t, Interval &valid) const = 0;

    virtual bool SetFilterColor(const TimeValue t, const AColor& color) = 0;


    virtual bool GetCastShadowsFromOutdoors() const = 0;

    virtual bool SetCastShadowsFromOutdoors(bool bEnable) = 0;


    virtual int GetShadowSamples(const TimeValue t, Interval &valid) const = 0;

    virtual bool SetShadowSamples (const TimeValue t, int shadowSamples) = 0;



    virtual float GetLength(const TimeValue t, Interval &valid) const = 0;

    virtual bool SetLength(const TimeValue t, float length) = 0;

    virtual float GetWidth(const TimeValue t, Interval &valid) const = 0;

    virtual bool SetWidth(const TimeValue t, float width) = 0;

        


    enum LightFluxDirection {
        kOutdoorToIndoor = 0, 
        kIndoorToOutdoor = 1, 
        kLastDir,
    };

    virtual LightFluxDirection GetLightFluxDirection() const = 0;

    virtual bool SetLightFluxDirection(LightFluxDirection dir) = 0;


    virtual bool GetVisibleInRendering(const TimeValue t, Interval &valid) const = 0;

    virtual bool SetVisibleInRenderin(const TimeValue t, bool visible) = 0;


    virtual AColor GetTransparencyColor(const TimeValue t, Interval &valid) const = 0;

    virtual bool SetTransparencyColor(const TimeValue t, const AColor& color) = 0;
    


    enum IlluminationColorSource {
        kSceneEnvironmentColor, 
        kCustomMapColor, 
        kSkylightColor, 
        kLastColorSource,
    };

    virtual IlluminationColorSource GetIllumColorSource() const = 0;

    virtual bool SetIllumColorSource(IlluminationColorSource source) = 0;



    virtual Texmap* GetIlluminationMap() const = 0;

    virtual bool SetIlluminationMap(Texmap* illumColorMap) = 0;

};