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 UsdSchemaType schemaType = UsdSchemaType::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 
124  PHYSXSCHEMA_API
126  Apply(const UsdPrim &prim);
127 
128 protected:
132  PHYSXSCHEMA_API
133  UsdSchemaType _GetSchemaType() const override;
134 
135 private:
136  // needs to invoke _GetStaticTfType.
137  friend class UsdSchemaRegistry;
138  PHYSXSCHEMA_API
139  static const TfType &_GetStaticTfType();
140 
141  static bool _IsTypedSchema();
142 
143  // override SchemaBase virtuals.
144  PHYSXSCHEMA_API
145  const TfType &_GetTfType() const override;
146 
147 public:
148  // --------------------------------------------------------------------- //
149  // DIFFUSEPARTICLESENABLED
150  // --------------------------------------------------------------------- //
158  PHYSXSCHEMA_API
159  UsdAttribute GetDiffuseParticlesEnabledAttr() const;
160 
166  PHYSXSCHEMA_API
167  UsdAttribute CreateDiffuseParticlesEnabledAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
168 
169 public:
170  // --------------------------------------------------------------------- //
171  // MAXDIFFUSEPARTICLEMULTIPLIER
172  // --------------------------------------------------------------------- //
184  PHYSXSCHEMA_API
185  UsdAttribute GetMaxDiffuseParticleMultiplierAttr() const;
186 
192  PHYSXSCHEMA_API
193  UsdAttribute CreateMaxDiffuseParticleMultiplierAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
194 
195 public:
196  // --------------------------------------------------------------------- //
197  // THRESHOLD
198  // --------------------------------------------------------------------- //
208  PHYSXSCHEMA_API
209  UsdAttribute GetThresholdAttr() const;
210 
216  PHYSXSCHEMA_API
217  UsdAttribute CreateThresholdAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
218 
219 public:
220  // --------------------------------------------------------------------- //
221  // LIFETIME
222  // --------------------------------------------------------------------- //
232  PHYSXSCHEMA_API
233  UsdAttribute GetLifetimeAttr() const;
234 
240  PHYSXSCHEMA_API
241  UsdAttribute CreateLifetimeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
242 
243 public:
244  // --------------------------------------------------------------------- //
245  // AIRDRAG
246  // --------------------------------------------------------------------- //
256  PHYSXSCHEMA_API
257  UsdAttribute GetAirDragAttr() const;
258 
264  PHYSXSCHEMA_API
265  UsdAttribute CreateAirDragAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
266 
267 public:
268  // --------------------------------------------------------------------- //
269  // BUBBLEDRAG
270  // --------------------------------------------------------------------- //
280  PHYSXSCHEMA_API
281  UsdAttribute GetBubbleDragAttr() const;
282 
288  PHYSXSCHEMA_API
289  UsdAttribute CreateBubbleDragAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
290 
291 public:
292  // --------------------------------------------------------------------- //
293  // BUOYANCY
294  // --------------------------------------------------------------------- //
304  PHYSXSCHEMA_API
305  UsdAttribute GetBuoyancyAttr() const;
306 
312  PHYSXSCHEMA_API
313  UsdAttribute CreateBuoyancyAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
314 
315 public:
316  // --------------------------------------------------------------------- //
317  // KINETICENERGYWEIGHT
318  // --------------------------------------------------------------------- //
328  PHYSXSCHEMA_API
329  UsdAttribute GetKineticEnergyWeightAttr() const;
330 
336  PHYSXSCHEMA_API
337  UsdAttribute CreateKineticEnergyWeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
338 
339 public:
340  // --------------------------------------------------------------------- //
341  // PRESSUREWEIGHT
342  // --------------------------------------------------------------------- //
352  PHYSXSCHEMA_API
353  UsdAttribute GetPressureWeightAttr() const;
354 
360  PHYSXSCHEMA_API
361  UsdAttribute CreatePressureWeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
362 
363 public:
364  // --------------------------------------------------------------------- //
365  // DIVERGENCEWEIGHT
366  // --------------------------------------------------------------------- //
376  PHYSXSCHEMA_API
377  UsdAttribute GetDivergenceWeightAttr() const;
378 
384  PHYSXSCHEMA_API
385  UsdAttribute CreateDivergenceWeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
386 
387 public:
388  // --------------------------------------------------------------------- //
389  // COLLISIONDECAY
390  // --------------------------------------------------------------------- //
400  PHYSXSCHEMA_API
401  UsdAttribute GetCollisionDecayAttr() const;
402 
408  PHYSXSCHEMA_API
409  UsdAttribute CreateCollisionDecayAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
410 
411 public:
412  // --------------------------------------------------------------------- //
413  // USEACCURATEVELOCITY
414  // --------------------------------------------------------------------- //
422  PHYSXSCHEMA_API
423  UsdAttribute GetUseAccurateVelocityAttr() const;
424 
430  PHYSXSCHEMA_API
431  UsdAttribute CreateUseAccurateVelocityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
432 
433 public:
434  // ===================================================================== //
435  // Feel free to add custom code below this line, it will be preserved by
436  // the code generator.
437  //
438  // Just remember to:
439  // - Close the class declaration with };
440  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
441  // - Close the include guard with #endif
442  // ===================================================================== //
443  // --(BEGIN CUSTOM CODE)--
444 };
445 
446 PXR_NAMESPACE_CLOSE_SCOPE
447 
448 #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 .
PHYSXSCHEMA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
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...
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...
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
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 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.