Loading...
Searching...
No Matches
fieldAdapter.h
Go to the documentation of this file.
1//
2// Copyright 2018 Pixar
3//
4// Licensed under the Apache License, Version 2.0 (the "Apache License")
5// with the following modification; you may not use this file except in
6// compliance with the Apache License and the following modification to it:
7// Section 6. Trademarks. is deleted and replaced with:
8//
9// 6. Trademarks. This License does not grant permission to use the trade
10// names, trademarks, service marks, or product names of the Licensor
11// and its affiliates, except as required to comply with Section 4(c) of
12// the License and to reproduce the content of the NOTICE file.
13//
14// You may obtain a copy of the Apache License at
15//
16// http://www.apache.org/licenses/LICENSE-2.0
17//
18// Unless required by applicable law or agreed to in writing, software
19// distributed under the Apache License with the above modification is
20// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21// KIND, either express or implied. See the Apache License for the specific
22// language governing permissions and limitations under the Apache License.
23//
24#ifndef PXR_USD_IMAGING_USD_IMAGING_FIELD_ADAPTER_H
25#define PXR_USD_IMAGING_USD_IMAGING_FIELD_ADAPTER_H
26
28
29#include "pxr/pxr.h"
30#include "pxr/usdImaging/usdImaging/api.h"
32
33PXR_NAMESPACE_OPEN_SCOPE
34
35
36class UsdPrim;
37
43public:
45
46
49 {}
50
51 USDIMAGING_API
52 ~UsdImagingFieldAdapter() override;
53
54 USDIMAGING_API
58 instancerContext = nullptr) override;
59
60 USDIMAGING_API
61 bool IsSupported(UsdImagingIndexProxy const* index) const override;
62
63 // ---------------------------------------------------------------------- //
65 // ---------------------------------------------------------------------- //
66
68 USDIMAGING_API
69 void TrackVariability(UsdPrim const& prim,
70 SdfPath const& cachePath,
71 HdDirtyBits* timeVaryingBits,
73 instancerContext = nullptr) const override;
74
75
77 USDIMAGING_API
78 void UpdateForTime(UsdPrim const& prim,
79 SdfPath const& cachePath,
80 UsdTimeCode time,
81 HdDirtyBits requestedBits,
83 instancerContext = nullptr) const override;
84
85 // ---------------------------------------------------------------------- //
87 // ---------------------------------------------------------------------- //
88
91 USDIMAGING_API
92 HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
93 SdfPath const& cachePath,
94 TfToken const& propertyName) override;
95
96 USDIMAGING_API
97 void MarkDirty(UsdPrim const& prim,
98 SdfPath const& cachePath,
99 HdDirtyBits dirty,
100 UsdImagingIndexProxy* index) override;
101
102 USDIMAGING_API
103 void MarkTransformDirty(UsdPrim const& prim,
104 SdfPath const& cachePath,
105 UsdImagingIndexProxy* index) override;
106
107 USDIMAGING_API
108 void MarkVisibilityDirty(UsdPrim const& prim,
109 SdfPath const& cachePath,
110 UsdImagingIndexProxy* index) override;
111
112 // ---------------------------------------------------------------------- //
114 // ---------------------------------------------------------------------- //
115
116 USDIMAGING_API
117 VtValue Get(UsdPrim const& prim,
118 SdfPath const& cachePath,
119 TfToken const& key,
120 UsdTimeCode time,
121 VtIntArray *outIndices) const override;
122
123 // ---------------------------------------------------------------------- //
125 // ---------------------------------------------------------------------- //
128 USDIMAGING_API
129 virtual TfToken GetPrimTypeToken() const = 0;
130
131protected:
132 USDIMAGING_API
133 void _RemovePrim(SdfPath const& cachePath,
134 UsdImagingIndexProxy* index) override;
135};
136
137
138PXR_NAMESPACE_CLOSE_SCOPE
139
140#endif // PXR_USD_IMAGING_USD_IMAGING_FIELD_ADAPTER_H
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:291
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
Base class for all USD fields.
Definition: fieldAdapter.h:42
USDIMAGING_API void UpdateForTime(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time, HdDirtyBits requestedBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
Thread Safe.
USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
Thread Safe.
USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=nullptr) override
Called to populate the RenderIndex for this UsdPrim.
virtual USDIMAGING_API TfToken GetPrimTypeToken() const =0
Returns the token specifying the Hydra primitive type that is created by this adapter.
USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const override
Returns true if the adapter can be populated into the target index.
USDIMAGING_API HdDirtyBits ProcessPropertyChange(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName) override
Returns a bit mask of attributes to be udpated, or HdChangeTracker::AllDirty if the entire prim must ...
USDIMAGING_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...
This proxy class exposes a subset of the private Delegate API to PrimAdapters.
Definition: indexProxy.h:47
Base class for all PrimAdapters.
Definition: primAdapter.h:70
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:84
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:165
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...