All Classes Files Functions Variables Pages
physxCameraFollowLookAPI.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_PHYSXCAMERAFOLLOWLOOKAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXCAMERAFOLLOWLOOKAPI_H
26 
28 
29 #include "pxr/pxr.h"
30 #include ".//api.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 // PHYSXCAMERAFOLLOWLOOKAPI //
51 // -------------------------------------------------------------------------- //
52 
58 {
59 public:
63  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
64 
69  explicit PhysxSchemaPhysxCameraFollowLookAPI(const UsdPrim& prim=UsdPrim())
71  {
72  }
73 
77  explicit PhysxSchemaPhysxCameraFollowLookAPI(const UsdSchemaBase& schemaObj)
79  {
80  }
81 
83  PHYSXSCHEMA_API
85 
89  PHYSXSCHEMA_API
90  static const TfTokenVector &
91  GetSchemaAttributeNames(bool includeInherited=true);
92 
102  PHYSXSCHEMA_API
104  Get(const UsdStagePtr &stage, const SdfPath &path);
105 
106 
121  PHYSXSCHEMA_API
123  Apply(const UsdPrim &prim);
124 
125 protected:
129  PHYSXSCHEMA_API
130  UsdSchemaType _GetSchemaType() const override;
131 
132 private:
133  // needs to invoke _GetStaticTfType.
134  friend class UsdSchemaRegistry;
135  PHYSXSCHEMA_API
136  static const TfType &_GetStaticTfType();
137 
138  static bool _IsTypedSchema();
139 
140  // override SchemaBase virtuals.
141  PHYSXSCHEMA_API
142  const TfType &_GetTfType() const override;
143 
144 public:
145  // --------------------------------------------------------------------- //
146  // DOWNHILLGROUNDANGLE
147  // --------------------------------------------------------------------- //
155  PHYSXSCHEMA_API
156  UsdAttribute GetDownHillGroundAngleAttr() const;
157 
163  PHYSXSCHEMA_API
164  UsdAttribute CreateDownHillGroundAngleAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
165 
166 public:
167  // --------------------------------------------------------------------- //
168  // DOWNHILLGROUNDPITCH
169  // --------------------------------------------------------------------- //
177  PHYSXSCHEMA_API
178  UsdAttribute GetDownHillGroundPitchAttr() const;
179 
185  PHYSXSCHEMA_API
186  UsdAttribute CreateDownHillGroundPitchAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
187 
188 public:
189  // --------------------------------------------------------------------- //
190  // UPHILLGROUNDANGLE
191  // --------------------------------------------------------------------- //
199  PHYSXSCHEMA_API
200  UsdAttribute GetUpHillGroundAngleAttr() const;
201 
207  PHYSXSCHEMA_API
208  UsdAttribute CreateUpHillGroundAngleAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
209 
210 public:
211  // --------------------------------------------------------------------- //
212  // UPHILLGROUNDPITCH
213  // --------------------------------------------------------------------- //
221  PHYSXSCHEMA_API
222  UsdAttribute GetUpHillGroundPitchAttr() const;
223 
229  PHYSXSCHEMA_API
230  UsdAttribute CreateUpHillGroundPitchAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
231 
232 public:
233  // --------------------------------------------------------------------- //
234  // VELOCITYBLENDTIMECONSTANT
235  // --------------------------------------------------------------------- //
243  PHYSXSCHEMA_API
244  UsdAttribute GetVelocityBlendTimeConstantAttr() const;
245 
251  PHYSXSCHEMA_API
252  UsdAttribute CreateVelocityBlendTimeConstantAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
253 
254 public:
255  // --------------------------------------------------------------------- //
256  // FOLLOWREVERSESPEED
257  // --------------------------------------------------------------------- //
265  PHYSXSCHEMA_API
266  UsdAttribute GetFollowReverseSpeedAttr() const;
267 
273  PHYSXSCHEMA_API
274  UsdAttribute CreateFollowReverseSpeedAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
275 
276 public:
277  // --------------------------------------------------------------------- //
278  // FOLLOWREVERSEDISTANCE
279  // --------------------------------------------------------------------- //
287  PHYSXSCHEMA_API
288  UsdAttribute GetFollowReverseDistanceAttr() const;
289 
295  PHYSXSCHEMA_API
296  UsdAttribute CreateFollowReverseDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
297 
298 public:
299  // ===================================================================== //
300  // Feel free to add custom code below this line, it will be preserved by
301  // the code generator.
302  //
303  // Just remember to:
304  // - Close the class declaration with };
305  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
306  // - Close the include guard with #endif
307  // ===================================================================== //
308  // --(BEGIN CUSTOM CODE)--
309 };
310 
311 PXR_NAMESPACE_CLOSE_SCOPE
312 
313 #endif
PHYSXSCHEMA_API UsdAttribute CreateFollowReverseSpeedAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFollowReverseSpeedAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PhysX camera that follows behind the subject's forward vector as it moves.
PHYSXSCHEMA_API UsdAttribute GetFollowReverseDistanceAttr() const
The maximum distance, when driving in reverse, used for a linear interpolation to compute the follow ...
PHYSXSCHEMA_API UsdAttribute GetFollowReverseSpeedAttr() const
The positive, maximum speed, when driving in reverse, used for a linear interpolation to compute the ...
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxCameraFollowLookAPI()
Destructor.
PHYSXSCHEMA_API UsdAttribute CreateDownHillGroundPitchAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDownHillGroundPitchAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PhysxSchemaPhysxCameraFollowLookAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxCameraFollowLookAPI on UsdPrim prim .
PHYSXSCHEMA_API UsdAttribute CreateUpHillGroundPitchAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetUpHillGroundPitchAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
static PHYSXSCHEMA_API PhysxSchemaPhysxCameraFollowLookAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
PhysxSchemaPhysxCameraFollowLookAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxCameraFollowLookAPI on the prim held by schemaObj .
PHYSXSCHEMA_API UsdAttribute GetDownHillGroundAngleAttr() const
The minimum pitch angle of the terrain used for a linear interpolation to adjust the pitch of the cam...
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
static PHYSXSCHEMA_API PhysxSchemaPhysxCameraFollowLookAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxCameraFollowLookAPI holding the prim adhering to this schema at path on stag...
PHYSXSCHEMA_API UsdAttribute CreateUpHillGroundAngleAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetUpHillGroundAngleAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetVelocityBlendTimeConstantAttr() const
Filter time constant to blend between the look and velocity vectors, in seconds.
PHYSXSCHEMA_API UsdAttribute CreateVelocityBlendTimeConstantAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetVelocityBlendTimeConstantAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Cr...
PHYSXSCHEMA_API UsdAttribute CreateFollowReverseDistanceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFollowReverseDistanceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PhysX camera that follows behind the subject as it moves.
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...
PHYSXSCHEMA_API UsdAttribute GetUpHillGroundPitchAttr() const
The maximum pitch angle of the camera used for a linear interpolation to adjust the pitch of the came...
PHYSXSCHEMA_API UsdAttribute GetUpHillGroundAngleAttr() const
The maximum pitch angle of the terrain used for a linear interpolation to adjust the pitch of the cam...
PHYSXSCHEMA_API UsdAttribute GetDownHillGroundPitchAttr() const
The minimum pitch angle of the camera used for a linear interpolation to adjust the pitch of the came...
PHYSXSCHEMA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
PHYSXSCHEMA_API UsdAttribute CreateDownHillGroundAngleAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDownHillGroundAngleAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...