Loading...
Searching...
No Matches
particleFieldKernelGaussianEllipsoidAPI.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_PARTICLEFIELDKERNELGAUSSIANELLIPSOIDAPI_H
8#define USDVOL_GENERATED_PARTICLEFIELDKERNELGAUSSIANELLIPSOIDAPI_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
19
20
21#include "pxr/base/vt/value.h"
22
23#include "pxr/base/gf/vec3d.h"
24#include "pxr/base/gf/vec3f.h"
26
27#include "pxr/base/tf/token.h"
28#include "pxr/base/tf/type.h"
29
30PXR_NAMESPACE_OPEN_SCOPE
31
32class SdfAssetPath;
33
34// -------------------------------------------------------------------------- //
35// PARTICLEFIELDKERNELGAUSSIANELLIPSOIDAPI //
36// -------------------------------------------------------------------------- //
37
53{
54public:
58 static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
59
65 : UsdAPISchemaBase(prim)
66 {
67 }
68
73 : UsdAPISchemaBase(schemaObj)
74 {
75 }
76
78 USDVOL_API
80
84 USDVOL_API
85 static const TfTokenVector &
86 GetSchemaAttributeNames(bool includeInherited=true);
87
97 USDVOL_API
99 Get(const UsdStagePtr &stage, const SdfPath &path);
100
101
118 USDVOL_API
119 static bool
120 CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
121
137 USDVOL_API
139 Apply(const UsdPrim &prim);
140
141protected:
145 USDVOL_API
147
148private:
149 // needs to invoke _GetStaticTfType.
150 friend class UsdSchemaRegistry;
151 USDVOL_API
152 static const TfType &_GetStaticTfType();
153
154 static bool _IsTypedSchema();
155
156 // override SchemaBase virtuals.
157 USDVOL_API
158 const TfType &_GetTfType() const override;
159
160public:
166
169 USDVOL_API
171
173public:
174 // ===================================================================== //
175 // Feel free to add custom code below this line, it will be preserved by
176 // the code generator.
177 //
178 // Just remember to:
179 // - Close the class declaration with };
180 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
181 // - Close the include guard with #endif
182 // ===================================================================== //
183 // --(BEGIN CUSTOM CODE)--
184};
185
186PXR_NAMESPACE_CLOSE_SCOPE
187
188#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
The base class for all API schemas.
Definition: apiSchemaBase.h:95
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...
Defines a base-class type applied schema that all applied schema that provide a ParticleField kernel ...
Defines the gaussian ellipsoid kernel for a given ParticleField.
USDVOL_API UsdVolParticleFieldKernelBaseAPI ParticleFieldKernelBaseAPI() const
Constructs and returns a UsdVolParticleFieldKernelBaseAPI object.
virtual USDVOL_API ~UsdVolParticleFieldKernelGaussianEllipsoidAPI()
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.
static USDVOL_API UsdVolParticleFieldKernelGaussianEllipsoidAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
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 UsdVolParticleFieldKernelGaussianEllipsoidAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdVolParticleFieldKernelGaussianEllipsoidAPI holding the prim adhering to this schema at pa...
static USDVOL_API bool CanApply(const UsdPrim &prim, std::string *whyNot=nullptr)
Returns true if this single-apply API schema can be applied to the given prim.
UsdVolParticleFieldKernelGaussianEllipsoidAPI(const UsdSchemaBase &schemaObj)
Construct a UsdVolParticleFieldKernelGaussianEllipsoidAPI on the prim held by schemaObj .
UsdVolParticleFieldKernelGaussianEllipsoidAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdVolParticleFieldKernelGaussianEllipsoidAPI on UsdPrim prim .
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