Loading...
Searching...
No Matches
fieldAsset.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_FIELDASSET_H
25#define USDVOL_GENERATED_FIELDASSET_H
26
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"
35
36#include "pxr/base/vt/value.h"
37
38#include "pxr/base/gf/vec3d.h"
39#include "pxr/base/gf/vec3f.h"
41
42#include "pxr/base/tf/token.h"
43#include "pxr/base/tf/type.h"
44
45PXR_NAMESPACE_OPEN_SCOPE
46
47class SdfAssetPath;
48
49// -------------------------------------------------------------------------- //
50// FIELDASSET //
51// -------------------------------------------------------------------------- //
52
63{
64public:
68 static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractTyped;
69
74 explicit UsdVolFieldAsset(const UsdPrim& prim=UsdPrim())
75 : UsdVolFieldBase(prim)
76 {
77 }
78
82 explicit UsdVolFieldAsset(const UsdSchemaBase& schemaObj)
83 : UsdVolFieldBase(schemaObj)
84 {
85 }
86
88 USDVOL_API
90
94 USDVOL_API
95 static const TfTokenVector &
96 GetSchemaAttributeNames(bool includeInherited=true);
97
107 USDVOL_API
108 static UsdVolFieldAsset
109 Get(const UsdStagePtr &stage, const SdfPath &path);
110
111
112protected:
116 USDVOL_API
118
119private:
120 // needs to invoke _GetStaticTfType.
121 friend class UsdSchemaRegistry;
122 USDVOL_API
123 static const TfType &_GetStaticTfType();
124
125 static bool _IsTypedSchema();
126
127 // override SchemaBase virtuals.
128 USDVOL_API
129 const TfType &_GetTfType() const override;
130
131public:
132 // --------------------------------------------------------------------- //
133 // FILEPATH
134 // --------------------------------------------------------------------- //
149 USDVOL_API
151
157 USDVOL_API
158 UsdAttribute CreateFilePathAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
159
160public:
161 // --------------------------------------------------------------------- //
162 // FIELDNAME
163 // --------------------------------------------------------------------- //
172 USDVOL_API
174
180 USDVOL_API
181 UsdAttribute CreateFieldNameAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
182
183public:
184 // --------------------------------------------------------------------- //
185 // FIELDINDEX
186 // --------------------------------------------------------------------- //
197 USDVOL_API
199
205 USDVOL_API
206 UsdAttribute CreateFieldIndexAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
207
208public:
209 // --------------------------------------------------------------------- //
210 // FIELDDATATYPE
211 // --------------------------------------------------------------------- //
223 USDVOL_API
225
231 USDVOL_API
232 UsdAttribute CreateFieldDataTypeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
233
234public:
235 // --------------------------------------------------------------------- //
236 // VECTORDATAROLEHINT
237 // --------------------------------------------------------------------- //
249 USDVOL_API
251
257 USDVOL_API
258 UsdAttribute CreateVectorDataRoleHintAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
259
260public:
261 // ===================================================================== //
262 // Feel free to add custom code below this line, it will be preserved by
263 // the code generator.
264 //
265 // Just remember to:
266 // - Close the class declaration with };
267 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
268 // - Close the include guard with #endif
269 // ===================================================================== //
270 // --(BEGIN CUSTOM CODE)--
271};
272
273PXR_NAMESPACE_CLOSE_SCOPE
274
275#endif
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
TfType represents a dynamic runtime type.
Definition: type.h:65
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
The base class for all schema types in Usd.
Definition: schemaBase.h:56
Singleton registry that provides access to schema type information and the prim definitions for regis...
Base class for field primitives defined by an external file.
Definition: fieldAsset.h:63
USDVOL_API UsdAttribute GetFieldDataTypeAttr() const
Token which is used to indicate the data type 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 GetFilePathAttr() const
An asset path attribute that points to a file on disk.
USDVOL_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: fieldAsset.h:68
USDVOL_API UsdAttribute GetFieldIndexAttr() const
A file can contain multiple fields with the same name.
USDVOL_API UsdAttribute GetFieldNameAttr() const
Name of an individual field within the file specified by the filePath attribute.
UsdVolFieldAsset(const UsdPrim &prim=UsdPrim())
Construct a UsdVolFieldAsset on UsdPrim prim .
Definition: fieldAsset.h:74
USDVOL_API UsdAttribute CreateVectorDataRoleHintAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetVectorDataRoleHintAttr(), and also Create vs Get Property Methods for when to use Get vs Creat...
USDVOL_API UsdAttribute CreateFieldDataTypeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFieldDataTypeAttr(), 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...
USDVOL_API UsdAttribute GetVectorDataRoleHintAttr() const
Optional token which is used to indicate the role of a vector valued field.
UsdVolFieldAsset(const UsdSchemaBase &schemaObj)
Construct a UsdVolFieldAsset on the prim held by schemaObj .
Definition: fieldAsset.h:82
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.
USDVOL_API UsdAttribute CreateFilePathAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFilePathAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
virtual USDVOL_API ~UsdVolFieldAsset()
Destructor.
static USDVOL_API UsdVolFieldAsset Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdVolFieldAsset holding the prim adhering to this schema at path on stage.
Base class for field primitives.
Definition: fieldBase.h:57
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:164
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:129
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:457