Loading...
Searching...
No Matches
pxrEnergyFilterAdapter.h
Go to the documentation of this file.
1//
2// Copyright 2024 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef EXT_RMANPKG_PLUGIN_RENDERMAN_PLUGIN_USD_RI_PXR_IMAGING_PXR_ENERGY_FILTER_ADAPTER_H
8#define EXT_RMANPKG_PLUGIN_RENDERMAN_PLUGIN_USD_RI_PXR_IMAGING_PXR_ENERGY_FILTER_ADAPTER_H
9
11
12#include "usdRiPxrImaging/api.h"
13
15
16#include "pxr/pxr.h"
17
18PXR_NAMESPACE_OPEN_SCOPE
19
20
26{
27public:
29
32 {}
33
34 USDRIPXRIMAGING_API
36
37 // ---------------------------------------------------------------------- //
39 // ---------------------------------------------------------------------- //
40
41 USDRIPXRIMAGING_API
42 TfTokenVector GetImagingSubprims(UsdPrim const& prim) override;
43
44 USDRIPXRIMAGING_API
45 TfToken GetImagingSubprimType(
46 UsdPrim const& prim,
47 TfToken const& subprim) override;
48
49 USDRIPXRIMAGING_API
50 HdContainerDataSourceHandle GetImagingSubprimData(
51 UsdPrim const& prim,
52 TfToken const& subprim,
53 const UsdImagingDataSourceStageGlobals &stageGlobals) override;
54
55 USDRIPXRIMAGING_API
56 HdDataSourceLocatorSet InvalidateImagingSubprim(
57 UsdPrim const& prim,
58 TfToken const& subprim,
59 TfTokenVector const& properties,
60 UsdImagingPropertyInvalidationType invalidationType) override;
61
62 // ---------------------------------------------------------------------- //
64 // ---------------------------------------------------------------------- //
65
66 USDRIPXRIMAGING_API
70 instancerContext = nullptr) override;
71
72 USDRIPXRIMAGING_API
73 bool IsSupported(UsdImagingIndexProxy const* index) const override;
74
75 // ---------------------------------------------------------------------- //
77 // ---------------------------------------------------------------------- //
78
79 USDRIPXRIMAGING_API
80 void TrackVariability(UsdPrim const& prim,
81 SdfPath const& cachePath,
82 HdDirtyBits* timeVaryingBits,
84 instancerContext = nullptr) const override;
85
86 USDRIPXRIMAGING_API
87 void UpdateForTime(UsdPrim const& prim,
88 SdfPath const& cachePath,
89 UsdTimeCode time,
90 HdDirtyBits requestedBits,
92 instancerContext = nullptr) const override;
93
94 // ---------------------------------------------------------------------- //
96 // ---------------------------------------------------------------------- //
97
98 USDRIPXRIMAGING_API
99 HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
100 SdfPath const& cachePath,
101 TfToken const& propertyName) override;
102
103 USDRIPXRIMAGING_API
104 void MarkDirty(UsdPrim const& prim,
105 SdfPath const& cachePath,
106 HdDirtyBits dirty,
107 UsdImagingIndexProxy* index) override;
108
109 // ---------------------------------------------------------------------- //
111 // ---------------------------------------------------------------------- //
112
113 USDRIPXRIMAGING_API
114 VtValue Get(UsdPrim const& prim,
115 SdfPath const& cachePath,
116 TfToken const& key,
117 UsdTimeCode time,
118 VtIntArray *outIndices) const override;
119
120protected:
121 USDRIPXRIMAGING_API
122 void _RemovePrim(SdfPath const& cachePath,
123 UsdImagingIndexProxy* index) override;
124
125};
126
127
128PXR_NAMESPACE_CLOSE_SCOPE
129
130#endif // EXT_RMANPKG_PLUGIN_RENDERMAN_PLUGIN_USD_RI_PXR_IMAGING_PXR_ENERGY_FILTER_ADAPTER_H
Represents a set of data source locators closed under descendancy.
A path value used to locate objects in layers or scenegraphs.
Definition path.h:281
Token for efficient comparison, assignment, and hashing of known strings.
Definition token.h:71
This class is used as a context object with global stage information, that gets passed down to dataso...
This proxy class exposes a subset of the private Delegate API to PrimAdapters.
Definition indexProxy.h:30
Base class for all PrimAdapters.
Definition primAdapter.h:54
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition prim.h:117
Delegate support for Energy Filter Prims.
USDRIPXRIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const override
Returns true if the adapter can be populated into the target index.
USDRIPXRIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
For the given prim, variability is detected and stored in timeVaryingBits.
USDRIPXRIMAGING_API HdDirtyBits ProcessPropertyChange(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName) override
Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must ...
USDRIPXRIMAGING_API VtValue Get(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &key, UsdTimeCode time, VtIntArray *outIndices) const override
Gets the value of the parameter named key for the given prim (which has the given cache path) and giv...
USDRIPXRIMAGING_API void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
Populates the cache for the given prim, time and requestedBits.
USDRIPXRIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=nullptr) override
Called to populate the RenderIndex for this UsdPrim.
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition timeCode.h:72
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition value.h:90
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...
std::vector< TfToken > TfTokenVector
Convenience types.
Definition token.h:440