materialPrimvarTransferSceneIndex.h

Go to the documentation of this file.

//
// Copyright 2022 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 PXR_IMAGING_HDSI_MATERIAL_PRIMVAR_TRANSFER_SCENE_INDEX_H
#define PXR_IMAGING_HDSI_MATERIAL_PRIMVAR_TRANSFER_SCENE_INDEX_H

#include "pxr/imaging/hdsi/api.h"
#include "pxr/imaging/hd/filteringSceneIndex.h"

#include "pxr/pxr.h"

PXR_NAMESPACE_OPEN_SCOPE

TF_DECLARE_REF_PTRS(HdsiMaterialPrimvarTransferSceneIndex);

/// Transfers primvars present on the locally bound material. Any matching
/// primvar already present will have a stronger opinion.
/// 
/// As it's expected that primvars inherited by the destination location
/// should have a stronger opinion than those transfered here, inherited
/// primvars must be flattened in advance of this scene index.
/// 
/// This is in support of shading workflows.
///
/// This also declares dependencies to ensure invalidation if a
/// HdDependencyForwardingSceneIndex is present downstream. (Because those
/// dependencies are computed on demand, no meaningful additional work is done
/// otherwise.)
/// 
class HdsiMaterialPrimvarTransferSceneIndex final
    : public HdSingleInputFilteringSceneIndexBase
{
public:
    HDSI_API
    static HdsiMaterialPrimvarTransferSceneIndexRefPtr
    New(const HdSceneIndexBaseRefPtr& inputSceneIndex);

public: // HdSceneIndex overrides
    HDSI_API
    HdSceneIndexPrim GetPrim(const SdfPath& primPath) const override;

    HDSI_API
    SdfPathVector GetChildPrimPaths(const SdfPath& primPath) const override;

protected: // HdSingleInputFilteringSceneIndexBase overrides
    void _PrimsAdded(
        const HdSceneIndexBase& sender,
        const HdSceneIndexObserver::AddedPrimEntries& entries) override;
    void _PrimsRemoved(
        const HdSceneIndexBase& sender,
        const HdSceneIndexObserver::RemovedPrimEntries& entries) override;
    void _PrimsDirtied(
        const HdSceneIndexBase& sender,
        const HdSceneIndexObserver::DirtiedPrimEntries& entries) override;

private:
    HdsiMaterialPrimvarTransferSceneIndex(
        const HdSceneIndexBaseRefPtr& inputSceneIndex);
    ~HdsiMaterialPrimvarTransferSceneIndex() override;
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif