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 UsdSchemaType schemaType = UsdSchemaType::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 
123  PHYSXSCHEMA_API
125  Apply(const UsdPrim &prim);
126 
127 protected:
131  PHYSXSCHEMA_API
132  UsdSchemaType _GetSchemaType() const override;
133 
134 private:
135  // needs to invoke _GetStaticTfType.
136  friend class UsdSchemaRegistry;
137  PHYSXSCHEMA_API
138  static const TfType &_GetStaticTfType();
139 
140  static bool _IsTypedSchema();
141 
142  // override SchemaBase virtuals.
143  PHYSXSCHEMA_API
144  const TfType &_GetTfType() const override;
145 
146 public:
147  // --------------------------------------------------------------------- //
148  // ISOSURFACEENABLED
149  // --------------------------------------------------------------------- //
157  PHYSXSCHEMA_API
158  UsdAttribute GetIsosurfaceEnabledAttr() const;
159 
165  PHYSXSCHEMA_API
166  UsdAttribute CreateIsosurfaceEnabledAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
167 
168 public:
169  // --------------------------------------------------------------------- //
170  // MAXVERTICES
171  // --------------------------------------------------------------------- //
181  PHYSXSCHEMA_API
182  UsdAttribute GetMaxVerticesAttr() const;
183 
189  PHYSXSCHEMA_API
190  UsdAttribute CreateMaxVerticesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
191 
192 public:
193  // --------------------------------------------------------------------- //
194  // MAXTRIANGLES
195  // --------------------------------------------------------------------- //
205  PHYSXSCHEMA_API
206  UsdAttribute GetMaxTrianglesAttr() const;
207 
213  PHYSXSCHEMA_API
214  UsdAttribute CreateMaxTrianglesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
215 
216 public:
217  // --------------------------------------------------------------------- //
218  // MAXSUBGRIDS
219  // --------------------------------------------------------------------- //
229  PHYSXSCHEMA_API
230  UsdAttribute GetMaxSubgridsAttr() const;
231 
237  PHYSXSCHEMA_API
238  UsdAttribute CreateMaxSubgridsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
239 
240 public:
241  // --------------------------------------------------------------------- //
242  // GRIDSPACING
243  // --------------------------------------------------------------------- //
253  PHYSXSCHEMA_API
254  UsdAttribute GetGridSpacingAttr() const;
255 
261  PHYSXSCHEMA_API
262  UsdAttribute CreateGridSpacingAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
263 
264 public:
265  // --------------------------------------------------------------------- //
266  // SURFACEDISTANCE
267  // --------------------------------------------------------------------- //
277  PHYSXSCHEMA_API
278  UsdAttribute GetSurfaceDistanceAttr() const;
279 
285  PHYSXSCHEMA_API
286  UsdAttribute CreateSurfaceDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
287 
288 public:
289  // --------------------------------------------------------------------- //
290  // GRIDFILTERINGPASSES
291  // --------------------------------------------------------------------- //
299  PHYSXSCHEMA_API
300  UsdAttribute GetGridFilteringPassesAttr() const;
301 
307  PHYSXSCHEMA_API
308  UsdAttribute CreateGridFilteringPassesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
309 
310 public:
311  // --------------------------------------------------------------------- //
312  // GRIDSMOOTHINGRADIUS
313  // --------------------------------------------------------------------- //
323  PHYSXSCHEMA_API
324  UsdAttribute GetGridSmoothingRadiusAttr() const;
325 
331  PHYSXSCHEMA_API
332  UsdAttribute CreateGridSmoothingRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
333 
334 public:
335  // --------------------------------------------------------------------- //
336  // NUMMESHSMOOTHINGPASSES
337  // --------------------------------------------------------------------- //
346  PHYSXSCHEMA_API
347  UsdAttribute GetNumMeshSmoothingPassesAttr() const;
348 
354  PHYSXSCHEMA_API
355  UsdAttribute CreateNumMeshSmoothingPassesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
356 
357 public:
358  // --------------------------------------------------------------------- //
359  // NUMMESHNORMALSMOOTHINGPASSES
360  // --------------------------------------------------------------------- //
369  PHYSXSCHEMA_API
370  UsdAttribute GetNumMeshNormalSmoothingPassesAttr() const;
371 
377  PHYSXSCHEMA_API
378  UsdAttribute CreateNumMeshNormalSmoothingPassesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
379 
380 public:
381  // ===================================================================== //
382  // Feel free to add custom code below this line, it will be preserved by
383  // the code generator.
384  //
385  // Just remember to:
386  // - Close the class declaration with };
387  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
388  // - Close the include guard with #endif
389  // ===================================================================== //
390  // --(BEGIN CUSTOM CODE)--
391 };
392 
393 PXR_NAMESPACE_CLOSE_SCOPE
394 
395 #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.
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.
PHYSXSCHEMA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
PhysxSchemaPhysxParticleIsosurfaceAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxParticleIsosurfaceAPI on UsdPrim prim .
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 const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
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...