Loading...
Searching...
No Matches
particleField.h
Go to the documentation of this file.
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef USDVOL_GENERATED_PARTICLEFIELD_H
8#define USDVOL_GENERATED_PARTICLEFIELD_H
9
11
12#include "pxr/pxr.h"
13#include "pxr/usd/usdVol/api.h"
15#include "pxr/usd/usd/prim.h"
16#include "pxr/usd/usd/stage.h"
17
18#include "pxr/base/vt/value.h"
19
20#include "pxr/base/gf/vec3d.h"
21#include "pxr/base/gf/vec3f.h"
23
24#include "pxr/base/tf/token.h"
25#include "pxr/base/tf/type.h"
26
27PXR_NAMESPACE_OPEN_SCOPE
28
29class SdfAssetPath;
30
31// -------------------------------------------------------------------------- //
32// PARTICLEFIELD //
33// -------------------------------------------------------------------------- //
34
59{
60public:
64 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
65
70 explicit UsdVolParticleField(const UsdPrim& prim=UsdPrim())
71 : UsdGeomGprim(prim)
72 {
73 }
74
78 explicit UsdVolParticleField(const UsdSchemaBase& schemaObj)
79 : UsdGeomGprim(schemaObj)
80 {
81 }
82
84 USDVOL_API
86
90 USDVOL_API
91 static const TfTokenVector &
92 GetSchemaAttributeNames(bool includeInherited=true);
93
103 USDVOL_API
105 Get(const UsdStagePtr &stage, const SdfPath &path);
106
129 USDVOL_API
131 Define(const UsdStagePtr &stage, const SdfPath &path);
132
133protected:
137 USDVOL_API
139
140private:
141 // needs to invoke _GetStaticTfType.
142 friend class UsdSchemaRegistry;
143 USDVOL_API
144 static const TfType &_GetStaticTfType();
145
146 static bool _IsTypedSchema();
147
148 // override SchemaBase virtuals.
149 USDVOL_API
150 const TfType &_GetTfType() const override;
151
152public:
153 // ===================================================================== //
154 // Feel free to add custom code below this line, it will be preserved by
155 // the code generator.
156 //
157 // Just remember to:
158 // - Close the class declaration with };
159 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
160 // - Close the include guard with #endif
161 // ===================================================================== //
162 // --(BEGIN CUSTOM CODE)--
163};
164
165PXR_NAMESPACE_CLOSE_SCOPE
166
167#endif
Contains an asset path and optional evaluated and resolved paths.
Definition: assetPath.h:79
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:281
TfType represents a dynamic runtime type.
Definition: type.h:48
Base class for all geometric primitives.
Definition: gprim.h:50
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:117
The base class for all schema types in Usd.
Definition: schemaBase.h:39
Singleton registry that provides access to schema type information and the prim definitions for regis...
A ParticleField prim is used as a base to describe different types of concrete ParticleField implemen...
Definition: particleField.h:59
UsdVolParticleField(const UsdSchemaBase &schemaObj)
Construct a UsdVolParticleField on the prim held by schemaObj .
Definition: particleField.h:78
USDVOL_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
virtual USDVOL_API ~UsdVolParticleField()
Destructor.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: particleField.h:64
static USDVOL_API UsdVolParticleField Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdVolParticleField 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...
static USDVOL_API UsdVolParticleField Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
UsdVolParticleField(const UsdPrim &prim=UsdPrim())
Construct a UsdVolParticleField on UsdPrim prim .
Definition: particleField.h:70
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:112
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:440