volume.h

//
// Copyright 2019 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef EXT_RMANPKG_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_VOLUME_H
#define EXT_RMANPKG_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_VOLUME_H
 
#include "hdPrman/gprim.h"
 
#include "pxr/imaging/hd/field.h"
#include "pxr/imaging/hd/version.h"
#include "pxr/imaging/hd/volume.h"
 
#include "pxr/pxr.h"
 
#include <prmanapi.h>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class HdPrman_Field final : public HdField
{
public:
    HdPrman_Field(TfToken const& typeId, SdfPath const& id);
    void Sync(HdSceneDelegate *sceneDelegate,
              HdRenderParam *renderParam,
              HdDirtyBits *dirtyBits) override;
    void Finalize(HdRenderParam *renderParam) override;
    HdDirtyBits GetInitialDirtyBitsMask() const override;
private:
    TfToken const _typeId;
};
 
class HdPrman_Volume final : public HdPrman_Gprim<HdVolume>
{
public:
    using BASE = HdPrman_Gprim<HdVolume>;
public:
 
    HF_MALLOC_TAG_NEW("new HdPrman_Volume");
 
    HdPrman_Volume(SdfPath const& id, const bool isMeshLight);
 
    void Sync(HdSceneDelegate *sceneDelegate,
              HdRenderParam   *renderParam,
              HdDirtyBits     *dirtyBits,
              TfToken const   &reprToken) override;
 
    void Finalize(HdRenderParam *renderParam) override;
 
    HdDirtyBits GetInitialDirtyBitsMask() const override;
 
    using HdPrman_VolumeTypeEmitter =
                        void (*)(HdSceneDelegate *sceneDelegate,
                                 SdfPath const& id,
                                 HdVolumeFieldDescriptorVector const& fields,
                                 RtPrimVarList* primvars);
 
    static bool AddVolumeTypeEmitter(TfToken const& fieldPrimType,
                                     HdPrman_VolumeTypeEmitter emitterFunc,
                                     bool overrideExisting = false);
 
    enum FieldType {
        FloatType = 0,
        IntType,
        Float2Type,
        Int2Type,
        Float3Type,
        Int3Type,
        ColorType,
        PointType,
        NormalType,
        VectorType,
        Float4Type,
        MatrixType,
        StringType
    };
 
    static void DeclareFieldPrimvar(RtPrimVarList* primvars,
                                    RtUString const& fieldName,
                                    FieldType type);
 
protected:
    bool _ConvertGeometry(
        HdPrman_RenderParam *renderParam,
        HdSceneDelegate *sceneDelegate,
        const SdfPath &id,
        RtUString *primType,
        RtPrimVarList *primvars,
        std::vector<HdGeomSubset> *geomSubsets,
        std::vector<RtPrimVarList> *geomSubsetPrimvars) override;
 
    void _AddPrimvars(RtPrimVarList*) const override;
 
    const std::vector<riley::CoordinateSystemId>&
    _GetAdditionalCoordSysIds() const override;
 
    riley::MaterialId
    _GetFallbackMaterial(HdPrman_RenderParam *renderParam) override {
        return renderParam->GetFallbackVolumeMaterialId();
    }
 
    bool _PrototypeOnly() override;
 
    using _VolumeEmitterMap = std::map<TfToken, HdPrman_VolumeTypeEmitter>;
    static _VolumeEmitterMap& _GetVolumeEmitterMap();
 
private:
    bool _isMeshLight;
 
#if _PRMANAPI_VERSION_MAJOR_ >= 27 && HD_API_VERSION >= 93
    SdfPathVector _volumeFilterPaths;
    std::vector<RtUString> _volumeFilterNodeNames;
    std::vector<riley::VolumeFilterId> _volumeFilterIds;
    std::vector<riley::CoordinateSystemId> _volumeFilterCoordSysIds;
#endif
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // EXT_RMANPKG_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_VOLUME_H