HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
coordSys.h
Go to the documentation of this file.
1 //
2 // Copyright 2019 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_IMAGING_HD_COORD_SYS_H
25 #define PXR_IMAGING_HD_COORD_SYS_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
29 #include "pxr/imaging/hd/version.h"
30 #include "pxr/imaging/hd/sprim.h"
31 
32 #include "pxr/base/vt/dictionary.h"
33 #include "pxr/base/vt/value.h"
34 
35 #include <memory>
36 #include <vector>
37 
39 
40 class HdSceneDelegate;
41 
42 /// \class HdCoordSys
43 ///
44 /// HdCoordSys representes a coordinate system as a Hydra state prim.
45 ///
46 /// Coordinate systems may be referred to by name from a shader network.
47 /// Following the convention in UsdShadeCoordSysAPI, we use the Hydra
48 /// id to establish the name, where the id is a namespaced property
49 /// path of the form <tt><.../prim.coordSys:NAME></tt>. GetName()
50 /// will retrieve the name.
51 ///
52 /// Each rprim may have a set of bound coordinate systems, which
53 /// may be retrieved via the <tt>HdTokens->coordSysBindings</tt> key.
54 /// The returned value is of type HdIdVectorSharedPtr, a reference-
55 /// counted pointer to a vector of ids of coordinate systems.
56 /// The intention of this design is to make it efficient for scene
57 /// delegates to communicate to renderer delegates the common
58 /// mappings of bound coordinate systems across groups of rprims.
59 ///
60 /// The transform value of an HdCoordSys is the matrix representation
61 /// of the transform from its local space to world space. In other
62 /// words, it has the same interpretation as the transform for rprims.
63 ///
64 class HdCoordSys : public HdSprim {
65 public:
66  HD_API
67  HdCoordSys(SdfPath const & id);
68  HD_API
69  virtual ~HdCoordSys();
70 
71  // Change tracking for HdCoordSys
73  Clean = 0,
74  DirtyTransform = 1 << 0,
76  };
77 
78  /// Returns the name bound to this coordinate system.
79  ///
80  /// There may be multiple coordinate systems with the same
81  /// name, but they must associate with disjoint sets of rprims.
82  TfToken GetName() const { return _name; }
83 
84 private:
85  TfToken _name;
86 };
87 
89 
90 #endif // PXR_IMAGING_HD_COORD_SYS_H
virtual HD_API ~HdCoordSys()
uint32_t HdDirtyBits
Definition: types.h:127
#define HD_API
Definition: api.h:40
Definition: token.h:87
Definition: path.h:288
HD_API HdCoordSys(SdfPath const &id)
Definition: sprim.h:52
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
TfToken GetName() const
Definition: coordSys.h:82