Loading...
Searching...
No Matches
capsuleAdapter.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_CAPSULE_ADAPTER_H
25#define PXR_USD_IMAGING_USD_IMAGING_CAPSULE_ADAPTER_H
26
28
29#include "pxr/pxr.h"
30#include "pxr/usdImaging/usdImaging/api.h"
32
33PXR_NAMESPACE_OPEN_SCOPE
34
35
36class UsdGeomCapsule;
37
43public:
45
46 // Number of radial segments on a circular cross-section of the capsule.
47 static constexpr size_t numRadial = 10;
48 // Number of divisions along the spine axis for each hemispherical cap.
49 static constexpr size_t numCapAxial = 4;
50
53 {}
54 USDIMAGING_API
56
57 // ---------------------------------------------------------------------- //
59 // ---------------------------------------------------------------------- //
60
61 USDIMAGING_API
62 TfTokenVector GetImagingSubprims(UsdPrim const& prim) override;
63
64 USDIMAGING_API
65 TfToken GetImagingSubprimType(UsdPrim const& prim, TfToken const& subprim)
66 override;
67
68 USDIMAGING_API
69 HdContainerDataSourceHandle GetImagingSubprimData(
70 UsdPrim const& prim,
71 TfToken const& subprim,
72 const UsdImagingDataSourceStageGlobals &stageGlobals) override;
73
74 USDIMAGING_API
75 HdDataSourceLocatorSet InvalidateImagingSubprim(
76 UsdPrim const& prim,
77 TfToken const& subprim,
78 TfTokenVector const& properties,
79 UsdImagingPropertyInvalidationType invalidationType) override;
80
81 // ---------------------------------------------------------------------- //
83 // ---------------------------------------------------------------------- //
84
85 USDIMAGING_API
87 UsdPrim const& prim,
89 UsdImagingInstancerContext const* instancerContext = nullptr) 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 // ---------------------------------------------------------------------- //
102
104 USDIMAGING_API
106 UsdPrim const& prim,
107 SdfPath const& cachePath,
108 HdDirtyBits* timeVaryingBits,
109 UsdImagingInstancerContext const* instancerContext = nullptr)
110 const override;
111
112 // ---------------------------------------------------------------------- //
114 // ---------------------------------------------------------------------- //
115
116 USDIMAGING_API
118 SdfPath const& cachePath,
119 UsdTimeCode time) const override;
120
121 // Override the implemetation in GprimAdapter since we don't fetch the
122 // points attribute for implicit primitives.
123 USDIMAGING_API
125 UsdPrim const& prim,
126 UsdTimeCode time) const override;
127};
128
129
130PXR_NAMESPACE_CLOSE_SCOPE
131
132#endif // PXR_USD_IMAGING_USD_IMAGING_CAPSULE_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:290
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
Defines a primitive capsule, i.e.
Definition: capsule.h:68
Delegate support for UsdGeomCapsule.
USDIMAGING_API void TrackVariability(UsdPrim const &prim, SdfPath const &cachePath, HdDirtyBits *timeVaryingBits, UsdImagingInstancerContext const *instancerContext=nullptr) const override
Thread Safe.
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 SdfPath Populate(UsdPrim const &prim, UsdImagingIndexProxy *index, UsdImagingInstancerContext const *instancerContext=nullptr) override
Called to populate the RenderIndex for this UsdPrim.
USDIMAGING_API bool IsSupported(UsdImagingIndexProxy const *index) const override
Returns true if the adapter can be populated into the target index.
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.
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 ...
This class is used as a context object with global stage information, that gets passed down to dataso...
Delegate support for UsdGeomGrims.
Definition: gprimAdapter.h:49
This proxy class exposes a subset of the private Delegate API to PrimAdapters.
Definition: indexProxy.h:47
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:164
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:457