All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
typed.h
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 USD_TYPED_H
25 #define 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 
35 PXR_NAMESPACE_OPEN_SCOPE
36 
37 
47 class UsdTyped : public UsdSchemaBase
48 {
49 public:
54 
59  explicit UsdTyped(const UsdPrim& prim=UsdPrim())
60  : UsdSchemaBase(prim)
61  {
62  }
63 
67  explicit UsdTyped(const UsdSchemaBase& schemaObj)
68  : UsdSchemaBase(schemaObj)
69  {
70  }
71 
72  USD_API
73  virtual ~UsdTyped();
74 
78  static const TfTokenVector &
79  GetSchemaAttributeNames(bool includeInherited=true) {
80  /* This only exists for consistency */
81  static TfTokenVector names;
82  return names;
83  }
84 
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 
108 PXR_NAMESPACE_CLOSE_SCOPE
109 
110 #endif // USD_TYPED_H
static const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor cl...
Definition: typed.h:79
static USD_API UsdTyped Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdTyped holding the prim adhering to this schema at path on stage.
UsdSchemaType
An enum representing which type of schema a given schema class belongs to.
Definition: common.h:149
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:131
The base class for all typed schemas (those that can impart a typeName to a UsdPrim), and therefore the base class for all instantiable and "IsA" schemas.
Definition: typed.h:47
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
UsdTyped(const UsdPrim &prim=UsdPrim())
Construct a UsdTyped on UsdPrim prim .
Definition: typed.h:59
USD_API bool _IsCompatible() const override
Subclasses may override _IsCompatible to do specific compatibility checking with the given prim...
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: typed.h:53
TfType represents a dynamic runtime type.
Definition: type.h:70
The base class for all schema types in Usd.
Definition: schemaBase.h:56
Represents abstract or base schema types that are interface-only and cannot be instantiated.
UsdTyped(const UsdSchemaBase &schemaObj)
Construct a UsdTyped on the prim wrapped by schemaObj .
Definition: typed.h:67