Loading...
Searching...
No Matches
openVDBAsset.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_OPENVDBASSET_H
25#define USDVOL_GENERATED_OPENVDBASSET_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// OPENVDBASSET //
51// -------------------------------------------------------------------------- //
52
64{
65public:
69 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
70
75 explicit UsdVolOpenVDBAsset(const UsdPrim& prim=UsdPrim())
76 : UsdVolFieldAsset(prim)
77 {
78 }
79
83 explicit UsdVolOpenVDBAsset(const UsdSchemaBase& schemaObj)
84 : UsdVolFieldAsset(schemaObj)
85 {
86 }
87
89 USDVOL_API
91
95 USDVOL_API
96 static const TfTokenVector &
97 GetSchemaAttributeNames(bool includeInherited=true);
98
108 USDVOL_API
109 static UsdVolOpenVDBAsset
110 Get(const UsdStagePtr &stage, const SdfPath &path);
111
134 USDVOL_API
135 static UsdVolOpenVDBAsset
136 Define(const UsdStagePtr &stage, const SdfPath &path);
137
138protected:
142 USDVOL_API
144
145private:
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
157public:
158 // --------------------------------------------------------------------- //
159 // FIELDDATATYPE
160 // --------------------------------------------------------------------- //
173 USDVOL_API
175
181 USDVOL_API
182 UsdAttribute CreateFieldDataTypeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
183
184public:
185 // --------------------------------------------------------------------- //
186 // FIELDCLASS
187 // --------------------------------------------------------------------- //
199 USDVOL_API
201
207 USDVOL_API
208 UsdAttribute CreateFieldClassAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
209
210public:
211 // ===================================================================== //
212 // Feel free to add custom code below this line, it will be preserved by
213 // the code generator.
214 //
215 // Just remember to:
216 // - Close the class declaration with };
217 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
218 // - Close the include guard with #endif
219 // ===================================================================== //
220 // --(BEGIN CUSTOM CODE)--
221};
222
223PXR_NAMESPACE_CLOSE_SCOPE
224
225#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
OpenVDB field primitive.
Definition: openVDBAsset.h:64
static USDVOL_API UsdVolOpenVDBAsset Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdVolOpenVDBAsset holding the prim adhering to this schema at path on stage.
USDVOL_API UsdAttribute GetFieldDataTypeAttr() const
Token which is used to indicate the data type of an individual field.
USDVOL_API UsdAttribute GetFieldClassAttr() const
Optional token which can be used to indicate the class of an individual grid.
virtual USDVOL_API ~UsdVolOpenVDBAsset()
Destructor.
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: openVDBAsset.h:69
static USDVOL_API UsdVolOpenVDBAsset Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
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...
UsdVolOpenVDBAsset(const UsdSchemaBase &schemaObj)
Construct a UsdVolOpenVDBAsset on the prim held by schemaObj .
Definition: openVDBAsset.h:83
UsdVolOpenVDBAsset(const UsdPrim &prim=UsdPrim())
Construct a UsdVolOpenVDBAsset on UsdPrim prim .
Definition: openVDBAsset.h:75
USDVOL_API UsdAttribute CreateFieldClassAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFieldClassAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
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