HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
typed.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_USD_TYPED_H
25 #define PXR_USD_USD_TYPED_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/usd/usd/api.h"
29 #include "pxr/usd/usd/schemaBase.h"
30 #include "pxr/usd/usd/prim.h"
31 #include "pxr/usd/usd/stage.h"
32 
33 #include "pxr/base/tf/token.h"
34 
36 
37 
38 /// \class UsdTyped
39 ///
40 /// The base class for all \em typed schemas (those that can impart a
41 /// typeName to a UsdPrim), and therefore the base class for all
42 /// instantiable and "IsA" schemas.
43 ///
44 /// UsdTyped implements a typeName-based query for its override of
45 /// UsdSchemaBase::_IsCompatible(). It provides no other behavior.
46 ///
47 class UsdTyped : public UsdSchemaBase
48 {
49 public:
50  /// Compile time constant representing what kind of schema this class is.
51  ///
52  /// \sa UsdSchemaType in usd/common.h
54 
55  /// Construct a UsdTyped on UsdPrim \p prim .
56  /// Equivalent to UsdTyped::Get(prim.GetStage(), prim.GetPath())
57  /// for a \em valid \p prim, but will not immediately throw an error for
58  /// an invalid \p prim
59  explicit UsdTyped(const UsdPrim& prim=UsdPrim())
60  : UsdSchemaBase(prim)
61  {
62  }
63 
64  /// Construct a UsdTyped on the prim wrapped by \p schemaObj .
65  /// Should be preferred over UsdTyped(schemaObj.GetPrim()),
66  /// as it preserves SchemaBase state.
67  explicit UsdTyped(const UsdSchemaBase& schemaObj)
68  : UsdSchemaBase(schemaObj)
69  {
70  }
71 
72  USD_API
73  virtual ~UsdTyped();
74 
75  /// Return a vector of names of all pre-declared attributes for this schema
76  /// class and all its ancestor classes. Does not include attributes that
77  /// may be authored by custom/extended methods of the schemas involved.
78  static const TfTokenVector &
79  GetSchemaAttributeNames(bool includeInherited=true) {
80  /* This only exists for consistency */
81  static TfTokenVector names;
82  return names;
83  }
84 
85  /// Return a UsdTyped holding the prim adhering to this schema at \p path
86  /// on \p stage. If no prim exists at \p path on \p stage, or if the prim
87  /// at that path does not adhere to this schema, return an invalid schema
88  /// object. This is shorthand for the following:
89  ///
90  /// \code
91  /// UsdTyped(stage->GetPrimAtPath(path));
92  /// \endcode
93  ///
94  USD_API
95  static UsdTyped
96  Get(const UsdStagePtr &stage, const SdfPath &path);
97 
98 protected:
99  USD_API
100  bool _IsCompatible() const override;
101 
102 private:
103  USD_API
104  const TfType &_GetTfType() const override;
105 };
106 
107 
109 
110 #endif // PXR_USD_USD_TYPED_H
UsdTyped(const UsdPrim &prim=UsdPrim())
Definition: typed.h:59
#define USD_API
Definition: api.h:40
UsdTyped(const UsdSchemaBase &schemaObj)
Definition: typed.h:67
GLuint const GLuint * names
Definition: glew.h:2690
UsdSchemaType
Definition: common.h:127
Definition: prim.h:132
Definition: typed.h:47
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:446
Definition: path.h:288
virtual USD_API ~UsdTyped()
GLsizei const GLchar *const * path
Definition: glew.h:6461
static USD_API UsdTyped Get(const UsdStagePtr &stage, const SdfPath &path)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
static const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
Definition: typed.h:79
USD_API bool _IsCompatible() const override
Definition: type.h:64
static const UsdSchemaType schemaType
Definition: typed.h:53