IDaylightSystem.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.
//*****************************************************************************/
// DESCRIPTION: Interface for creating and modifying daylight systems programatically.
// AUTHOR: Chloe Mignot - created April 27 2007
//*****************************************************************************/


#pragma once
#include "GetCOREInterface.h"
#include "ifnpub.h"
#include "assetmanagement\AssetUser.h"

class INode;
class Point3;
class LightObject;
class IDaylightSystem;
class IDaylightSystem2;

// --- Interface IDs
#define DAYLIGHTSYSTEM_FACTORY_INTERFACE Interface_ID(0x5c665bc7, 0x61b44a30)

class IDaylightSystemFactory : public FPStaticInterface
{
public:
    virtual INode* Create(IDaylightSystem*& pDaylight) = 0;

    static IDaylightSystemFactory* GetInstance()    {
        return static_cast<IDaylightSystemFactory*>(GetCOREInterface(DAYLIGHTSYSTEM_FACTORY_INTERFACE));
    }
};

#define IID_DAYLIGHT_SYSTEM_FACTORY2 Interface_ID(0x688f66a6, 0x423a37aa)

class IDaylightSystemFactory2 : public FPStaticInterface
{
public:
    virtual INode* Create(
        IDaylightSystem2*& pDaylight, 
        const Class_ID* sunClassID = NULL, 
        const Class_ID* skyClassID = NULL) = 0;
};

// --- Interface IDs
#define DAYLIGHT_SYSTEM_INTERFACE Interface_ID(0x20033f9f, 0x6a65470)

class IDaylightSystem : public FPMixinInterface 
{
public:
    virtual LightObject* GetSun() const = 0;

    virtual LightObject* GetSky() const = 0;

    virtual void SetPosition(const Point3& position) = 0;

    virtual Point3 GetPosition() const = 0;

    virtual void  SetOrbitalScale(float orbScale) = 0;

    virtual float GetOrbitalScale() const = 0;

    virtual void SetNorthDirection(float angle) = 0;

    virtual float GetNorthDirection() const = 0;

    virtual void SetCompassDiameter(float compassDiameter) = 0;

    virtual float GetCompassDiameter() const = 0;

    virtual void SetTimeOfDay(const Point3& time) = 0;

    virtual Point3 GetTimeOfDay() const = 0;

    virtual void SetDate(const Point3& date) = 0;

    virtual Point3 GetDate() const = 0;

    virtual void SetLatLong(float latitude, float longitude) = 0;

    virtual float GetLatitude() const = 0;


    virtual float GetLongitude() const = 0;

    virtual void SetDaylightSavingTime(BOOL isDaylightSavingTime) = 0;

    virtual BOOL GetDaylightSavingTime() const = 0;
};

#define IID_DAYLIGHT_SYSTEM2 Interface_ID(0x226e7d9a, 0x215a193f)

class IDaylightSystem2 : public IDaylightSystem
{
public:
    /* \brief Retrieves the unique identifier of this interface
    */
    virtual Interface_ID GetID() { return IID_DAYLIGHT_SYSTEM2; }

    virtual int GetTimeZone(float longitude) const = 0;

    virtual LightObject* SetSun(const Class_ID& sunClassID) = 0;

    virtual LightObject* SetSky(const Class_ID& skyClassID) = 0;

    enum DaylightControlType
    {
        eDateAndTime = 0, eManual = 1, eWeatherFile = 2
    };

    virtual DaylightControlType GetDaylightControlType()const =0;

    virtual void SetDaylightControlType(DaylightControlType val) =0;

    virtual MSTR GetLocation() = 0;

    virtual void GetAltitudeAzimuth(TimeValue t, float &altitude,float &azimuth) =0;

    virtual MaxSDK::AssetManagement::AssetUser GetWeatherFile()const =0;

    virtual void SetWeatherFile(const MaxSDK::AssetManagement::AssetUser &val) =0;

    virtual void OpenWeatherFileDlg() = 0;

    
    virtual bool GetTemps(float &dryBulbTemperature, float &dewPointTemperature)=0;

    virtual bool GetExtraTerrestialRadiation(float &extraterrestrialHorizontalRadiation, float &extraterrestrialDirectNormalRadiation)=0;


    virtual bool GetRadiation(float &globalHorizontalRadiation, float &directNormalRadiation,
                                             float &diffuseHorizontalRadiation)=0;


    virtual bool GetIlluminance(float &globalHorizontalIlluminance, float &directNormalIlluminance,
                                             float &diffuseHorizontalIlluminance, float &zenithLuminance)=0;

};

#define IID_DAYLIGHT_SYSTEM3 Interface_ID(0x36df4e9f, 0x6b160e40)

class IDaylightSystem3 : public IDaylightSystem2
{
public:
    virtual void GetAltAz(TimeValue t, float &altitude,float &azimuth)=0;
};