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 UsdSchemaType schemaType = UsdSchemaType::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 
124  PHYSXSCHEMA_API
126  Apply(const UsdPrim &prim);
127 
128 protected:
132  PHYSXSCHEMA_API
133  UsdSchemaType _GetSchemaType() const override;
134 
135 private:
136  // needs to invoke _GetStaticTfType.
137  friend class UsdSchemaRegistry;
138  PHYSXSCHEMA_API
139  static const TfType &_GetStaticTfType();
140 
141  static bool _IsTypedSchema();
142 
143  // override SchemaBase virtuals.
144  PHYSXSCHEMA_API
145  const TfType &_GetTfType() const override;
146 
147 public:
148  // --------------------------------------------------------------------- //
149  // PARTICLEANISOTROPYENABLED
150  // --------------------------------------------------------------------- //
158  PHYSXSCHEMA_API
159  UsdAttribute GetParticleAnisotropyEnabledAttr() const;
160 
166  PHYSXSCHEMA_API
167  UsdAttribute CreateParticleAnisotropyEnabledAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
168 
169 public:
170  // --------------------------------------------------------------------- //
171  // SCALE
172  // --------------------------------------------------------------------- //
182  PHYSXSCHEMA_API
183  UsdAttribute GetScaleAttr() const;
184 
190  PHYSXSCHEMA_API
191  UsdAttribute CreateScaleAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
192 
193 public:
194  // --------------------------------------------------------------------- //
195  // MIN
196  // --------------------------------------------------------------------- //
206  PHYSXSCHEMA_API
207  UsdAttribute GetMinAttr() const;
208 
214  PHYSXSCHEMA_API
215  UsdAttribute CreateMinAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
216 
217 public:
218  // --------------------------------------------------------------------- //
219  // MAX
220  // --------------------------------------------------------------------- //
230  PHYSXSCHEMA_API
231  UsdAttribute GetMaxAttr() const;
232 
238  PHYSXSCHEMA_API
239  UsdAttribute CreateMaxAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
240 
241 public:
242  // ===================================================================== //
243  // Feel free to add custom code below this line, it will be preserved by
244  // the code generator.
245  //
246  // Just remember to:
247  // - Close the class declaration with };
248  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
249  // - Close the include guard with #endif
250  // ===================================================================== //
251  // --(BEGIN CUSTOM CODE)--
252 };
253 
254 PXR_NAMESPACE_CLOSE_SCOPE
255 
256 #endif
static const UsdSchemaType schemaType
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 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.
PHYSXSCHEMA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
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 . ...