RixDisplacement.h

Go to the documentation of this file.

/*
# ------------------------------------------------------------------------------
#
# Copyright (c) 2020 Pixar. All rights reserved.
#
# The information in this file (the "Software") is provided for the exclusive
# use of the software licensees of Pixar ("Licensees").  Licensees have the
# right to incorporate the Software into other products for use by other
# authorized software licensees of Pixar, without fee. Except as expressly
# permitted herein, the Software may not be disclosed to third parties, copied
# or duplicated in any form, in whole or in part, without the prior written
# permission of Pixar.
#
# The copyright notices in the Software and this entire statement, including the
# above license grant, this restriction and the following disclaimer, must be
# included in all copies of the Software, in whole or in part, and all permitted
# derivative works of the Software, unless such copies or derivative works are
# solely in the form of machine-executable object code generated by a source
# language processor.
#
# PIXAR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL PIXAR BE
# LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
# OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.  IN NO CASE WILL
# PIXAR'S TOTAL LIABILITY FOR ALL DAMAGES ARISING OUT OF OR IN CONNECTION WITH
# THE USE OR PERFORMANCE OF THIS SOFTWARE EXCEED $50.
#
# Pixar
# 1200 Park Ave
# Emeryville CA 94608
#
# ------------------------------------------------------------------------------
*/

#ifndef RixDisplacement_h
#define RixDisplacement_h

#include "RixShading.h"                 // for RixShadingPlugin
#include "RiTypesHelper.h"              // for RtPoint3, etc.

class RixDisplacement;

class RixDisplacementFactory : public RixShadingPlugin
{
public:
    int GetInterface() const override { return k_RixDisplacementFactory; }

    virtual RixDisplacement* BeginDisplacement(
        RixShadingContext const*,
        RixSCShadingMode,
        void* instanceData) = 0;

    virtual void EndDisplacement(class RixDisplacement* disp) = 0;

protected:
    RixDisplacementFactory() : RixShadingPlugin(k_RixShadingVersion) {}
    ~RixDisplacementFactory() override {}
};

class RixDisplacement
{
public:
    RixDisplacement(RixShadingContext const* sCtx, RixDisplacementFactory* fact)
        : shadingCtx(sCtx), displacementFactory(fact)
    {
    }

    virtual ~RixDisplacement() {}

    virtual bool GetDisplacement(RtPoint3* P) = 0;

    RixShadingContext const* GetShadingCtx() const { return shadingCtx; }

    RixDisplacementFactory* GetDisplacementFactory() const
    {
        return displacementFactory;
    }

    virtual void Release()
    {
        if (displacementFactory)
            displacementFactory->EndDisplacement(this);
    }

protected:
    RixShadingContext const* shadingCtx;
    RixDisplacementFactory* displacementFactory;
};

// clang-format off
#define RIX_DISPLACEMENTCREATE \
    extern "C" PRMANEXPORT RixDisplacementFactory* CreateRixDisplacementFactory(const char* hint)

#define RIX_DISPLACEMENTDESTROY \
    extern "C" PRMANEXPORT void DestroyRixDisplacementFactory(RixDisplacementFactory* bxdf)
// clang-format on

#endif