RixLighting2.h

Go to the documentation of this file.

/*
** Copyright (c) Pixar.  All rights reserved.  This program or
** documentation contains proprietary confidential information and trade
** secrets of PIXAR.  Reverse engineering of object code is prohibited.
** Use of copyright notice is precautionary and does not imply
** publication.
**
**                      RESTRICTED RIGHTS NOTICE
**
** Use, duplication, or disclosure by the Government is subject to the
** following restrictions:  For civilian agencies, subparagraphs (a) through
** (d) of the Commercial Computer Software--Restricted Rights clause at
** 52.227-19 of the FAR; and, for units of the Department of Defense, DoD
** Supplement to the FAR, clause 52.227-7013 (c)(1)(ii), Rights in
** Technical Data and Computer Software.
**
** Pixar Animation Studios
** 1200 Park Ave
** Emeryville, CA  94608
*/

#ifndef RixLighting2_h
#define RixLighting2_h

#include "RixLighting.h"

class RixLightContext;
class RixLightFilter;
class RixLightFilterContext;

/*
 * RixLightingServices2 __NOT PUBLIC__
 *
 * This is a shim to allow a kludge that will be removed in the future.
 *
 * This shim is here to provide the studio a working entry-point for getting
 * back the current active set of lights.  This is a short time frame change
 * that is to be removed once a more general API has been worked out for
 * providing plug-ins for the lighting services.  Use at your own peril,
 * not for public consumption.
 */
class RixLightingServices2 : public RixLightingServices
{
public:
    RixLightingServices2() : RixLightingServices() {}

    virtual void GetAllLights(const RixLight*** lights, int* numLights) = 0;

    virtual void GetActiveLights(const RixLight*** activeLights, int* numActiveLights) = 0;
    virtual void GetActiveLights(int** activeLightNumbers, int* numActiveLights) = 0;
    virtual void GetActiveLights(
        const RixLight*** activeLights, int** activeLightNumbers, int* numActiveLights) = 0;

    virtual bool GetLightFilter(
        int lightIndex, // into active lights
        RixLightFilterContext const** lfCtx,
        RixLightFilter** filter,
        void const** instance) = 0;

    virtual bool HasAnyLightFilter(int lightIndex) = 0;

    virtual int GetLightNumber(RixLight* light) = 0;
    virtual int GetLightNumber(int lightIndex) = 0;
    virtual float GetLightAreaScale(int lightIndex) = 0;

    virtual RixLPEToken GetCurrentLpeToken(int lightIndex) = 0;

    virtual void BeginSampling(
        int nSamples,
        RixRNG* rng    // random number generator the light should use
        ) = 0;

    virtual void GetLightCtx(
        int lightIndex, // into active lights
        int pointIndex, // point in the shading context, for indexing into integrator ctx time array
        int sampleIndex,
        RixLightContext const** lCtx,
        bool allLights = false) = 0;


    // Bidir methods
    virtual void BeginEmissionSampling(
        int nPoints,
        int nSamples,
        int const* integratorCtxIds,
        RixPhotonGuiding const* photonGuiding,
        RixRNG* rng    // random number generator the light should use
        ) = 0;

    virtual void BeginPhoton(RixShadingContext const* shdCtx) = 0;

protected:
    virtual ~RixLightingServices2() {}
};



#endif /* RixLighting2_h */