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 "pxr/usd/usdPhysics/api.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.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 
64 {
65 public:
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 
101  USDPHYSICS_API
102  static const TfTokenVector &
103  GetSchemaAttributeNames(bool includeInherited=true);
104 
110  USDPHYSICS_API
111  static TfTokenVector
112  GetSchemaAttributeNames(bool includeInherited, const TfToken &instanceName);
113 
115  TfToken GetName() const {
116  return _GetInstanceName();
117  }
118 
133  USDPHYSICS_API
134  static UsdPhysicsLimitAPI
135  Get(const UsdStagePtr &stage, const SdfPath &path);
136 
139  USDPHYSICS_API
140  static UsdPhysicsLimitAPI
141  Get(const UsdPrim &prim, const TfToken &name);
142 
145  USDPHYSICS_API
146  static std::vector<UsdPhysicsLimitAPI>
147  GetAll(const UsdPrim &prim);
148 
151  USDPHYSICS_API
152  static bool
153  IsSchemaPropertyBaseName(const TfToken &baseName);
154 
158  USDPHYSICS_API
159  static bool
160  IsPhysicsLimitAPIPath(const SdfPath &path, TfToken *name);
161 
178  USDPHYSICS_API
179  static bool
180  CanApply(const UsdPrim &prim, const TfToken &name,
181  std::string *whyNot=nullptr);
182 
202  USDPHYSICS_API
203  static UsdPhysicsLimitAPI
204  Apply(const UsdPrim &prim, const TfToken &name);
205 
206 protected:
210  USDPHYSICS_API
211  UsdSchemaKind _GetSchemaKind() const override;
212 
213 private:
214  // needs to invoke _GetStaticTfType.
215  friend class UsdSchemaRegistry;
216  USDPHYSICS_API
217  static const TfType &_GetStaticTfType();
218 
219  static bool _IsTypedSchema();
220 
221  // override SchemaBase virtuals.
222  USDPHYSICS_API
223  const TfType &_GetTfType() const override;
224 
225 public:
226  // --------------------------------------------------------------------- //
227  // LOW
228  // --------------------------------------------------------------------- //
237  USDPHYSICS_API
238  UsdAttribute GetLowAttr() const;
239 
245  USDPHYSICS_API
246  UsdAttribute CreateLowAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
247 
248 public:
249  // --------------------------------------------------------------------- //
250  // HIGH
251  // --------------------------------------------------------------------- //
260  USDPHYSICS_API
261  UsdAttribute GetHighAttr() const;
262 
268  USDPHYSICS_API
269  UsdAttribute CreateHighAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
270 
271 public:
272  // ===================================================================== //
273  // Feel free to add custom code below this line, it will be preserved by
274  // the code generator.
275  //
276  // Just remember to:
277  // - Close the class declaration with };
278  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
279  // - Close the include guard with #endif
280  // ===================================================================== //
281  // --(BEGIN CUSTOM CODE)--
282 };
283 
284 PXR_NAMESPACE_CLOSE_SCOPE
285 
286 #endif
USDPHYSICS_API UsdAttribute GetLowAttr() const
Lower limit.
virtual USDPHYSICS_API ~UsdPhysicsLimitAPI()
Destructor.
USDPHYSICS_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
USDPHYSICS_API UsdAttribute CreateLowAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLowAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
The base class for all API schemas.
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
static USDPHYSICS_API std::vector< UsdPhysicsLimitAPI > GetAll(const UsdPrim &prim)
Return a vector of all named instances of UsdPhysicsLimitAPI on the given prim.
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
static USDPHYSICS_API bool CanApply(const UsdPrim &prim, const TfToken &name, std::string *whyNot=nullptr)
Returns true if this multiple-apply API schema can be applied, with the given instance name,...
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
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.
TfToken GetName() const
Returns the name of this multiple-apply schema instance.
Definition: limitAPI.h:115
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
USDPHYSICS_API UsdAttribute GetHighAttr() const
Upper limit.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
USDPHYSICS_API UsdAttribute CreateHighAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetHighAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
Multiple Apply API Schema.
TfType represents a dynamic runtime type.
Definition: type.h:64
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: limitAPI.h:69
Singleton registry that provides access to schema type information and the prim definitions for regis...
static USDPHYSICS_API bool IsPhysicsLimitAPIPath(const SdfPath &path, TfToken *name)
Checks if the given path path is of an API schema of type PhysicsLimitAPI.
The base class for all schema types in Usd.
Definition: schemaBase.h:56
const TfToken & _GetInstanceName() const
Returns the instance name of the API schema object belonging to a multiple-apply API schema.
static USDPHYSICS_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 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,...
The PhysicsLimitAPI can be applied to a PhysicsJoint and will restrict the movement along an axis.
Definition: limitAPI.h:63
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:166
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
static USDPHYSICS_API bool IsSchemaPropertyBaseName(const TfToken &baseName)
Checks if the given name baseName is the base name of a property of PhysicsLimitAPI.