OBJ/OBJ_Ambient.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Mark Elendt
 *      Side Effects
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        OBJ library (C++)
 *
 * COMMENTS:    Ambient Light object definition (base class for lights too)
 *
 */

#ifndef __OBJ_Ambient_h__
#define __OBJ_Ambient_h__

#include "OBJ_API.h"
#include "OBJ_Camera.h"

class obj_Scene;
class IFD_LightParms;
class RE_Light;

enum OBJ_AmbIndex
{
    I_DIMMER = I_N_CAM_INDICES,

    I_N_AMB_INDICES             // should always be last in the list
};

// Yes, this is gross, however, because we assume that you can render
//      from any light source, we have to sub-class from OBJ_Camera.
class OBJ_API OBJ_Ambient : public OBJ_Camera
{
public:
             OBJ_Ambient(OP_Network *, const char *, OP_Operator *);
    virtual ~OBJ_Ambient();

    static PRM_Template         *getObsolete();

    virtual void                 getIFDParms(IFD_ObjectParms &parms, float t,
                                             const char *);
    virtual void                 getIFDParms(IFD_LightParms &parms, float t,
                                            const char *);
    virtual void                 getIFDParms(IFD_CameraParms &parms, float t,
                                            const char *);
    virtual RE_Light            *getLightValue();
    virtual void                 updateLightValue(float t);
    virtual int                  isAmbient();

    void        getColor(float &r, float &g, float &b, fpreal t)
                {
                    fpreal      dim = DIMMER(t);
                    r = CR(t)*dim;
                    g = CG(t)*dim;
                    b = CB(t)*dim;
                }
    virtual OBJ_OBJECT_TYPE      getObjectType() const;

    virtual void                 rmanBestShader(UT_String &str, float t) = 0;
    virtual void                 vexBestShader(UT_String &str, float t) = 0;
    virtual void                 vexBestShadow(UT_String &str, float t) = 0;

    static PRM_Template         *getTemplateList();

    virtual OBJ_Ambient         *castToOBJAmbient() { return this; }
    
    fpreal      DIMMER(fpreal t);
    void        SHADER(UT_String &str, fpreal t);
    void        RISHADER(UT_String &str, fpreal t);
    fpreal      CR(fpreal t);
    fpreal      CG(fpreal t);
    fpreal      CB(fpreal t);
    int         BIND_OGL_LIGHT(fpreal t);

    virtual int          collectPropertiesFromChannels(
                                        PI_EditScriptedParms &editparms,
                                        UT_BitArray &selection,
                                        const CH_ChannelList &channels);
    virtual int          collectPropertiesFromParms(
                                        PI_EditScriptedParms &editparms,
                                        UT_StringArray &names,
                                        PRM_ParmNameMap &nmap);

protected:

    // Used to get pointer to indirection indices for each object type
    virtual int                 *getIndirect() const
                                { return ambientIndirect; }

    RE_Light                    *myRELight;
private:

    static int          *ambientIndirect;
};

#endif

---