RixPattern.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 RixPattern_h
#define RixPattern_h

#include <cstddef>                      // for NULL
#include "RixShading.h"                 // for RixSCParamInfo (ptr only), etc
#include "prmanapi.h"                   // for PRMANEXPORT
#include "RiTypesHelper.h"              // for RtUString, etc
#include "ndspy.h"                      // for UserParameter

class RixBakeContext;

class RixPattern : public RixShadingPlugin
{
public:
    int GetInterface() const override { return k_RixPattern; }

    struct OutputSpec
    {
        int paramId;          
        RixSCDetail detail;   
        void const* value; 
    };

    virtual int ComputeOutputParams(
        RixShadingContext const* sCtx,
        int* numOutputs,
        OutputSpec** outputs,
        void* instanceData,
        RixSCParamInfo const* instanceTable) = 0;

    struct Bake2dSpec
    {
        Bake2dSpec(int _uTile, int _vTile, int _paramId) :
            uTile(_uTile), vTile(_vTile), paramId(_paramId) {}
        int const uTile;       
        int const vTile;       
        int const paramId;     
        RixSCType dataType;    
        RtUString filename;     
        RtUString display;      
        RtUString primVar[2];   
        bool vInvert;     
        bool atlas;       
        int udimStride;   
        int udimOffset;   
        int resolution[2];     
        int displayParamCount; 
        UserParameter *displayParam; 
    };

    virtual bool Bake2dOutput(
        RixBakeContext const* bCtx,
        Bake2dSpec& output,
        void* instanceData) = 0;

    struct Bake3dSpec
    {
        Bake3dSpec(int _paramId) : paramId(_paramId) {}
        int const paramId;     
        RixSCType dataType;    
        RtUString filename;     
        RtUString display;      
        float maxDistance;     
        RtUString coordsys;     
        bool interpolate; 
        int displayParamCount; 
        UserParameter *displayParam; 
    };

    virtual bool Bake3dOutput(
        RixBakeContext const* bCtx,
        Bake3dSpec& output,
        void* instanceData) = 0;

protected:
    RixPattern() : RixShadingPlugin(k_RixShadingVersion) {}
    virtual ~RixPattern() {}
};

#define RIX_PATTERNCREATE \
    extern "C" PRMANEXPORT RixPattern* CreateRixPattern(const char* hint)

#define RIX_PATTERNDESTROY \
    extern "C" PRMANEXPORT void DestroyRixPattern(RixPattern* pattern)

class RixBakeContext : public RixContext
{
public:
    virtual void* Allocate(size_t size) const = 0;

protected:
    RixBakeContext() : RixContext() {}
    ~RixBakeContext() override {}
};

#endif