All Classes Files Functions Variables Pages
physxParticleAnisotropyAPI.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_PHYSXPARTICLEANISOTROPYAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXPARTICLEANISOTROPYAPI_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 // PHYSXPARTICLEANISOTROPYAPI //
51 // -------------------------------------------------------------------------- //
52 
60 class PhysxSchemaPhysxParticleAnisotropyAPI : public UsdAPISchemaBase
61 {
62 public:
66  static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
67 
72  explicit PhysxSchemaPhysxParticleAnisotropyAPI(const UsdPrim& prim=UsdPrim())
73  : UsdAPISchemaBase(prim)
74  {
75  }
76 
80  explicit PhysxSchemaPhysxParticleAnisotropyAPI(const UsdSchemaBase& schemaObj)
81  : UsdAPISchemaBase(schemaObj)
82  {
83  }
84 
86  PHYSXSCHEMA_API
88 
92  PHYSXSCHEMA_API
93  static const TfTokenVector &
94  GetSchemaAttributeNames(bool includeInherited=true);
95 
105  PHYSXSCHEMA_API
107  Get(const UsdStagePtr &stage, const SdfPath &path);
108 
109 
126  PHYSXSCHEMA_API
127  static bool
128  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
129 
145  PHYSXSCHEMA_API
147  Apply(const UsdPrim &prim);
148 
149 protected:
153  PHYSXSCHEMA_API
154  UsdSchemaKind _GetSchemaKind() const override;
155 
156 private:
157  // needs to invoke _GetStaticTfType.
158  friend class UsdSchemaRegistry;
159  PHYSXSCHEMA_API
160  static const TfType &_GetStaticTfType();
161 
162  static bool _IsTypedSchema();
163 
164  // override SchemaBase virtuals.
165  PHYSXSCHEMA_API
166  const TfType &_GetTfType() const override;
167 
168 public:
169  // --------------------------------------------------------------------- //
170  // PARTICLEANISOTROPYENABLED
171  // --------------------------------------------------------------------- //
179  PHYSXSCHEMA_API
180  UsdAttribute GetParticleAnisotropyEnabledAttr() const;
181 
187  PHYSXSCHEMA_API
188  UsdAttribute CreateParticleAnisotropyEnabledAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
189 
190 public:
191  // --------------------------------------------------------------------- //
192  // SCALE
193  // --------------------------------------------------------------------- //
203  PHYSXSCHEMA_API
204  UsdAttribute GetScaleAttr() const;
205 
211  PHYSXSCHEMA_API
212  UsdAttribute CreateScaleAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
213 
214 public:
215  // --------------------------------------------------------------------- //
216  // MIN
217  // --------------------------------------------------------------------- //
227  PHYSXSCHEMA_API
228  UsdAttribute GetMinAttr() const;
229 
235  PHYSXSCHEMA_API
236  UsdAttribute CreateMinAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
237 
238 public:
239  // --------------------------------------------------------------------- //
240  // MAX
241  // --------------------------------------------------------------------- //
251  PHYSXSCHEMA_API
252  UsdAttribute GetMaxAttr() const;
253 
259  PHYSXSCHEMA_API
260  UsdAttribute CreateMaxAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
261 
262 public:
263  // ===================================================================== //
264  // Feel free to add custom code below this line, it will be preserved by
265  // the code generator.
266  //
267  // Just remember to:
268  // - Close the class declaration with };
269  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
270  // - Close the include guard with #endif
271  // ===================================================================== //
272  // --(BEGIN CUSTOM CODE)--
273 };
274 
275 PXR_NAMESPACE_CLOSE_SCOPE
276 
277 #endif
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxParticleAnisotropyAPI()
Destructor.
static PHYSXSCHEMA_API PhysxSchemaPhysxParticleAnisotropyAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxParticleAnisotropyAPI holding the prim adhering to this schema at path on st...
PHYSXSCHEMA_API UsdAttribute GetMinAttr() const
Minimum scale of anisotropy relative to fluidRestOffset for rendering.
PHYSXSCHEMA_API UsdAttribute GetScaleAttr() const
Scale of anisotropy for rendering.
PhysxSchemaPhysxParticleAnisotropyAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxParticleAnisotropyAPI on UsdPrim prim .
PHYSXSCHEMA_API UsdAttribute GetMaxAttr() const
Maximum scale of anisotropy relative to fluidRestOffset for rendering.
PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
PHYSXSCHEMA_API UsdAttribute CreateMinAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMinAttr(), 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.
PHYSXSCHEMA_API UsdAttribute CreateScaleAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetScaleAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.
PHYSXSCHEMA_API UsdAttribute CreateMaxAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMaxAttr(), 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.
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...
static PHYSXSCHEMA_API PhysxSchemaPhysxParticleAnisotropyAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PHYSXSCHEMA_API UsdAttribute CreateParticleAnisotropyEnabledAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetParticleAnisotropyEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Cr...
PHYSXSCHEMA_API UsdAttribute GetParticleAnisotropyEnabledAttr() const
Enables use of fluid anisotropy information for rendering.
PhysxSchemaPhysxParticleAnisotropyAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxParticleAnisotropyAPI on the prim held by schemaObj . ...