All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
field3DAsset.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_FIELD3DASSET_H
25 #define USDVOL_GENERATED_FIELD3DASSET_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdVol/api.h"
31 #include "pxr/usd/usdVol/fieldAsset.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "pxr/usd/usdVol/tokens.h"
35 
36 #include "pxr/base/vt/value.h"
37 
38 #include "pxr/base/gf/vec3d.h"
39 #include "pxr/base/gf/vec3f.h"
40 #include "pxr/base/gf/matrix4d.h"
41 
42 #include "pxr/base/tf/token.h"
43 #include "pxr/base/tf/type.h"
44 
45 PXR_NAMESPACE_OPEN_SCOPE
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // FIELD3DASSET //
51 // -------------------------------------------------------------------------- //
52 
64 {
65 public:
70 
75  explicit UsdVolField3DAsset(const UsdPrim& prim=UsdPrim())
76  : UsdVolFieldAsset(prim)
77  {
78  }
79 
83  explicit UsdVolField3DAsset(const UsdSchemaBase& schemaObj)
84  : UsdVolFieldAsset(schemaObj)
85  {
86  }
87 
89  USDVOL_API
90  virtual ~UsdVolField3DAsset();
91 
95  USDVOL_API
96  static const TfTokenVector &
97  GetSchemaAttributeNames(bool includeInherited=true);
98 
108  USDVOL_API
109  static UsdVolField3DAsset
110  Get(const UsdStagePtr &stage, const SdfPath &path);
111 
134  USDVOL_API
135  static UsdVolField3DAsset
136  Define(const UsdStagePtr &stage, const SdfPath &path);
137 
138 protected:
142  USDVOL_API
143  UsdSchemaType _GetSchemaType() const override;
144 
145 private:
146  // needs to invoke _GetStaticTfType.
147  friend class UsdSchemaRegistry;
148  USDVOL_API
149  static const TfType &_GetStaticTfType();
150 
151  static bool _IsTypedSchema();
152 
153  // override SchemaBase virtuals.
154  USDVOL_API
155  const TfType &_GetTfType() const override;
156 
157 public:
158  // --------------------------------------------------------------------- //
159  // FIELDNAME
160  // --------------------------------------------------------------------- //
169  USDVOL_API
171 
177  USDVOL_API
178  UsdAttribute CreateFieldNameAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
179 
180 public:
181  // --------------------------------------------------------------------- //
182  // FIELDPURPOSE
183  // --------------------------------------------------------------------- //
192  USDVOL_API
194 
200  USDVOL_API
201  UsdAttribute CreateFieldPurposeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
202 
203 public:
204  // --------------------------------------------------------------------- //
205  // FIELDINDEX
206  // --------------------------------------------------------------------- //
215  USDVOL_API
217 
223  USDVOL_API
224  UsdAttribute CreateFieldIndexAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
225 
226 public:
227  // ===================================================================== //
228  // Feel free to add custom code below this line, it will be preserved by
229  // the code generator.
230  //
231  // Just remember to:
232  // - Close the class declaration with };
233  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
234  // - Close the include guard with #endif
235  // ===================================================================== //
236  // --(BEGIN CUSTOM CODE)--
237 };
238 
239 PXR_NAMESPACE_CLOSE_SCOPE
240 
241 #endif
USDVOL_API UsdAttribute GetFieldIndexAttr() const
A Field3D file can contain multiple fields with the same name.
USDVOL_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
virtual USDVOL_API ~UsdVolField3DAsset()
Destructor.
static USDVOL_API UsdVolField3DAsset Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
Base class for field primitives defined by an external file.
Definition: fieldAsset.h:57
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
Represents a concrete typed schema.
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: field3DAsset.h:69
UsdVolField3DAsset(const UsdSchemaBase &schemaObj)
Construct a UsdVolField3DAsset on the prim held by schemaObj .
Definition: field3DAsset.h:83
UsdSchemaType
An enum representing which type of schema a given schema class belongs to.
Definition: common.h:149
Field3D field primitive.
Definition: field3DAsset.h:63
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
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
USDVOL_API UsdAttribute GetFieldPurposeAttr() const
Optional token which can be used to indicate the purpose or grouping of an individual field...
USDVOL_API UsdAttribute CreateFieldNameAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFieldNameAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDVOL_API UsdAttribute GetFieldNameAttr() const
Name of an individual field within the file specified by the filePath attribute.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
static USDVOL_API UsdVolField3DAsset Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdVolField3DAsset holding the prim adhering to this schema at path on stage.
TfType represents a dynamic runtime type.
Definition: type.h:70
Singleton registry that provides access to prim and property definition information for registered Us...
The base class for all schema types in Usd.
Definition: schemaBase.h:56
USDVOL_API UsdAttribute CreateFieldPurposeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFieldPurposeAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
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...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182
UsdVolField3DAsset(const UsdPrim &prim=UsdPrim())
Construct a UsdVolField3DAsset on UsdPrim prim .
Definition: field3DAsset.h:75
USDVOL_API UsdAttribute CreateFieldIndexAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFieldIndexAttr(), and also Create vs Get Property Methods for when to use Get vs Create...