All Classes Files Functions Variables Pages
physxDiffuseParticlesAPI.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 PHYSXSCHEMA_GENERATED_PHYSXDIFFUSEPARTICLESAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXDIFFUSEPARTICLESAPI_H
26 
28 
29 #include "pxr/pxr.h"
30 #include ".//api.h"
31 #include "pxr/usd/usd/apiSchemaBase.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include ".//tokens.h"
35 
36 #include "pxr/base/vt/value.h"
37 
38 #include "pxr/base/gf/vec3d.h"
39 #include "pxr/base/gf/vec3f.h"
40 #include "pxr/base/gf/matrix4d.h"
41 
42 #include "pxr/base/tf/token.h"
43 #include "pxr/base/tf/type.h"
44 
45 PXR_NAMESPACE_OPEN_SCOPE
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // PHYSXDIFFUSEPARTICLESAPI //
51 // -------------------------------------------------------------------------- //
52 
60 class PhysxSchemaPhysxDiffuseParticlesAPI : public UsdAPISchemaBase
61 {
62 public:
66  static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
67 
72  explicit PhysxSchemaPhysxDiffuseParticlesAPI(const UsdPrim& prim=UsdPrim())
73  : UsdAPISchemaBase(prim)
74  {
75  }
76 
80  explicit PhysxSchemaPhysxDiffuseParticlesAPI(const UsdSchemaBase& schemaObj)
81  : UsdAPISchemaBase(schemaObj)
82  {
83  }
84 
86  PHYSXSCHEMA_API
88 
92  PHYSXSCHEMA_API
93  static const TfTokenVector &
94  GetSchemaAttributeNames(bool includeInherited=true);
95 
105  PHYSXSCHEMA_API
107  Get(const UsdStagePtr &stage, const SdfPath &path);
108 
109 
126  PHYSXSCHEMA_API
127  static bool
128  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
129 
145  PHYSXSCHEMA_API
147  Apply(const UsdPrim &prim);
148 
149 protected:
153  PHYSXSCHEMA_API
154  UsdSchemaKind _GetSchemaKind() const override;
155 
156 private:
157  // needs to invoke _GetStaticTfType.
158  friend class UsdSchemaRegistry;
159  PHYSXSCHEMA_API
160  static const TfType &_GetStaticTfType();
161 
162  static bool _IsTypedSchema();
163 
164  // override SchemaBase virtuals.
165  PHYSXSCHEMA_API
166  const TfType &_GetTfType() const override;
167 
168 public:
169  // --------------------------------------------------------------------- //
170  // DIFFUSEPARTICLESENABLED
171  // --------------------------------------------------------------------- //
179  PHYSXSCHEMA_API
180  UsdAttribute GetDiffuseParticlesEnabledAttr() const;
181 
187  PHYSXSCHEMA_API
188  UsdAttribute CreateDiffuseParticlesEnabledAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
189 
190 public:
191  // --------------------------------------------------------------------- //
192  // MAXDIFFUSEPARTICLEMULTIPLIER
193  // --------------------------------------------------------------------- //
205  PHYSXSCHEMA_API
206  UsdAttribute GetMaxDiffuseParticleMultiplierAttr() const;
207 
213  PHYSXSCHEMA_API
214  UsdAttribute CreateMaxDiffuseParticleMultiplierAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
215 
216 public:
217  // --------------------------------------------------------------------- //
218  // THRESHOLD
219  // --------------------------------------------------------------------- //
229  PHYSXSCHEMA_API
230  UsdAttribute GetThresholdAttr() const;
231 
237  PHYSXSCHEMA_API
238  UsdAttribute CreateThresholdAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
239 
240 public:
241  // --------------------------------------------------------------------- //
242  // LIFETIME
243  // --------------------------------------------------------------------- //
253  PHYSXSCHEMA_API
254  UsdAttribute GetLifetimeAttr() const;
255 
261  PHYSXSCHEMA_API
262  UsdAttribute CreateLifetimeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
263 
264 public:
265  // --------------------------------------------------------------------- //
266  // AIRDRAG
267  // --------------------------------------------------------------------- //
277  PHYSXSCHEMA_API
278  UsdAttribute GetAirDragAttr() const;
279 
285  PHYSXSCHEMA_API
286  UsdAttribute CreateAirDragAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
287 
288 public:
289  // --------------------------------------------------------------------- //
290  // BUBBLEDRAG
291  // --------------------------------------------------------------------- //
301  PHYSXSCHEMA_API
302  UsdAttribute GetBubbleDragAttr() const;
303 
309  PHYSXSCHEMA_API
310  UsdAttribute CreateBubbleDragAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
311 
312 public:
313  // --------------------------------------------------------------------- //
314  // BUOYANCY
315  // --------------------------------------------------------------------- //
325  PHYSXSCHEMA_API
326  UsdAttribute GetBuoyancyAttr() const;
327 
333  PHYSXSCHEMA_API
334  UsdAttribute CreateBuoyancyAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
335 
336 public:
337  // --------------------------------------------------------------------- //
338  // KINETICENERGYWEIGHT
339  // --------------------------------------------------------------------- //
349  PHYSXSCHEMA_API
350  UsdAttribute GetKineticEnergyWeightAttr() const;
351 
357  PHYSXSCHEMA_API
358  UsdAttribute CreateKineticEnergyWeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
359 
360 public:
361  // --------------------------------------------------------------------- //
362  // PRESSUREWEIGHT
363  // --------------------------------------------------------------------- //
373  PHYSXSCHEMA_API
374  UsdAttribute GetPressureWeightAttr() const;
375 
381  PHYSXSCHEMA_API
382  UsdAttribute CreatePressureWeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
383 
384 public:
385  // --------------------------------------------------------------------- //
386  // DIVERGENCEWEIGHT
387  // --------------------------------------------------------------------- //
397  PHYSXSCHEMA_API
398  UsdAttribute GetDivergenceWeightAttr() const;
399 
405  PHYSXSCHEMA_API
406  UsdAttribute CreateDivergenceWeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
407 
408 public:
409  // --------------------------------------------------------------------- //
410  // COLLISIONDECAY
411  // --------------------------------------------------------------------- //
421  PHYSXSCHEMA_API
422  UsdAttribute GetCollisionDecayAttr() const;
423 
429  PHYSXSCHEMA_API
430  UsdAttribute CreateCollisionDecayAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
431 
432 public:
433  // --------------------------------------------------------------------- //
434  // USEACCURATEVELOCITY
435  // --------------------------------------------------------------------- //
443  PHYSXSCHEMA_API
444  UsdAttribute GetUseAccurateVelocityAttr() const;
445 
451  PHYSXSCHEMA_API
452  UsdAttribute CreateUseAccurateVelocityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
453 
454 public:
455  // ===================================================================== //
456  // Feel free to add custom code below this line, it will be preserved by
457  // the code generator.
458  //
459  // Just remember to:
460  // - Close the class declaration with };
461  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
462  // - Close the include guard with #endif
463  // ===================================================================== //
464  // --(BEGIN CUSTOM CODE)--
465 };
466 
467 PXR_NAMESPACE_CLOSE_SCOPE
468 
469 #endif
PHYSXSCHEMA_API UsdAttribute CreateMaxDiffuseParticleMultiplierAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMaxDiffuseParticleMultiplierAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs...
PHYSXSCHEMA_API UsdAttribute GetBubbleDragAttr() const
Fluid drag force factor for bubble particles.
PHYSXSCHEMA_API UsdAttribute CreateDiffuseParticlesEnabledAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDiffuseParticlesEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Crea...
PhysxSchemaPhysxDiffuseParticlesAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxDiffuseParticlesAPI on the prim held by schemaObj .
static PHYSXSCHEMA_API PhysxSchemaPhysxDiffuseParticlesAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxDiffuseParticlesAPI holding the prim adhering to this schema at path on stag...
static PHYSXSCHEMA_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.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
PHYSXSCHEMA_API UsdAttribute GetCollisionDecayAttr() const
Decay factor of diffuse particles' lifetime after they collide with shapes.
PHYSXSCHEMA_API UsdAttribute GetBuoyancyAttr() const
Buoyancy force factor for bubble particles.
PHYSXSCHEMA_API UsdAttribute GetKineticEnergyWeightAttr() const
Contribution from kinetic energy when deciding diffuse particle creation.
static PHYSXSCHEMA_API PhysxSchemaPhysxDiffuseParticlesAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PHYSXSCHEMA_API UsdAttribute CreateDivergenceWeightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDivergenceWeightAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateKineticEnergyWeightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetKineticEnergyWeightAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateCollisionDecayAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetCollisionDecayAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateThresholdAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetThresholdAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetThresholdAttr() const
Kinetic energy threshold a particle must reach to spawn a diffuse particle.
PHYSXSCHEMA_API UsdAttribute GetDiffuseParticlesEnabledAttr() const
Enable or disable the creation of diffuse particles.
PhysxSchemaPhysxDiffuseParticlesAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxDiffuseParticlesAPI on UsdPrim prim .
PHYSXSCHEMA_API UsdAttribute CreateBubbleDragAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetBubbleDragAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetAirDragAttr() const
Air drag force factor for spray particles.
PHYSXSCHEMA_API UsdAttribute CreateBuoyancyAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetBuoyancyAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetPressureWeightAttr() const
Contribution from pressure when deciding diffuse particle creation.
WARNING: This is a draft API; the design is not fixed and may change in the future.
PHYSXSCHEMA_API UsdAttribute GetLifetimeAttr() const
Lifetime of a spawned particle before it is removed again.
PHYSXSCHEMA_API UsdAttribute GetMaxDiffuseParticleMultiplierAttr() const
Maximum number of diffuse particles that can be present in the simulation relative to the number of n...
PHYSXSCHEMA_API UsdAttribute CreateUseAccurateVelocityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetUseAccurateVelocityAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetUseAccurateVelocityAttr() const
Enables accurate particle velocity estimation.
PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
PHYSXSCHEMA_API UsdAttribute CreateLifetimeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLifetimeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateAirDragAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAirDragAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.
static PHYSXSCHEMA_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...
PHYSXSCHEMA_API UsdAttribute CreatePressureWeightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPressureWeightAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetDivergenceWeightAttr() const
Contribution from divergence when deciding diffuse particle creation.
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxDiffuseParticlesAPI()
Destructor.