All Classes Files Functions Variables Pages
physxIsosurfaceAPI.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_PHYSXISOSURFACEAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXISOSURFACEAPI_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 // PHYSXISOSURFACEAPI //
51 // -------------------------------------------------------------------------- //
52 
58 class PhysxSchemaPhysxIsosurfaceAPI : public UsdAPISchemaBase
59 {
60 public:
64  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
65 
70  explicit PhysxSchemaPhysxIsosurfaceAPI(const UsdPrim& prim=UsdPrim())
71  : UsdAPISchemaBase(prim)
72  {
73  }
74 
78  explicit PhysxSchemaPhysxIsosurfaceAPI(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  // ISOSURFACEENABLED
148  // --------------------------------------------------------------------- //
156  PHYSXSCHEMA_API
157  UsdAttribute GetIsoSurfaceEnabledAttr() const;
158 
164  PHYSXSCHEMA_API
165  UsdAttribute CreateIsoSurfaceEnabledAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
166 
167 public:
168  // --------------------------------------------------------------------- //
169  // MAXVERTICES
170  // --------------------------------------------------------------------- //
179  PHYSXSCHEMA_API
180  UsdAttribute GetMaxVerticesAttr() const;
181 
187  PHYSXSCHEMA_API
188  UsdAttribute CreateMaxVerticesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
189 
190 public:
191  // --------------------------------------------------------------------- //
192  // MAXTRIANGLES
193  // --------------------------------------------------------------------- //
202  PHYSXSCHEMA_API
203  UsdAttribute GetMaxTrianglesAttr() const;
204 
210  PHYSXSCHEMA_API
211  UsdAttribute CreateMaxTrianglesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
212 
213 public:
214  // --------------------------------------------------------------------- //
215  // MAXSUBGRIDS
216  // --------------------------------------------------------------------- //
225  PHYSXSCHEMA_API
226  UsdAttribute GetMaxSubgridsAttr() const;
227 
233  PHYSXSCHEMA_API
234  UsdAttribute CreateMaxSubgridsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
235 
236 public:
237  // --------------------------------------------------------------------- //
238  // GRIDSPACING
239  // --------------------------------------------------------------------- //
249  PHYSXSCHEMA_API
250  UsdAttribute GetGridSpacingAttr() const;
251 
257  PHYSXSCHEMA_API
258  UsdAttribute CreateGridSpacingAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
259 
260 public:
261  // --------------------------------------------------------------------- //
262  // KERNELRADIUS
263  // --------------------------------------------------------------------- //
273  PHYSXSCHEMA_API
274  UsdAttribute GetKernelRadiusAttr() const;
275 
281  PHYSXSCHEMA_API
282  UsdAttribute CreateKernelRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
283 
284 public:
285  // --------------------------------------------------------------------- //
286  // ISOSURFACELEVEL
287  // --------------------------------------------------------------------- //
298  PHYSXSCHEMA_API
299  UsdAttribute GetIsosurfaceLevelAttr() const;
300 
306  PHYSXSCHEMA_API
307  UsdAttribute CreateIsosurfaceLevelAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
308 
309 public:
310  // --------------------------------------------------------------------- //
311  // GRIDFILTERINGPASSES
312  // --------------------------------------------------------------------- //
321  PHYSXSCHEMA_API
322  UsdAttribute GetGridFilteringPassesAttr() const;
323 
329  PHYSXSCHEMA_API
330  UsdAttribute CreateGridFilteringPassesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
331 
332 public:
333  // --------------------------------------------------------------------- //
334  // GRIDSMOOTHINGRADIUSRELATIVETOCELLSIZE
335  // --------------------------------------------------------------------- //
345  PHYSXSCHEMA_API
347 
353  PHYSXSCHEMA_API
354  UsdAttribute CreateGridSmoothingRadiusRelativeToCellSizeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
355 
356 public:
357  // --------------------------------------------------------------------- //
358  // ENABLEANISOTROPY
359  // --------------------------------------------------------------------- //
367  PHYSXSCHEMA_API
368  UsdAttribute GetEnableAnisotropyAttr() const;
369 
375  PHYSXSCHEMA_API
376  UsdAttribute CreateEnableAnisotropyAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
377 
378 public:
379  // --------------------------------------------------------------------- //
380  // ANISOTROPYMIN
381  // --------------------------------------------------------------------- //
391  PHYSXSCHEMA_API
392  UsdAttribute GetAnisotropyMinAttr() const;
393 
399  PHYSXSCHEMA_API
400  UsdAttribute CreateAnisotropyMinAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
401 
402 public:
403  // --------------------------------------------------------------------- //
404  // ANISOTROPYMAX
405  // --------------------------------------------------------------------- //
415  PHYSXSCHEMA_API
416  UsdAttribute GetAnisotropyMaxAttr() const;
417 
423  PHYSXSCHEMA_API
424  UsdAttribute CreateAnisotropyMaxAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
425 
426 public:
427  // --------------------------------------------------------------------- //
428  // ANISOTROPYRADIUS
429  // --------------------------------------------------------------------- //
439  PHYSXSCHEMA_API
440  UsdAttribute GetAnisotropyRadiusAttr() const;
441 
447  PHYSXSCHEMA_API
448  UsdAttribute CreateAnisotropyRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
449 
450 public:
451  // --------------------------------------------------------------------- //
452  // NUMMESHSMOOTHINGPASSES
453  // --------------------------------------------------------------------- //
463  PHYSXSCHEMA_API
464  UsdAttribute GetNumMeshSmoothingPassesAttr() const;
465 
471  PHYSXSCHEMA_API
472  UsdAttribute CreateNumMeshSmoothingPassesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
473 
474 public:
475  // ===================================================================== //
476  // Feel free to add custom code below this line, it will be preserved by
477  // the code generator.
478  //
479  // Just remember to:
480  // - Close the class declaration with };
481  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
482  // - Close the include guard with #endif
483  // ===================================================================== //
484  // --(BEGIN CUSTOM CODE)--
485 };
486 
487 PXR_NAMESPACE_CLOSE_SCOPE
488 
489 #endif
PHYSXSCHEMA_API UsdAttribute GetGridSmoothingRadiusRelativeToCellSizeAttr() const
The radius used during the smoothing process on the grid.
PHYSXSCHEMA_API UsdAttribute CreateAnisotropyMaxAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAnisotropyMaxAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
Applied to a PhysxParticleSystem.
PHYSXSCHEMA_API UsdAttribute GetNumMeshSmoothingPassesAttr() const
Number of smoothing passes applied to the generated isosurface triangle mesh.
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
PHYSXSCHEMA_API UsdAttribute GetEnableAnisotropyAttr() const
Enables usage of anisotropy information during isosurface extraction process.
PHYSXSCHEMA_API UsdAttribute CreateEnableAnisotropyAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetEnableAnisotropyAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
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 GetMaxSubgridsAttr() const
Maximum number of blocks the sparse grid structure can contain.
PHYSXSCHEMA_API UsdAttribute GetAnisotropyRadiusAttr() const
Radius that defines the size of the neighborhood used to determine the anisotropy information...
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 CreateAnisotropyRadiusAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAnisotropyRadiusAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
static PHYSXSCHEMA_API PhysxSchemaPhysxIsosurfaceAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxIsosurfaceAPI holding the prim adhering to this schema at path on stage...
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 CreateGridSmoothingRadiusRelativeToCellSizeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetGridSmoothingRadiusRelativeToCellSizeAttr(), and also Usd_Create_Or_Get_Property for when to u...
PHYSXSCHEMA_API UsdAttribute GetAnisotropyMinAttr() const
The minimal scale anisotropy can apply to a particle radius.
PHYSXSCHEMA_API UsdAttribute GetAnisotropyMaxAttr() const
The maximal scale anisotropy can apply to a particle radius.
PHYSXSCHEMA_API UsdAttribute GetGridSpacingAttr() const
Cell Size of the grid used for isosurface extraction.
PhysxSchemaPhysxIsosurfaceAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxIsosurfaceAPI on the prim held by schemaObj .
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 GetKernelRadiusAttr() const
Radius of the kernel used to transfer the density to the isosurface grid.
PHYSXSCHEMA_API UsdAttribute GetIsoSurfaceEnabledAttr() const
Enable or disable the creation of an isosurface.
PHYSXSCHEMA_API UsdAttribute GetGridFilteringPassesAttr() const
Grid filtering sequence, defined as capital letters "S":Smooth, "G":Grow, "R":Reduce.
PHYSXSCHEMA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
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...
PHYSXSCHEMA_API UsdAttribute GetMaxTrianglesAttr() const
Maximum number of triangles the extracted isosurface can have.
PHYSXSCHEMA_API UsdAttribute CreateIsosurfaceLevelAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetIsosurfaceLevelAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetIsosurfaceLevelAttr() const
The level at which the isosurface is located.
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.
PHYSXSCHEMA_API UsdAttribute CreateKernelRadiusAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetKernelRadiusAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
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...
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxIsosurfaceAPI()
Destructor.
static PHYSXSCHEMA_API PhysxSchemaPhysxIsosurfaceAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PhysxSchemaPhysxIsosurfaceAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxIsosurfaceAPI on UsdPrim prim .
PHYSXSCHEMA_API UsdAttribute CreateAnisotropyMinAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAnisotropyMinAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
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...