GU_CESnippet.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.
 *
 * NAME: GU_CESnippet.h ( CE Library, C++)
 *
 * COMMENTS: Snippet binding for GU objects into CE_Snippet.
 */

#ifndef __GU_CESnippet__
#define __GU_CESnippet__

#include "GU_API.h"
#include "GU_OSDEval.h"

#include <CE/CE_Array.h>
#include <CE/CE_BVH.h>
#include <CE/CE_Snippet.h>

class GU_Detail;
class GEO_PrimVolume;
class GA_CEAttributeAccessor;
using GA_CEAttributeAccessorPtr = UT_SharedPtr<GA_CEAttributeAccessor>;

class GU_API GU_CESnippetBindOp
{
public:
    GU_CESnippetBindOp(GU_Detail *gdp = nullptr) 
        : myGdp(gdp)
        , myRefVol(nullptr) 
    { }

    UT_NON_COPYABLE(GU_CESnippetBindOp)

    static GA_AttributeOwner              attribClassToOwner(CE_Snippet::BindingAttribClass cls);
    static CE_Snippet::BindingAttribClass ownerToAttribClass(GA_AttributeOwner owner);

    /// Reset the working objects, but leave pinned buffers intact.
    void                resetReferences()
    { myGdp = nullptr; myRefVol = nullptr; }
    /// Add an accessor as a reference to hold.
    void                addReference(GA_CEAttributeAccessorPtr access)
    { myAttribs.append(access); }

    void                setGdp(GU_Detail *gdp) { myGdp = gdp; }
    void                setRefVol(const GEO_PrimVolume *vol) { myRefVol = vol; }

    /// Is this binding optional, and if so, does it exist in the geometry?
    bool                requiresHas(const CE_Snippet::Binding &binding, CE_Precision precision) const;

    bool                operator()(const CE_Snippet::Binding &binding, int p,
                            cl::Kernel &kernel, int &argidx,
                            UT_ErrorManager *error,
                            CE_Precision precision) const;

    /// Clear all buffers that were pinned during the binding process
    /// Should only be done _after_ the kernel has been dispatched.
    /// Usually just let the destructor handle this.
    void                resetPinnedBuffers()
    { myAttribs.clear(); myBVHs.clear(); myOSDEvals.clear(); myOSDRefined.clear(); }

protected:
    bool                setAttribute(const CE_Snippet::Binding &binding, int p,
                            cl::Kernel &kernel, int &argidx,
                            UT_ErrorManager *error,
                            CE_Precision precision) const;

    bool                setVolume(const CE_Snippet::Binding &binding, int p,
                            cl::Kernel &kernel, int &argidx,
                            UT_ErrorManager *error,
                            CE_Precision precision) const;

    bool                setVDB(const CE_Snippet::Binding &binding, int p,
                            cl::Kernel &kernel, int &argidx,
                            UT_ErrorManager *error,
                            CE_Precision precision) const;

    GU_Detail                 *myGdp;
    const GEO_PrimVolume      *myRefVol;

    /// Attribute accessors that are pinned.
    mutable UT_Array<GA_CEAttributeAccessorPtr>   myAttribs;
    /// Temporary attribute BVH objects created on demand (TODO: remove).
    mutable UT_Array<CE_BVH>                      myBVHs;
    /// OSD evaluators per input, and refined CP buffers per OSD binding.
    mutable UT_Array<UT_UniquePtr<GU_OSDEval>>    myOSDEvals;
    mutable UT_Array<UT_UniquePtr<CE_FloatArray>>  myOSDRefined;
};

#endif