HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pinnedCurveExpandingSceneIndex.h
Go to the documentation of this file.
1 //
2 // Copyright 2022 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/LICEN SE-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_IMAGING_HDSI_PINNED_CURVE_EXPANDING_SCENE_INDEX_H
25 #define PXR_IMAGING_HDSI_PINNED_CURVE_EXPANDING_SCENE_INDEX_H
26 
27 #include "pxr/imaging/hdsi/api.h"
29 
31 
33 
34 /// \class HdsiPinnedCurveExpandingSceneIndex
35 ///
36 /// Pinned curves are a special case of non-periodic cubic curves (relevant only
37 /// for BSpline and CatmullRom basis) where the authored intent is for each
38 /// curve to begin and end at its first and last control points respectively.
39 /// This is done by setting the 'wrap' mode on the topology to 'pinned'.
40 ///
41 /// Renderers that don't provide built-in support for pinned curves can use this
42 /// scene index to "expand" or "unpack" the authored data. This involves the
43 /// following:
44 /// - Adding "phantom" points at the ends of each curve. For BSpline basis, each
45 /// end point is repeated twice (so we have 3 consecutive identical points on
46 /// each end) while for CatmullRom basis, each end point is repeated once.
47 /// The topology is modified to reflect this.
48 ///
49 /// - Expanding vertex primvars to account for the additional control points and
50 /// varying primvars to account for the additional segments.
51 ///
52 /// \note This scene index does not convert indexed curves (i.e., with authored
53 /// curve indices) into non-indexed curves.
54 ///
57 {
58 public:
59  HDSI_API
60  static HdsiPinnedCurveExpandingSceneIndexRefPtr
61  New(const HdSceneIndexBaseRefPtr &inputSceneIndex);
62 
63  HDSI_API
64  HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override final;
65 
66  HDSI_API
67  SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override final;
68 
69 protected:
70  HDSI_API
71  void _PrimsAdded(
72  const HdSceneIndexBase &sender,
73  const HdSceneIndexObserver::AddedPrimEntries &entries) override final;
74 
75  HDSI_API
76  void _PrimsRemoved(
77  const HdSceneIndexBase &sender,
78  const HdSceneIndexObserver::RemovedPrimEntries &entries) override final;
79 
80  HDSI_API
81  void _PrimsDirtied(
82  const HdSceneIndexBase &sender,
83  const HdSceneIndexObserver::DirtiedPrimEntries &entries) override final;
84 
85  HDSI_API
87  const HdSceneIndexBaseRefPtr &inputSceneIndex);
88 
89 };
90 
92 
93 #endif //PXR_IMAGING_HDSI_PINNED_CURVE_EXPANDING_SCENE_INDEX_H
HDSI_API SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const overridefinal
HDSI_API void _PrimsRemoved(const HdSceneIndexBase &sender, const HdSceneIndexObserver::RemovedPrimEntries &entries) overridefinal
HDSI_API HdsiPinnedCurveExpandingSceneIndex(const HdSceneIndexBaseRefPtr &inputSceneIndex)
HDSI_API void _PrimsAdded(const HdSceneIndexBase &sender, const HdSceneIndexObserver::AddedPrimEntries &entries) overridefinal
static HDSI_API HdsiPinnedCurveExpandingSceneIndexRefPtr New(const HdSceneIndexBaseRefPtr &inputSceneIndex)
HDSI_API void _PrimsDirtied(const HdSceneIndexBase &sender, const HdSceneIndexObserver::DirtiedPrimEntries &entries) overridefinal
Definition: path.h:290
std::vector< class SdfPath > SdfPathVector
A vector of SdfPaths.
Definition: path.h:211
#define HDSI_API
Definition: api.h:40
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1432
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
PXR_NAMESPACE_OPEN_SCOPE TF_DECLARE_WEAK_AND_REF_PTRS(HdsiPinnedCurveExpandingSceneIndex)
HDSI_API HdSceneIndexPrim GetPrim(const SdfPath &primPath) const overridefinal