All Classes Files Functions Variables Pages
physxParticleAPI.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_PHYSXPARTICLEAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXPARTICLEAPI_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 // PHYSXPARTICLEAPI //
51 // -------------------------------------------------------------------------- //
52 
58 class PhysxSchemaPhysxParticleAPI : public UsdAPISchemaBase
59 {
60 public:
64  static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
65 
70  explicit PhysxSchemaPhysxParticleAPI(const UsdPrim& prim=UsdPrim())
71  : UsdAPISchemaBase(prim)
72  {
73  }
74 
78  explicit PhysxSchemaPhysxParticleAPI(const UsdSchemaBase& schemaObj)
79  : UsdAPISchemaBase(schemaObj)
80  {
81  }
82 
84  PHYSXSCHEMA_API
86 
90  PHYSXSCHEMA_API
91  static const TfTokenVector &
92  GetSchemaAttributeNames(bool includeInherited=true);
93 
103  PHYSXSCHEMA_API
105  Get(const UsdStagePtr &stage, const SdfPath &path);
106 
107 
124  PHYSXSCHEMA_API
125  static bool
126  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
127 
143  PHYSXSCHEMA_API
145  Apply(const UsdPrim &prim);
146 
147 protected:
151  PHYSXSCHEMA_API
152  UsdSchemaKind _GetSchemaKind() const override;
153 
154 private:
155  // needs to invoke _GetStaticTfType.
156  friend class UsdSchemaRegistry;
157  PHYSXSCHEMA_API
158  static const TfType &_GetStaticTfType();
159 
160  static bool _IsTypedSchema();
161 
162  // override SchemaBase virtuals.
163  PHYSXSCHEMA_API
164  const TfType &_GetTfType() const override;
165 
166 public:
167  // --------------------------------------------------------------------- //
168  // PARTICLEENABLED
169  // --------------------------------------------------------------------- //
177  PHYSXSCHEMA_API
178  UsdAttribute GetParticleEnabledAttr() const;
179 
185  PHYSXSCHEMA_API
186  UsdAttribute CreateParticleEnabledAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
187 
188 public:
189  // --------------------------------------------------------------------- //
190  // SELFCOLLISION
191  // --------------------------------------------------------------------- //
199  PHYSXSCHEMA_API
200  UsdAttribute GetSelfCollisionAttr() const;
201 
207  PHYSXSCHEMA_API
208  UsdAttribute CreateSelfCollisionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
209 
210 public:
211  // --------------------------------------------------------------------- //
212  // PARTICLEGROUP
213  // --------------------------------------------------------------------- //
223  PHYSXSCHEMA_API
224  UsdAttribute GetParticleGroupAttr() const;
225 
231  PHYSXSCHEMA_API
232  UsdAttribute CreateParticleGroupAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
233 
234 public:
235  // --------------------------------------------------------------------- //
236  // PARTICLESYSTEM
237  // --------------------------------------------------------------------- //
240  PHYSXSCHEMA_API
241  UsdRelationship GetParticleSystemRel() const;
242 
245  PHYSXSCHEMA_API
246  UsdRelationship CreateParticleSystemRel() const;
247 
248 public:
249  // ===================================================================== //
250  // Feel free to add custom code below this line, it will be preserved by
251  // the code generator.
252  //
253  // Just remember to:
254  // - Close the class declaration with };
255  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
256  // - Close the include guard with #endif
257  // ===================================================================== //
258  // --(BEGIN CUSTOM CODE)--
259 };
260 
261 PXR_NAMESPACE_CLOSE_SCOPE
262 
263 #endif
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
PHYSXSCHEMA_API UsdRelationship CreateParticleSystemRel() const
See GetParticleSystemRel(), 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 GetParticleEnabledAttr() const
Enable or disable the particle object.
WARNING: This is a draft API; the design is not fixed and may change in the future.
PHYSXSCHEMA_API UsdAttribute GetSelfCollisionAttr() const
Enables self-collision of the particles or of the particle object.
PHYSXSCHEMA_API UsdAttribute CreateParticleEnabledAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetParticleEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateSelfCollisionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSelfCollisionAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
static PHYSXSCHEMA_API PhysxSchemaPhysxParticleAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxParticleAPI()
Destructor.
PHYSXSCHEMA_API UsdAttribute GetParticleGroupAttr() const
Group Id of the particles.
PhysxSchemaPhysxParticleAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxParticleAPI on UsdPrim prim .
PHYSXSCHEMA_API UsdAttribute CreateParticleGroupAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetParticleGroupAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
static PHYSXSCHEMA_API PhysxSchemaPhysxParticleAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxParticleAPI holding the prim adhering to this schema at path on stage...
PHYSXSCHEMA_API UsdRelationship GetParticleSystemRel() const
Single particle system that the particle-based object belongs to.
PhysxSchemaPhysxParticleAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxParticleAPI on the prim held by schemaObj .
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.