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
30#if PXR_VERSION >= 2608
31
34 {}
35
36 USDRIPXRIMAGING_API
38
39 // ---------------------------------------------------------------------- //
41 // ---------------------------------------------------------------------- //
42
43 USDRIPXRIMAGING_API
44 TfTokenVector GetImagingSubprims(UsdPrim const& prim) override;
45
46 USDRIPXRIMAGING_API
47 TfToken GetImagingSubprimType(
48 UsdPrim const& prim,
49 TfToken const& subprim) override;
50
51 USDRIPXRIMAGING_API
52 HdContainerDataSourceHandle GetImagingSubprimData(
53 UsdPrim const& prim,
54 TfToken const& subprim,
55 const UsdImagingDataSourceStageGlobals &stageGlobals) override;
56
57 USDRIPXRIMAGING_API
58 HdDataSourceLocatorSet InvalidateImagingSubprim(
59 UsdPrim const& prim,
60 TfToken const& subprim,
61 TfTokenVector const& properties,
62 UsdImagingPropertyInvalidationType invalidationType) override;
63
64 // ---------------------------------------------------------------------- //
66 // ---------------------------------------------------------------------- //
67
68#endif
69
70 USDRIPXRIMAGING_API
74 instancerContext = nullptr) override;
75
76#if PXR_VERSION >= 2608
77
78 USDRIPXRIMAGING_API
79 bool IsSupported(UsdImagingIndexProxy const* index) const override;
80
81 // ---------------------------------------------------------------------- //
83 // ---------------------------------------------------------------------- //
84
85#endif
86
87 USDRIPXRIMAGING_API
88 void TrackVariability(UsdPrim const& prim,
89 SdfPath const& cachePath,
90 HdDirtyBits* timeVaryingBits,
92 instancerContext = nullptr) const override;
93
94 USDRIPXRIMAGING_API
95 void UpdateForTime(UsdPrim const& prim,
96 SdfPath const& cachePath,
97 UsdTimeCode time,
98 HdDirtyBits requestedBits,
100 instancerContext = nullptr) const override;
101
102 // ---------------------------------------------------------------------- //
104 // ---------------------------------------------------------------------- //
105
106 USDRIPXRIMAGING_API
107 HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
108 SdfPath const& cachePath,
109 TfToken const& propertyName) override;
110
111 USDRIPXRIMAGING_API
112 void MarkDirty(UsdPrim const& prim,
113 SdfPath const& cachePath,
114 HdDirtyBits dirty,
115 UsdImagingIndexProxy* index) override;
116
117 // ---------------------------------------------------------------------- //
119 // ---------------------------------------------------------------------- //
120
121#if PXR_VERSION >= 2608
122
123 USDRIPXRIMAGING_API
124 VtValue Get(UsdPrim const& prim,
125 SdfPath const& cachePath,
126 TfToken const& key,
127 UsdTimeCode time,
128 VtIntArray *outIndices) const override;
129
130#endif
131
132protected:
133 USDRIPXRIMAGING_API
134 void _RemovePrim(SdfPath const& cachePath,
135 UsdImagingIndexProxy* index) override;
136
137};
138
139
140PXR_NAMESPACE_CLOSE_SCOPE
141
142#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:81
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
virtual USDIMAGING_API VtValue Get(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &key, UsdTimeCode time, VtIntArray *outIndices) const
Gets the value of the parameter named key for the given prim (which has the given cache path) and giv...
virtual bool IsSupported(UsdImagingIndexProxy const *index) const
Returns true if the adapter can be populated into the target index.
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 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 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:73
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:489