All Classes Files Functions Variables Pages
physxCameraFollowVelocityAPI.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_PHYSXCAMERAFOLLOWVELOCITYAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXCAMERAFOLLOWVELOCITYAPI_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 
35 #include "pxr/base/vt/value.h"
36 
37 #include "pxr/base/gf/vec3d.h"
38 #include "pxr/base/gf/vec3f.h"
39 #include "pxr/base/gf/matrix4d.h"
40 
41 #include "pxr/base/tf/token.h"
42 #include "pxr/base/tf/type.h"
43 
44 PXR_NAMESPACE_OPEN_SCOPE
45 
46 class SdfAssetPath;
47 
48 // -------------------------------------------------------------------------- //
49 // PHYSXCAMERAFOLLOWVELOCITYAPI //
50 // -------------------------------------------------------------------------- //
51 
56 class PhysxSchemaPhysxCameraFollowVelocityAPI : public UsdAPISchemaBase
57 {
58 public:
62  static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
63 
68  explicit PhysxSchemaPhysxCameraFollowVelocityAPI(const UsdPrim& prim=UsdPrim())
69  : UsdAPISchemaBase(prim)
70  {
71  }
72 
76  explicit PhysxSchemaPhysxCameraFollowVelocityAPI(const UsdSchemaBase& schemaObj)
77  : UsdAPISchemaBase(schemaObj)
78  {
79  }
80 
82  PHYSXSCHEMA_API
84 
88  PHYSXSCHEMA_API
89  static const TfTokenVector &
90  GetSchemaAttributeNames(bool includeInherited=true);
91 
101  PHYSXSCHEMA_API
103  Get(const UsdStagePtr &stage, const SdfPath &path);
104 
105 
122  PHYSXSCHEMA_API
123  static bool
124  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
125 
141  PHYSXSCHEMA_API
143  Apply(const UsdPrim &prim);
144 
145 protected:
149  PHYSXSCHEMA_API
150  UsdSchemaKind _GetSchemaKind() const override;
151 
152 private:
153  // needs to invoke _GetStaticTfType.
154  friend class UsdSchemaRegistry;
155  PHYSXSCHEMA_API
156  static const TfType &_GetStaticTfType();
157 
158  static bool _IsTypedSchema();
159 
160  // override SchemaBase virtuals.
161  PHYSXSCHEMA_API
162  const TfType &_GetTfType() const override;
163 
164 public:
165  // ===================================================================== //
166  // Feel free to add custom code below this line, it will be preserved by
167  // the code generator.
168  //
169  // Just remember to:
170  // - Close the class declaration with };
171  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
172  // - Close the include guard with #endif
173  // ===================================================================== //
174  // --(BEGIN CUSTOM CODE)--
175 };
176 
177 PXR_NAMESPACE_CLOSE_SCOPE
178 
179 #endif
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxCameraFollowVelocityAPI()
Destructor.
static PHYSXSCHEMA_API PhysxSchemaPhysxCameraFollowVelocityAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxCameraFollowVelocityAPI holding the prim adhering to this schema at path on ...
PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
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...
PhysX camera that follows behind the subject's velocity vector as it moves, which allows the subject ...
PhysxSchemaPhysxCameraFollowVelocityAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxCameraFollowVelocityAPI on the prim held by schemaObj ...
static PHYSXSCHEMA_API PhysxSchemaPhysxCameraFollowVelocityAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
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.
PhysxSchemaPhysxCameraFollowVelocityAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxCameraFollowVelocityAPI on UsdPrim prim .
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.