cylinderAdapter.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 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_CYLINDER_ADAPTER_H
25 #define PXR_USD_IMAGING_USD_IMAGING_CYLINDER_ADAPTER_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usdImaging/usdImaging/api.h"
32 
33 PXR_NAMESPACE_OPEN_SCOPE
34 
35 
36 class UsdGeomCylinder;
37 
43 public:
45 
48  {}
49  USDIMAGING_API
50  virtual ~UsdImagingCylinderAdapter();
51 
52  // ---------------------------------------------------------------------- //
54  // ---------------------------------------------------------------------- //
55 
56  USDIMAGING_API
57  TfTokenVector GetImagingSubprims() override;
58 
59  USDIMAGING_API
60  TfToken GetImagingSubprimType(TfToken const& subprim) override;
61 
62  USDIMAGING_API
63  HdContainerDataSourceHandle GetImagingSubprimData(
64  TfToken const& subprim,
65  UsdPrim const& prim,
66  const UsdImagingDataSourceStageGlobals &stageGlobals) override;
67 
68  USDIMAGING_API
69  HdDataSourceLocatorSet InvalidateImagingSubprim(
70  TfToken const& subprim,
71  TfTokenVector const& properties) override;
72 
73  // ---------------------------------------------------------------------- //
75  // ---------------------------------------------------------------------- //
76 
77  USDIMAGING_API
79  UsdPrim const& prim,
80  UsdImagingIndexProxy* index,
81  UsdImagingInstancerContext const* instancerContext = nullptr) override;
82 
83  USDIMAGING_API
84  bool IsSupported(UsdImagingIndexProxy const* index) const override;
85 
86  USDIMAGING_API
87  HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
88  SdfPath const& cachePath,
89  TfToken const& propertyName);
90 
91  // ---------------------------------------------------------------------- //
93  // ---------------------------------------------------------------------- //
94 
96  USDIMAGING_API
97  void TrackVariability(
98  UsdPrim const& prim,
99  SdfPath const& cachePath,
100  HdDirtyBits* timeVaryingBits,
101  UsdImagingInstancerContext const* instancerContext = nullptr)
102  const override;
103 
104  // ---------------------------------------------------------------------- //
106  // ---------------------------------------------------------------------- //
107 
108  USDIMAGING_API
109  VtValue GetTopology(UsdPrim const& prim,
110  SdfPath const& cachePath,
111  UsdTimeCode time) const override;
112 
113  // Override the implemetation in GprimAdapter since we don't fetch the
114  // points attribute for implicit primitives.
115  USDIMAGING_API
117  UsdPrim const& prim,
118  UsdTimeCode time) const override;
119 
120  // Used by the legacyEngine.
121  USDIMAGING_API
122  static VtValue GetMeshPoints(UsdPrim const& prim,
123  UsdTimeCode time);
124 
125  // Used by the legacyEngine.
126  USDIMAGING_API
127  static VtValue GetMeshTopology();
128 };
129 
130 
131 PXR_NAMESPACE_CLOSE_SCOPE
132 
133 #endif // PXR_USD_IMAGING_USD_IMAGING_CYLINDER_ADAPTER_H
Delegate support for UsdGeomCylinder.
USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
Thread Safe.
This proxy class exposes a subset of the private Delegate API to PrimAdapters.
Definition: indexProxy.h:47
Delegate support for UsdGeomGrims.
Definition: gprimAdapter.h:48
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
Definition: timeCode.h:85
This class is used as a context object with global stage information, that gets passed down to dataso...
USDIMAGING_API VtValue GetPoints(UsdPrim const &prim, UsdTimeCode time) const override
Give derived classes an opportunity to override how we get points for a prim.
Represents a set of data source locators closed under descendancy.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:132
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=nullptr) override
Called to populate the RenderIndex for this UsdPrim.
Defines a primitive cylinder with closed ends, centered at the origin, whose spine is along the speci...
Definition: cylinder.h:66
USDIMAGING_API HdDirtyBits ProcessPropertyChange(UsdPrim const &prim, SdfPath const &cachePath, TfToken const &propertyName)
Returns a bit mask of attributes to be updated, or HdChangeTracker::AllDirty if the entire prim must ...
USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const override
Returns true if the adapter can be populated into the target index.
Object used by instancer prim adapters to pass along context about the instancer and instance prim to...
USDIMAGING_API VtValue GetTopology(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override
Gets the topology object of a specific Usd prim.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:166