sphereAdapter.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_SPHERE_ADAPTER_H
25 #define PXR_USD_IMAGING_USD_IMAGING_SPHERE_ADAPTER_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usdImaging/usdImaging/api.h"
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
36 
37 class UsdGeomSphere;
38 
44 {
45 public:
47 
48  // Number of radial segments about the Z axis.
49  static constexpr size_t numRadial = 10;
50  // Number of divisions along the Z axis.
51  static constexpr size_t numAxial = 10;
52 
55  {}
56  USDIMAGING_API
57  ~UsdImagingSphereAdapter() override;
58 
59  // ---------------------------------------------------------------------- //
61  // ---------------------------------------------------------------------- //
62 
63  USDIMAGING_API
64  TfTokenVector GetImagingSubprims() override;
65 
66  USDIMAGING_API
67  TfToken GetImagingSubprimType(TfToken const& subprim) override;
68 
69  USDIMAGING_API
70  HdContainerDataSourceHandle GetImagingSubprimData(
71  TfToken const& subprim,
72  UsdPrim const& prim,
73  const UsdImagingDataSourceStageGlobals &stageGlobals) override;
74 
75  USDIMAGING_API
76  HdDataSourceLocatorSet InvalidateImagingSubprim(
77  TfToken const& subprim,
78  TfTokenVector const& properties) override;
79 
80  // ---------------------------------------------------------------------- //
82  // ---------------------------------------------------------------------- //
83 
84  USDIMAGING_API
86  UsdPrim const& prim,
87  UsdImagingIndexProxy* index,
88  UsdImagingInstancerContext const* instancerContext = nullptr)
89  override;
90 
91  USDIMAGING_API
92  bool IsSupported(UsdImagingIndexProxy const* index) const override;
93 
94  USDIMAGING_API
95  HdDirtyBits ProcessPropertyChange(UsdPrim const& prim,
96  SdfPath const& cachePath,
97  TfToken const& propertyName) override;
98 
99  // ---------------------------------------------------------------------- //
101  // ---------------------------------------------------------------------- //
103  USDIMAGING_API
104  void TrackVariability(
105  UsdPrim const& prim,
106  SdfPath const& cachePath,
107  HdDirtyBits* timeVaryingBits,
108  UsdImagingInstancerContext const* instancerContext = nullptr)
109  const override;
110 
111  // ---------------------------------------------------------------------- //
113  // ---------------------------------------------------------------------- //
114 
115  USDIMAGING_API
116  VtValue GetTopology(UsdPrim const& prim,
117  SdfPath const& cachePath,
118  UsdTimeCode time) const override;
119 
120  // Override the implemetation in GprimAdapter since we don't fetch the
121  // points attribute for implicit primitives.
122  USDIMAGING_API
124  UsdPrim const& prim,
125  UsdTimeCode time) const override;
126 };
127 
128 
129 PXR_NAMESPACE_CLOSE_SCOPE
130 
131 #endif // PXR_USD_IMAGING_USD_IMAGING_SPHERE_ADAPTER_H
USDIMAGING_API VtValue GetTopology(UsdPrim const &prim, SdfPath const &cachePath, UsdTimeCode time) const override
Gets the topology object of a specific Usd prim.
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.
This proxy class exposes a subset of the private Delegate API to PrimAdapters.
Definition: indexProxy.h:47
USDIMAGING_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 ...
Delegate support for UsdGeomGrims.
Definition: gprimAdapter.h:48
Delegate support for UsdGeomSphere.
Definition: sphereAdapter.h:43
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
Defines a primitive sphere centered at the origin.
Definition: sphere.h:60
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...
Base class for all PrimAdapters.
Definition: primAdapter.h:67
Represents a set of data source locators closed under descendancy.
USDIMAGING_API SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=nullptr) override
Called to populate the RenderIndex for this UsdPrim.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
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 void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
Thread Safe.
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...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:166