All Classes Files Functions Variables Pages
physxHairAPI.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_PHYSXHAIRAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXHAIRAPI_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 // PHYSXHAIRAPI //
51 // -------------------------------------------------------------------------- //
52 
59 class PhysxSchemaPhysxHairAPI : public UsdAPISchemaBase
60 {
61 public:
65  static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
66 
71  explicit PhysxSchemaPhysxHairAPI(const UsdPrim& prim=UsdPrim())
72  : UsdAPISchemaBase(prim)
73  {
74  }
75 
79  explicit PhysxSchemaPhysxHairAPI(const UsdSchemaBase& schemaObj)
80  : UsdAPISchemaBase(schemaObj)
81  {
82  }
83 
85  PHYSXSCHEMA_API
86  virtual ~PhysxSchemaPhysxHairAPI();
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  // EXTERNALCOLLISION
170  // --------------------------------------------------------------------- //
178  PHYSXSCHEMA_API
179  UsdAttribute GetExternalCollisionAttr() const;
180 
186  PHYSXSCHEMA_API
187  UsdAttribute CreateExternalCollisionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
188 
189 public:
190  // --------------------------------------------------------------------- //
191  // TWOSIDEDATTACHMENT
192  // --------------------------------------------------------------------- //
200  PHYSXSCHEMA_API
201  UsdAttribute GetTwosidedAttachmentAttr() const;
202 
208  PHYSXSCHEMA_API
209  UsdAttribute CreateTwosidedAttachmentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
210 
211 public:
212  // --------------------------------------------------------------------- //
213  // SEGMENTLENGTH
214  // --------------------------------------------------------------------- //
226  PHYSXSCHEMA_API
227  UsdAttribute GetSegmentLengthAttr() const;
228 
234  PHYSXSCHEMA_API
235  UsdAttribute CreateSegmentLengthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
236 
237 public:
238  // --------------------------------------------------------------------- //
239  // GLOBALSHAPECOMPLIANCEATROOT
240  // --------------------------------------------------------------------- //
252  PHYSXSCHEMA_API
253  UsdAttribute GetGlobalShapeComplianceAtRootAttr() const;
254 
260  PHYSXSCHEMA_API
261  UsdAttribute CreateGlobalShapeComplianceAtRootAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
262 
263 public:
264  // --------------------------------------------------------------------- //
265  // GLOBALSHAPECOMPLIANCESTRANDATTENUATION
266  // --------------------------------------------------------------------- //
279  PHYSXSCHEMA_API
281 
287  PHYSXSCHEMA_API
288  UsdAttribute CreateGlobalShapeComplianceStrandAttenuationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
289 
290 public:
291  // --------------------------------------------------------------------- //
292  // INTERHAIRREPULSION
293  // --------------------------------------------------------------------- //
305  PHYSXSCHEMA_API
306  UsdAttribute GetInterHairRepulsionAttr() const;
307 
313  PHYSXSCHEMA_API
314  UsdAttribute CreateInterHairRepulsionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
315 
316 public:
317  // --------------------------------------------------------------------- //
318  // VELSMOOTHING
319  // --------------------------------------------------------------------- //
331  PHYSXSCHEMA_API
332  UsdAttribute GetVelSmoothingAttr() const;
333 
339  PHYSXSCHEMA_API
340  UsdAttribute CreateVelSmoothingAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
341 
342 public:
343  // --------------------------------------------------------------------- //
344  // LOCALSHAPEMATCHINGCOMPLIANCE
345  // --------------------------------------------------------------------- //
357  PHYSXSCHEMA_API
358  UsdAttribute GetLocalShapeMatchingComplianceAttr() const;
359 
365  PHYSXSCHEMA_API
366  UsdAttribute CreateLocalShapeMatchingComplianceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
367 
368 public:
369  // --------------------------------------------------------------------- //
370  // LOCALSHAPEMATCHINGLINEARSTRETCHING
371  // --------------------------------------------------------------------- //
383  PHYSXSCHEMA_API
384  UsdAttribute GetLocalShapeMatchingLinearStretchingAttr() const;
385 
391  PHYSXSCHEMA_API
392  UsdAttribute CreateLocalShapeMatchingLinearStretchingAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
393 
394 public:
395  // --------------------------------------------------------------------- //
396  // LOCALSHAPEMATCHINGGROUPSIZE
397  // --------------------------------------------------------------------- //
408  PHYSXSCHEMA_API
409  UsdAttribute GetLocalShapeMatchingGroupSizeAttr() const;
410 
416  PHYSXSCHEMA_API
417  UsdAttribute CreateLocalShapeMatchingGroupSizeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
418 
419 public:
420  // --------------------------------------------------------------------- //
421  // LOCALSHAPEMATCHINGGROUPOVERLAP
422  // --------------------------------------------------------------------- //
433  PHYSXSCHEMA_API
434  UsdAttribute GetLocalShapeMatchingGroupOverlapAttr() const;
435 
441  PHYSXSCHEMA_API
442  UsdAttribute CreateLocalShapeMatchingGroupOverlapAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
443 
444 public:
445  // ===================================================================== //
446  // Feel free to add custom code below this line, it will be preserved by
447  // the code generator.
448  //
449  // Just remember to:
450  // - Close the class declaration with };
451  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
452  // - Close the include guard with #endif
453  // ===================================================================== //
454  // --(BEGIN CUSTOM CODE)--
455 };
456 
457 PXR_NAMESPACE_CLOSE_SCOPE
458 
459 #endif
PHYSXSCHEMA_API UsdAttribute CreateLocalShapeMatchingLinearStretchingAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLocalShapeMatchingLinearStretchingAttr(), and also Usd_Create_Or_Get_Property for when to use ...
PHYSXSCHEMA_API UsdAttribute GetInterHairRepulsionAttr() const
Strength of the repulsion effect between hair segments.
PHYSXSCHEMA_API UsdAttribute CreateGlobalShapeComplianceStrandAttenuationAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetGlobalShapeComplianceStrandAttenuationAttr(), and also Usd_Create_Or_Get_Property for when to ...
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 PhysxSchemaPhysxHairAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PhysxSchemaPhysxHairAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxHairAPI on UsdPrim prim .
Definition: physxHairAPI.h:71
PHYSXSCHEMA_API UsdAttribute GetGlobalShapeComplianceStrandAttenuationAttr() const
The factor by which the compliance to the global shape-matching constraint changes from a simulation ...
PHYSXSCHEMA_API UsdAttribute GetLocalShapeMatchingLinearStretchingAttr() const
Proportion of linear stretching vs rigid transformation allowed in the local shape matching constrain...
PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
PHYSXSCHEMA_API UsdAttribute CreateVelSmoothingAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetVelSmoothingAttr(), 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.
Definition: physxHairAPI.h:59
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 GetGlobalShapeComplianceAtRootAttr() const
Compliance to the global shape-matching constraint at the root of the strand.
PHYSXSCHEMA_API UsdAttribute CreateSegmentLengthAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSegmentLengthAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetTwosidedAttachmentAttr() const
Whether the hair should have an effect on the body it is attached to.
PHYSXSCHEMA_API UsdAttribute GetLocalShapeMatchingComplianceAttr() const
Compliance to the local shape matching constraint, which preserves strand shapes. ...
PHYSXSCHEMA_API UsdAttribute GetLocalShapeMatchingGroupSizeAttr() const
How many vertices of a strand are grouped together into one shape-matching constraint.
PHYSXSCHEMA_API UsdAttribute GetVelSmoothingAttr() const
Strength of the velocity smoothing effect.
PHYSXSCHEMA_API UsdAttribute CreateLocalShapeMatchingGroupSizeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLocalShapeMatchingGroupSizeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs ...
PHYSXSCHEMA_API UsdAttribute GetLocalShapeMatchingGroupOverlapAttr() const
Number of vertices by which consecutive shape-matching groups are overlapping.
PhysxSchemaPhysxHairAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxHairAPI on the prim held by schemaObj .
Definition: physxHairAPI.h:79
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxHairAPI()
Destructor.
PHYSXSCHEMA_API UsdAttribute CreateTwosidedAttachmentAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetTwosidedAttachmentAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateLocalShapeMatchingGroupOverlapAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLocalShapeMatchingGroupOverlapAttr(), and also Usd_Create_Or_Get_Property for when to use Get ...
static PHYSXSCHEMA_API PhysxSchemaPhysxHairAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxHairAPI holding the prim adhering to this schema at path on stage...
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: physxHairAPI.h:65
PHYSXSCHEMA_API UsdAttribute CreateExternalCollisionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetExternalCollisionAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateGlobalShapeComplianceAtRootAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetGlobalShapeComplianceAtRootAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs ...
PHYSXSCHEMA_API UsdAttribute GetExternalCollisionAttr() const
Enables the hair segments to collide with other physics objects that have a collision API applied to ...
PHYSXSCHEMA_API UsdAttribute CreateLocalShapeMatchingComplianceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLocalShapeMatchingComplianceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs...
PHYSXSCHEMA_API UsdAttribute GetSegmentLengthAttr() const
Length of one hair segment (i.e., distance between simulation vertices along a strand).
PHYSXSCHEMA_API UsdAttribute CreateInterHairRepulsionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetInterHairRepulsionAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...