volume.h

//
// Copyright 2019 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef EXT_RMANPKG_24_0_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_VOLUME_H
#define EXT_RMANPKG_24_0_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_VOLUME_H

#include "pxr/pxr.h"
#include "hdPrman/gprim.h"
#include "pxr/imaging/hd/field.h"
#include "pxr/imaging/hd/volume.h"

#include "Riley.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);

    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:
    RtPrimVarList
    _ConvertGeometry(HdPrman_RenderParam *renderParam,
                     HdSceneDelegate *sceneDelegate,
                     const SdfPath &id,
                     RtUString *primType,
                     std::vector<HdGeomSubset> *geomSubsets) override;

    riley::MaterialId
    _GetFallbackMaterial(HdPrman_RenderParam *renderParam) override {
        return renderParam->GetFallbackVolumeMaterialId();
    }

    using _VolumeEmitterMap = std::map<TfToken, HdPrman_VolumeTypeEmitter>;
    static _VolumeEmitterMap& _GetVolumeEmitterMap();
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif // EXT_RMANPKG_24_0_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_VOLUME_H