All Classes Files Functions Variables Pages
limitAPI.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 USDPHYSICS_GENERATED_LIMITAPI_H
25 #define USDPHYSICS_GENERATED_LIMITAPI_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "usdPhysics/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 "usdPhysics/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 // PHYSICSLIMITAPI //
51 // -------------------------------------------------------------------------- //
52 
63 class UsdPhysicsLimitAPI : public UsdAPISchemaBase
64 {
65 public:
69  static const UsdSchemaType schemaType = UsdSchemaType::MultipleApplyAPI;
70 
81  const UsdPrim& prim=UsdPrim(), const TfToken &name=TfToken())
82  : UsdAPISchemaBase(prim, /*instanceName*/ name)
83  { }
84 
90  const UsdSchemaBase& schemaObj, const TfToken &name)
91  : UsdAPISchemaBase(schemaObj, /*instanceName*/ name)
92  { }
93 
95  USDPHYSICS_API
96  virtual ~UsdPhysicsLimitAPI();
97 
103  USDPHYSICS_API
104  static const TfTokenVector &
106  bool includeInherited=true, const TfToken instanceName=TfToken());
107 
109  TfToken GetName() const {
110  return _GetInstanceName();
111  }
112 
127  USDPHYSICS_API
128  static UsdPhysicsLimitAPI
129  Get(const UsdStagePtr &stage, const SdfPath &path);
130 
133  USDPHYSICS_API
134  static UsdPhysicsLimitAPI
135  Get(const UsdPrim &prim, const TfToken &name);
136 
139  USDPHYSICS_API
140  static bool
141  IsSchemaPropertyBaseName(const TfToken &baseName);
142 
146  USDPHYSICS_API
147  static bool
148  IsPhysicsLimitAPIPath(const SdfPath &path, TfToken *name);
149 
168  USDPHYSICS_API
169  static UsdPhysicsLimitAPI
170  Apply(const UsdPrim &prim, const TfToken &name);
171 
172 protected:
176  USDPHYSICS_API
177  UsdSchemaType _GetSchemaType() const override;
178 
179 private:
180  // needs to invoke _GetStaticTfType.
181  friend class UsdSchemaRegistry;
182  USDPHYSICS_API
183  static const TfType &_GetStaticTfType();
184 
185  static bool _IsTypedSchema();
186 
187  // override SchemaBase virtuals.
188  USDPHYSICS_API
189  const TfType &_GetTfType() const override;
190 
191 public:
192  // --------------------------------------------------------------------- //
193  // LOW
194  // --------------------------------------------------------------------- //
203  USDPHYSICS_API
204  UsdAttribute GetLowAttr() const;
205 
211  USDPHYSICS_API
212  UsdAttribute CreateLowAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
213 
214 public:
215  // --------------------------------------------------------------------- //
216  // HIGH
217  // --------------------------------------------------------------------- //
226  USDPHYSICS_API
227  UsdAttribute GetHighAttr() const;
228 
234  USDPHYSICS_API
235  UsdAttribute CreateHighAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
236 
237 public:
238  // ===================================================================== //
239  // Feel free to add custom code below this line, it will be preserved by
240  // the code generator.
241  //
242  // Just remember to:
243  // - Close the class declaration with };
244  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
245  // - Close the include guard with #endif
246  // ===================================================================== //
247  // --(BEGIN CUSTOM CODE)--
248 };
249 
250 PXR_NAMESPACE_CLOSE_SCOPE
251 
252 #endif
virtual USDPHYSICS_API ~UsdPhysicsLimitAPI()
Destructor.
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: limitAPI.h:69
TfToken GetName() const
Returns the name of this multiple-apply schema instance.
Definition: limitAPI.h:109
USDPHYSICS_API UsdAttribute CreateLowAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLowAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.
USDPHYSICS_API UsdAttribute GetLowAttr() const
Lower limit.
USDPHYSICS_API UsdAttribute GetHighAttr() const
Upper limit.
UsdPhysicsLimitAPI(const UsdPrim &prim=UsdPrim(), const TfToken &name=TfToken())
Construct a UsdPhysicsLimitAPI on UsdPrim prim with name name .
Definition: limitAPI.h:80
UsdPhysicsLimitAPI(const UsdSchemaBase &schemaObj, const TfToken &name)
Construct a UsdPhysicsLimitAPI on the prim held by schemaObj with name name.
Definition: limitAPI.h:89
static USDPHYSICS_API UsdPhysicsLimitAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdPhysicsLimitAPI holding the prim adhering to this schema at path on stage.
static USDPHYSICS_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true, const TfToken instanceName=TfToken())
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor cl...
USDPHYSICS_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
static USDPHYSICS_API bool IsPhysicsLimitAPIPath(const SdfPath &path, TfToken *name)
Checks if the given path path is of an API schema of type PhysicsLimitAPI.
static USDPHYSICS_API UsdPhysicsLimitAPI Apply(const UsdPrim &prim, const TfToken &name)
Applies this multiple-apply API schema to the given prim along with the given instance name...
USDPHYSICS_API UsdAttribute CreateHighAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetHighAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.
The PhysicsLimitAPI can be applied to a PhysicsJoint and will restrict the movement along an axis...
Definition: limitAPI.h:63
static USDPHYSICS_API bool IsSchemaPropertyBaseName(const TfToken &baseName)
Checks if the given name baseName is the base name of a property of PhysicsLimitAPI.