GR/GR_RenderHook.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:
 *      Jeff Lait
 *      Side Effects Software Inc
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        GR_RenderHook.h ( GR Library, C++)
 *
 * COMMENTS:
 *      This defines the interface by which custom DSOs can
 *      hook into the render pipeline.
 */

#ifndef __GR_RenderHook__
#define __GR_RenderHook__

#include "GR_API.h"
#include <GEO/GEO_PrimType.h>

class RE_Render;
class GU_Detail;
class GR_AttribOffset;
class GU_PrimGroupClosure;
class GR_DisplayOption;

class GR_API GR_RenderHook
{
public:
                 GR_RenderHook() {}
    virtual     ~GR_RenderHook() {}

    // This determines what types of primitives should still be rendered
    // after this hook is done.  By default, all primitives will still
    // be rendered.
    virtual int  getWireMask(GU_Detail * /*gdp*/,
                             const GR_DisplayOption * /*dopt*/) const
                 {
                     return GEOPRIMALL;
                 }

    // This renders in wire frame.
    virtual void renderWire(GU_Detail *gdp,
                        RE_Render &ren,
                        const GR_AttribOffset &ptinfo,
                        const GR_DisplayOption *dopt,
                        float lod,
                        const GU_PrimGroupClosure *hidden_geometry) = 0;

    virtual int  getShadedMask(GU_Detail * /*gdp*/,
                               const GR_DisplayOption * /*dopt*/) const
                 {
                     return GEOPRIMALL;
                 }

    // And this in shaded.
    virtual void renderShaded(GU_Detail *gdp,
                        RE_Render &ren,
                        const GR_AttribOffset &ptinfo,
                        const GR_DisplayOption *dopt,
                        float lod,
                        const GU_PrimGroupClosure *hidden_geometry) = 0;

    // Each Render hook has a unique name.  If two render hooks
    // of the same name are added to the table, only the first
    // one is kept.  This means multiple DSOs in the HOUDINI_PATH
    // will hide each other in the expected fashion.
    virtual const char  *getName() const = 0;
protected:
};

#endif

---