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 UsdSchemaType schemaType = UsdSchemaType::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 
122  PHYSXSCHEMA_API
124  Apply(const UsdPrim &prim);
125 
126 protected:
130  PHYSXSCHEMA_API
131  UsdSchemaType _GetSchemaType() const override;
132 
133 private:
134  // needs to invoke _GetStaticTfType.
135  friend class UsdSchemaRegistry;
136  PHYSXSCHEMA_API
137  static const TfType &_GetStaticTfType();
138 
139  static bool _IsTypedSchema();
140 
141  // override SchemaBase virtuals.
142  PHYSXSCHEMA_API
143  const TfType &_GetTfType() const override;
144 
145 public:
146  // --------------------------------------------------------------------- //
147  // PARTICLEENABLED
148  // --------------------------------------------------------------------- //
156  PHYSXSCHEMA_API
157  UsdAttribute GetParticleEnabledAttr() const;
158 
164  PHYSXSCHEMA_API
165  UsdAttribute CreateParticleEnabledAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
166 
167 public:
168  // --------------------------------------------------------------------- //
169  // SELFCOLLISION
170  // --------------------------------------------------------------------- //
178  PHYSXSCHEMA_API
179  UsdAttribute GetSelfCollisionAttr() const;
180 
186  PHYSXSCHEMA_API
187  UsdAttribute CreateSelfCollisionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
188 
189 public:
190  // --------------------------------------------------------------------- //
191  // PARTICLEGROUP
192  // --------------------------------------------------------------------- //
202  PHYSXSCHEMA_API
203  UsdAttribute GetParticleGroupAttr() const;
204 
210  PHYSXSCHEMA_API
211  UsdAttribute CreateParticleGroupAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
212 
213 public:
214  // --------------------------------------------------------------------- //
215  // PARTICLESYSTEM
216  // --------------------------------------------------------------------- //
219  PHYSXSCHEMA_API
220  UsdRelationship GetParticleSystemRel() const;
221 
224  PHYSXSCHEMA_API
225  UsdRelationship CreateParticleSystemRel() const;
226 
227 public:
228  // ===================================================================== //
229  // Feel free to add custom code below this line, it will be preserved by
230  // the code generator.
231  //
232  // Just remember to:
233  // - Close the class declaration with };
234  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
235  // - Close the include guard with #endif
236  // ===================================================================== //
237  // --(BEGIN CUSTOM CODE)--
238 };
239 
240 PXR_NAMESPACE_CLOSE_SCOPE
241 
242 #endif
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...
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 UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
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 const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.