All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups 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 "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 
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 
166  USDPHYSICS_API
167  static bool
168  CanApply(const UsdPrim &prim, const TfToken &name,
169  std::string *whyNot=nullptr);
170 
190  USDPHYSICS_API
191  static UsdPhysicsLimitAPI
192  Apply(const UsdPrim &prim, const TfToken &name);
193 
194 protected:
198  USDPHYSICS_API
199  UsdSchemaKind _GetSchemaKind() const override;
200 
201 private:
202  // needs to invoke _GetStaticTfType.
203  friend class UsdSchemaRegistry;
204  USDPHYSICS_API
205  static const TfType &_GetStaticTfType();
206 
207  static bool _IsTypedSchema();
208 
209  // override SchemaBase virtuals.
210  USDPHYSICS_API
211  const TfType &_GetTfType() const override;
212 
213 public:
214  // --------------------------------------------------------------------- //
215  // LOW
216  // --------------------------------------------------------------------- //
225  USDPHYSICS_API
226  UsdAttribute GetLowAttr() const;
227 
233  USDPHYSICS_API
234  UsdAttribute CreateLowAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
235 
236 public:
237  // --------------------------------------------------------------------- //
238  // HIGH
239  // --------------------------------------------------------------------- //
248  USDPHYSICS_API
249  UsdAttribute GetHighAttr() const;
250 
256  USDPHYSICS_API
257  UsdAttribute CreateHighAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
258 
259 public:
260  // ===================================================================== //
261  // Feel free to add custom code below this line, it will be preserved by
262  // the code generator.
263  //
264  // Just remember to:
265  // - Close the class declaration with };
266  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
267  // - Close the include guard with #endif
268  // ===================================================================== //
269  // --(BEGIN CUSTOM CODE)--
270 };
271 
272 PXR_NAMESPACE_CLOSE_SCOPE
273 
274 #endif
virtual USDPHYSICS_API ~UsdPhysicsLimitAPI()
Destructor.
USDPHYSICS_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
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 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, sampled over time.
Definition: attribute.h:176
USDPHYSICS_API UsdAttribute GetLowAttr() const
Lower limit.
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...
USDPHYSICS_API UsdAttribute GetHighAttr() const
Upper limit.
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.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:132
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:288
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...
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
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 Create vs Get Property Methods 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
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:168
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
const TfToken & _GetInstanceName() const
Returns the instance name of the API schema object belonging to a multiple-apply API schema...
static USDPHYSICS_API bool IsSchemaPropertyBaseName(const TfToken &baseName)
Checks if the given name baseName is the base name of a property of PhysicsLimitAPI.