Loading...
Searching...
No Matches
particleFieldScaleAttributeAPI.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_PARTICLEFIELDSCALEATTRIBUTEAPI_H
8#define USDVOL_GENERATED_PARTICLEFIELDSCALEATTRIBUTEAPI_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"
18
19#include "pxr/base/vt/value.h"
20
21#include "pxr/base/gf/vec3d.h"
22#include "pxr/base/gf/vec3f.h"
24
25#include "pxr/base/tf/token.h"
26#include "pxr/base/tf/type.h"
27
28PXR_NAMESPACE_OPEN_SCOPE
29
30class SdfAssetPath;
31
32// -------------------------------------------------------------------------- //
33// PARTICLEFIELDSCALEATTRIBUTEAPI //
34// -------------------------------------------------------------------------- //
35
59{
60public:
64 static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
65
71 : UsdAPISchemaBase(prim)
72 {
73 }
74
79 : UsdAPISchemaBase(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
107
124 USDVOL_API
125 static bool
126 CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
127
143 USDVOL_API
145 Apply(const UsdPrim &prim);
146
147protected:
151 USDVOL_API
153
154private:
155 // needs to invoke _GetStaticTfType.
156 friend class UsdSchemaRegistry;
157 USDVOL_API
158 static const TfType &_GetStaticTfType();
159
160 static bool _IsTypedSchema();
161
162 // override SchemaBase virtuals.
163 USDVOL_API
164 const TfType &_GetTfType() const override;
165
166public:
167 // --------------------------------------------------------------------- //
168 // SCALES
169 // --------------------------------------------------------------------- //
178 USDVOL_API
180
186 USDVOL_API
187 UsdAttribute CreateScalesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
188
189public:
190 // --------------------------------------------------------------------- //
191 // SCALESH
192 // --------------------------------------------------------------------- //
202 USDVOL_API
204
210 USDVOL_API
211 UsdAttribute CreateScaleshAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
212
213public:
214 // ===================================================================== //
215 // Feel free to add custom code below this line, it will be preserved by
216 // the code generator.
217 //
218 // Just remember to:
219 // - Close the class declaration with };
220 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
221 // - Close the include guard with #endif
222 // ===================================================================== //
223 // --(BEGIN CUSTOM CODE)--
224};
225
226PXR_NAMESPACE_CLOSE_SCOPE
227
228#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
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:183
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 related applied schema that provides a scales attribute to define the linear scale fa...
virtual USDVOL_API ~UsdVolParticleFieldScaleAttributeAPI()
Destructor.
UsdVolParticleFieldScaleAttributeAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdVolParticleFieldScaleAttributeAPI on UsdPrim prim .
USDVOL_API UsdAttribute CreateScalesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetScalesAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
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 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 UsdVolParticleFieldScaleAttributeAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
UsdVolParticleFieldScaleAttributeAPI(const UsdSchemaBase &schemaObj)
Construct a UsdVolParticleFieldScaleAttributeAPI on the prim held by schemaObj .
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.
USDVOL_API UsdAttribute GetScalesAttr() const
Affine linear scale factor applied to the kernel that is instantiated at each particle.
static USDVOL_API UsdVolParticleFieldScaleAttributeAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdVolParticleFieldScaleAttributeAPI holding the prim adhering to this schema at path on sta...
USDVOL_API UsdAttribute GetScaleshAttr() const
Affine linear scale factor applied to the kernel that is instantiated at each particle.
USDVOL_API UsdAttribute CreateScaleshAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetScaleshAttr(), 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:90
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