All Classes Files Functions Variables Pages
physxParticleIsosurfaceAPI.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_PHYSXPARTICLEISOSURFACEAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXPARTICLEISOSURFACEAPI_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 // PHYSXPARTICLEISOSURFACEAPI //
51 // -------------------------------------------------------------------------- //
52 
59 class PhysxSchemaPhysxParticleIsosurfaceAPI : public UsdAPISchemaBase
60 {
61 public:
65  static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
66 
71  explicit PhysxSchemaPhysxParticleIsosurfaceAPI(const UsdPrim& prim=UsdPrim())
72  : UsdAPISchemaBase(prim)
73  {
74  }
75 
79  explicit PhysxSchemaPhysxParticleIsosurfaceAPI(const UsdSchemaBase& schemaObj)
80  : UsdAPISchemaBase(schemaObj)
81  {
82  }
83 
85  PHYSXSCHEMA_API
87 
91  PHYSXSCHEMA_API
92  static const TfTokenVector &
93  GetSchemaAttributeNames(bool includeInherited=true);
94 
104  PHYSXSCHEMA_API
106  Get(const UsdStagePtr &stage, const SdfPath &path);
107 
108 
125  PHYSXSCHEMA_API
126  static bool
127  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
128 
144  PHYSXSCHEMA_API
146  Apply(const UsdPrim &prim);
147 
148 protected:
152  PHYSXSCHEMA_API
153  UsdSchemaKind _GetSchemaKind() const override;
154 
155 private:
156  // needs to invoke _GetStaticTfType.
157  friend class UsdSchemaRegistry;
158  PHYSXSCHEMA_API
159  static const TfType &_GetStaticTfType();
160 
161  static bool _IsTypedSchema();
162 
163  // override SchemaBase virtuals.
164  PHYSXSCHEMA_API
165  const TfType &_GetTfType() const override;
166 
167 public:
168  // --------------------------------------------------------------------- //
169  // ISOSURFACEENABLED
170  // --------------------------------------------------------------------- //
178  PHYSXSCHEMA_API
179  UsdAttribute GetIsosurfaceEnabledAttr() const;
180 
186  PHYSXSCHEMA_API
187  UsdAttribute CreateIsosurfaceEnabledAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
188 
189 public:
190  // --------------------------------------------------------------------- //
191  // MAXVERTICES
192  // --------------------------------------------------------------------- //
202  PHYSXSCHEMA_API
203  UsdAttribute GetMaxVerticesAttr() const;
204 
210  PHYSXSCHEMA_API
211  UsdAttribute CreateMaxVerticesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
212 
213 public:
214  // --------------------------------------------------------------------- //
215  // MAXTRIANGLES
216  // --------------------------------------------------------------------- //
226  PHYSXSCHEMA_API
227  UsdAttribute GetMaxTrianglesAttr() const;
228 
234  PHYSXSCHEMA_API
235  UsdAttribute CreateMaxTrianglesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
236 
237 public:
238  // --------------------------------------------------------------------- //
239  // MAXSUBGRIDS
240  // --------------------------------------------------------------------- //
250  PHYSXSCHEMA_API
251  UsdAttribute GetMaxSubgridsAttr() const;
252 
258  PHYSXSCHEMA_API
259  UsdAttribute CreateMaxSubgridsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
260 
261 public:
262  // --------------------------------------------------------------------- //
263  // GRIDSPACING
264  // --------------------------------------------------------------------- //
274  PHYSXSCHEMA_API
275  UsdAttribute GetGridSpacingAttr() const;
276 
282  PHYSXSCHEMA_API
283  UsdAttribute CreateGridSpacingAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
284 
285 public:
286  // --------------------------------------------------------------------- //
287  // SURFACEDISTANCE
288  // --------------------------------------------------------------------- //
298  PHYSXSCHEMA_API
299  UsdAttribute GetSurfaceDistanceAttr() const;
300 
306  PHYSXSCHEMA_API
307  UsdAttribute CreateSurfaceDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
308 
309 public:
310  // --------------------------------------------------------------------- //
311  // GRIDFILTERINGPASSES
312  // --------------------------------------------------------------------- //
320  PHYSXSCHEMA_API
321  UsdAttribute GetGridFilteringPassesAttr() const;
322 
328  PHYSXSCHEMA_API
329  UsdAttribute CreateGridFilteringPassesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
330 
331 public:
332  // --------------------------------------------------------------------- //
333  // GRIDSMOOTHINGRADIUS
334  // --------------------------------------------------------------------- //
344  PHYSXSCHEMA_API
345  UsdAttribute GetGridSmoothingRadiusAttr() const;
346 
352  PHYSXSCHEMA_API
353  UsdAttribute CreateGridSmoothingRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
354 
355 public:
356  // --------------------------------------------------------------------- //
357  // NUMMESHSMOOTHINGPASSES
358  // --------------------------------------------------------------------- //
367  PHYSXSCHEMA_API
368  UsdAttribute GetNumMeshSmoothingPassesAttr() const;
369 
375  PHYSXSCHEMA_API
376  UsdAttribute CreateNumMeshSmoothingPassesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
377 
378 public:
379  // --------------------------------------------------------------------- //
380  // NUMMESHNORMALSMOOTHINGPASSES
381  // --------------------------------------------------------------------- //
390  PHYSXSCHEMA_API
391  UsdAttribute GetNumMeshNormalSmoothingPassesAttr() const;
392 
398  PHYSXSCHEMA_API
399  UsdAttribute CreateNumMeshNormalSmoothingPassesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
400 
401 public:
402  // ===================================================================== //
403  // Feel free to add custom code below this line, it will be preserved by
404  // the code generator.
405  //
406  // Just remember to:
407  // - Close the class declaration with };
408  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
409  // - Close the include guard with #endif
410  // ===================================================================== //
411  // --(BEGIN CUSTOM CODE)--
412 };
413 
414 PXR_NAMESPACE_CLOSE_SCOPE
415 
416 #endif
static PHYSXSCHEMA_API PhysxSchemaPhysxParticleIsosurfaceAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxParticleIsosurfaceAPI holding the prim adhering to this schema at path on st...
PHYSXSCHEMA_API UsdAttribute GetGridFilteringPassesAttr() const
Grid filtering sequence, defined as capital letters "S":Smooth, "G":Grow, "R":Reduce.
PHYSXSCHEMA_API UsdAttribute CreateNumMeshNormalSmoothingPassesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetNumMeshNormalSmoothingPassesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs...
PHYSXSCHEMA_API UsdAttribute CreateIsosurfaceEnabledAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetIsosurfaceEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetIsosurfaceEnabledAttr() const
Enable or disable the creation of an isosurface.
PHYSXSCHEMA_API UsdAttribute CreateMaxSubgridsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMaxSubgridsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetSurfaceDistanceAttr() const
Distance from particle center to isosurface.
PHYSXSCHEMA_API UsdAttribute GetNumMeshNormalSmoothingPassesAttr() const
Number of smoothing passes applied to the normals of the generated isosurface triangle mesh...
PHYSXSCHEMA_API UsdAttribute CreateMaxVerticesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMaxVerticesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
static PHYSXSCHEMA_API PhysxSchemaPhysxParticleIsosurfaceAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
PHYSXSCHEMA_API UsdAttribute CreateMaxTrianglesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMaxTrianglesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateGridFilteringPassesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetGridFilteringPassesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
WARNING: This is a draft API; the design is not fixed and may change in the future.
PHYSXSCHEMA_API UsdAttribute CreateGridSmoothingRadiusAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetGridSmoothingRadiusAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PhysxSchemaPhysxParticleIsosurfaceAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxParticleIsosurfaceAPI on the prim held by schemaObj . ...
PHYSXSCHEMA_API UsdAttribute GetMaxTrianglesAttr() const
Maximum number of triangles the extracted isosurface can have.
PHYSXSCHEMA_API UsdAttribute GetGridSpacingAttr() const
Cell Size of the grid used for isosurface extraction.
PHYSXSCHEMA_API UsdAttribute GetMaxSubgridsAttr() const
Maximum number of blocks the sparse grid structure can contain.
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxParticleIsosurfaceAPI()
Destructor.
PHYSXSCHEMA_API UsdAttribute GetGridSmoothingRadiusAttr() const
The radius used during the smoothing process on the grid.
PHYSXSCHEMA_API UsdAttribute CreateNumMeshSmoothingPassesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetNumMeshSmoothingPassesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Creat...
PHYSXSCHEMA_API UsdAttribute GetNumMeshSmoothingPassesAttr() const
Number of smoothing passes applied to the generated isosurface triangle mesh.
PHYSXSCHEMA_API UsdAttribute CreateGridSpacingAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetGridSpacingAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetMaxVerticesAttr() const
Maximum number of vertices the extracted isosurface can have.
PhysxSchemaPhysxParticleIsosurfaceAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxParticleIsosurfaceAPI on UsdPrim prim .
PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
PHYSXSCHEMA_API UsdAttribute CreateSurfaceDistanceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSurfaceDistanceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
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 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...