All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
fieldBase.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 USDVOL_GENERATED_FIELDBASE_H
25 #define USDVOL_GENERATED_FIELDBASE_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdVol/api.h"
31 #include "pxr/usd/usdGeom/boundable.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 
35 #include "pxr/base/vt/value.h"
36 
37 #include "pxr/base/gf/vec3d.h"
38 #include "pxr/base/gf/vec3f.h"
39 #include "pxr/base/gf/matrix4d.h"
40 
41 #include "pxr/base/tf/token.h"
42 #include "pxr/base/tf/type.h"
43 
44 PXR_NAMESPACE_OPEN_SCOPE
45 
46 class SdfAssetPath;
47 
48 // -------------------------------------------------------------------------- //
49 // FIELDBASE //
50 // -------------------------------------------------------------------------- //
51 
57 {
58 public:
63 
68  explicit UsdVolFieldBase(const UsdPrim& prim=UsdPrim())
69  : UsdGeomBoundable(prim)
70  {
71  }
72 
76  explicit UsdVolFieldBase(const UsdSchemaBase& schemaObj)
77  : UsdGeomBoundable(schemaObj)
78  {
79  }
80 
82  USDVOL_API
83  virtual ~UsdVolFieldBase();
84 
88  USDVOL_API
89  static const TfTokenVector &
90  GetSchemaAttributeNames(bool includeInherited=true);
91 
101  USDVOL_API
102  static UsdVolFieldBase
103  Get(const UsdStagePtr &stage, const SdfPath &path);
104 
105 
106 protected:
110  USDVOL_API
111  UsdSchemaType _GetSchemaType() const override;
112 
113 private:
114  // needs to invoke _GetStaticTfType.
115  friend class UsdSchemaRegistry;
116  USDVOL_API
117  static const TfType &_GetStaticTfType();
118 
119  static bool _IsTypedSchema();
120 
121  // override SchemaBase virtuals.
122  USDVOL_API
123  const TfType &_GetTfType() const override;
124 
125 public:
126  // ===================================================================== //
127  // Feel free to add custom code below this line, it will be preserved by
128  // the code generator.
129  //
130  // Just remember to:
131  // - Close the class declaration with };
132  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
133  // - Close the include guard with #endif
134  // ===================================================================== //
135  // --(BEGIN CUSTOM CODE)--
136 };
137 
138 PXR_NAMESPACE_CLOSE_SCOPE
139 
140 #endif
static USDVOL_API UsdVolFieldBase Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdVolFieldBase holding the prim adhering to this schema at path on stage.
static USDVOL_API 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...
USDVOL_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
Base class for field primitives.
Definition: fieldBase.h:56
UsdVolFieldBase(const UsdPrim &prim=UsdPrim())
Construct a UsdVolFieldBase on UsdPrim prim .
Definition: fieldBase.h:68
Boundable introduces the ability for a prim to persistently cache a rectilinear, local-space, extent.
Definition: boundable.h:82
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
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
Represents a non-concrete typed schema.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
TfType represents a dynamic runtime type.
Definition: type.h:70
virtual USDVOL_API ~UsdVolFieldBase()
Destructor.
Singleton registry that provides access to prim and property definition information for registered Us...
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: fieldBase.h:62
The base class for all schema types in Usd.
Definition: schemaBase.h:56
UsdVolFieldBase(const UsdSchemaBase &schemaObj)
Construct a UsdVolFieldBase on the prim held by schemaObj .
Definition: fieldBase.h:76