HDK
 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 
27 /// \file usdVol/fieldBase.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdVol/api.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 
45 
46 class SdfAssetPath;
47 
48 // -------------------------------------------------------------------------- //
49 // FIELDBASE //
50 // -------------------------------------------------------------------------- //
51 
52 /// \class UsdVolFieldBase
53 ///
54 /// Base class for field primitives.
55 ///
57 {
58 public:
59  /// Compile time constant representing what kind of schema this class is.
60  ///
61  /// \sa UsdSchemaKind
63 
64  /// Construct a UsdVolFieldBase on UsdPrim \p prim .
65  /// Equivalent to UsdVolFieldBase::Get(prim.GetStage(), prim.GetPath())
66  /// for a \em valid \p prim, but will not immediately throw an error for
67  /// an invalid \p prim
68  explicit UsdVolFieldBase(const UsdPrim& prim=UsdPrim())
69  : UsdGeomXformable(prim)
70  {
71  }
72 
73  /// Construct a UsdVolFieldBase on the prim held by \p schemaObj .
74  /// Should be preferred over UsdVolFieldBase(schemaObj.GetPrim()),
75  /// as it preserves SchemaBase state.
76  explicit UsdVolFieldBase(const UsdSchemaBase& schemaObj)
77  : UsdGeomXformable(schemaObj)
78  {
79  }
80 
81  /// Destructor.
83  virtual ~UsdVolFieldBase();
84 
85  /// Return a vector of names of all pre-declared attributes for this schema
86  /// class and all its ancestor classes. Does not include attributes that
87  /// may be authored by custom/extended methods of the schemas involved.
89  static const TfTokenVector &
90  GetSchemaAttributeNames(bool includeInherited=true);
91 
92  /// Return a UsdVolFieldBase holding the prim adhering to this
93  /// schema at \p path on \p stage. If no prim exists at \p path on
94  /// \p stage, or if the prim at that path does not adhere to this schema,
95  /// return an invalid schema object. This is shorthand for the following:
96  ///
97  /// \code
98  /// UsdVolFieldBase(stage->GetPrimAtPath(path));
99  /// \endcode
100  ///
101  USDVOL_API
102  static UsdVolFieldBase
103  Get(const UsdStagePtr &stage, const SdfPath &path);
104 
105 
106 protected:
107  /// Returns the kind of schema this class belongs to.
108  ///
109  /// \sa UsdSchemaKind
110  USDVOL_API
111  UsdSchemaKind _GetSchemaKind() 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 
139 
140 #endif
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
UsdVolFieldBase(const UsdSchemaBase &schemaObj)
Definition: fieldBase.h:76
UsdSchemaKind
Definition: common.h:127
Definition: prim.h:132
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
Definition: path.h:290
static USDVOL_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
USDVOL_API UsdSchemaKind _GetSchemaKind() const override
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Represents a non-concrete typed schema.
Definition: type.h:64
#define USDVOL_API
Definition: api.h:40
static USDVOL_API UsdVolFieldBase Get(const UsdStagePtr &stage, const SdfPath &path)
static const UsdSchemaKind schemaKind
Definition: fieldBase.h:62
UsdVolFieldBase(const UsdPrim &prim=UsdPrim())
Definition: fieldBase.h:68
virtual USDVOL_API ~UsdVolFieldBase()
Destructor.