imrLightTranslation.h

Go to the documentation of this file.

//*****************************************************************************/
// Copyright (c) 1998-2006 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.
//*****************************************************************************/
/*==============================================================================

  file:     imrLightTranslation.h

  author:   Daniel Levesque

  created:  27 Jan 2006

  description:

    Defition of the mental ray light translation interface.

  modified: 

==============================================================================*/
#pragma once

#include "..\maxheap.h"
#include "..\baseinterface.h"
#include "..\coreexp.h"
#include "..\maxtypes.h"

// Forward declarations
class imrTranslation;
class INode;
class Interval;
class Texmap;

//==============================================================================
// class imrLightTranslation
//

class imrLightTranslation : public BaseInterface {

public:

    CoreExport static Interface_ID GetInterfaceID();

    CoreExport static imrLightTranslation* GetInterface(InterfaceServer& iserver);

    enum LightType {
        kLightType_Origin,
        kLightType_Directional,
        kLightType_DirectionalWithOrigin,
        kLightType_Spot
    };

    enum AreaType {
        kAreaType_None,
        kAreaType_Rectangle,
        kAreaType_Disc,
        kAreaType_Sphere,
        kAreaType_Cylinder,
        kAreaType_User
    };

    struct VectorStruct : public MaxHeapOperators {
        float x, y, z;
    };

    union AreaPrimitive {
        struct AreaLight_rectangle : public MaxHeapOperators {
            VectorStruct edge_u;
            VectorStruct edge_v;
        } rectangle;
        struct AreaLight_disc : public MaxHeapOperators {
            VectorStruct normal;
            float radius;
        } disc;
        struct AreaLight_sphere : public MaxHeapOperators {
            float radius;
        } sphere;
        struct AreaLight_cylinder : public MaxHeapOperators {
            VectorStruct axis;
            float radius;
        } cylinder;
    };



    virtual Texmap* GetLightShader(INode& node) = 0;
    virtual Texmap* GetPhotonEmitterShader(INode& node) = 0;

    // Tells the translator whether this light species a custom flux. If this returns false,
    // then the translator will attempt to calculate the flux based on the light type and its intensity.


    virtual bool HasCustomFlux(INode& node) = 0;



    virtual float GetFlux(INode& node, imrTranslation& translationInterface, TimeValue t, Interval& valid) = 0;

    virtual LightType GetLightType(TimeValue t, Interval& validity) = 0;

    virtual AreaType GetAreaType(TimeValue t, Interval& validity) = 0;

    virtual void GetAreaPrimitive(AreaPrimitive& areaPrimitive, TimeValue t, Interval& validity) = 0;

    virtual short GetAreaSamples(TimeValue t, Interval& validity) = 0;

    virtual short GetAreaLowSamples(TimeValue t, Interval& validity) = 0;

    virtual short GetAreaLowLevel(TimeValue t, Interval& validity) = 0;

    virtual bool GetAreaVisible(TimeValue t, Interval& validity) = 0;
};