All Classes Files Functions Variables Pages
physxCameraDroneAPI.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_PHYSXCAMERADRONEAPI_H
25 #define PHYSXSCHEMA_GENERATED_PHYSXCAMERADRONEAPI_H
26 
28 
29 #include "pxr/pxr.h"
30 #include ".//api.h"
31 #include ".//physxCameraAPI.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 // PHYSXCAMERADRONEAPI //
51 // -------------------------------------------------------------------------- //
52 
58 {
59 public:
63  static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI;
64 
69  explicit PhysxSchemaPhysxCameraDroneAPI(const UsdPrim& prim=UsdPrim())
71  {
72  }
73 
77  explicit PhysxSchemaPhysxCameraDroneAPI(const UsdSchemaBase& schemaObj)
78  : PhysxSchemaPhysxCameraAPI(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  // FOLLOWHEIGHT
147  // --------------------------------------------------------------------- //
155  PHYSXSCHEMA_API
156  UsdAttribute GetFollowHeightAttr() const;
157 
163  PHYSXSCHEMA_API
164  UsdAttribute CreateFollowHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
165 
166 public:
167  // --------------------------------------------------------------------- //
168  // FOLLOWDISTANCE
169  // --------------------------------------------------------------------- //
177  PHYSXSCHEMA_API
178  UsdAttribute GetFollowDistanceAttr() const;
179 
185  PHYSXSCHEMA_API
186  UsdAttribute CreateFollowDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
187 
188 public:
189  // --------------------------------------------------------------------- //
190  // MAXDISTANCE
191  // --------------------------------------------------------------------- //
199  PHYSXSCHEMA_API
200  UsdAttribute GetMaxDistanceAttr() const;
201 
207  PHYSXSCHEMA_API
208  UsdAttribute CreateMaxDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
209 
210 public:
211  // --------------------------------------------------------------------- //
212  // MAXSPEED
213  // --------------------------------------------------------------------- //
221  PHYSXSCHEMA_API
222  UsdAttribute GetMaxSpeedAttr() const;
223 
229  PHYSXSCHEMA_API
230  UsdAttribute CreateMaxSpeedAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
231 
232 public:
233  // --------------------------------------------------------------------- //
234  // HORIZONTALVELOCITYGAIN
235  // --------------------------------------------------------------------- //
243  PHYSXSCHEMA_API
244  UsdAttribute GetHorizontalVelocityGainAttr() const;
245 
251  PHYSXSCHEMA_API
252  UsdAttribute CreateHorizontalVelocityGainAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
253 
254 public:
255  // --------------------------------------------------------------------- //
256  // VERTICALVELOCITYGAIN
257  // --------------------------------------------------------------------- //
265  PHYSXSCHEMA_API
266  UsdAttribute GetVerticalVelocityGainAttr() const;
267 
273  PHYSXSCHEMA_API
274  UsdAttribute CreateVerticalVelocityGainAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
275 
276 public:
277  // --------------------------------------------------------------------- //
278  // FEEDFORWARDVELOCITYGAIN
279  // --------------------------------------------------------------------- //
287  PHYSXSCHEMA_API
288  UsdAttribute GetFeedForwardVelocityGainAttr() const;
289 
295  PHYSXSCHEMA_API
296  UsdAttribute CreateFeedForwardVelocityGainAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
297 
298 public:
299  // --------------------------------------------------------------------- //
300  // VELOCITYFILTERTIMECONSTANT
301  // --------------------------------------------------------------------- //
309  PHYSXSCHEMA_API
310  UsdAttribute GetVelocityFilterTimeConstantAttr() const;
311 
317  PHYSXSCHEMA_API
318  UsdAttribute CreateVelocityFilterTimeConstantAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
319 
320 public:
321  // --------------------------------------------------------------------- //
322  // ROTATIONFILTERTIMECONSTANT
323  // --------------------------------------------------------------------- //
331  PHYSXSCHEMA_API
332  UsdAttribute GetRotationFilterTimeConstantAttr() const;
333 
339  PHYSXSCHEMA_API
340  UsdAttribute CreateRotationFilterTimeConstantAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
341 
342 public:
343  // --------------------------------------------------------------------- //
344  // POSITIONOFFSET
345  // --------------------------------------------------------------------- //
353  PHYSXSCHEMA_API
354  UsdAttribute GetPositionOffsetAttr() const;
355 
361  PHYSXSCHEMA_API
362  UsdAttribute CreatePositionOffsetAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
363 
364 public:
365  // ===================================================================== //
366  // Feel free to add custom code below this line, it will be preserved by
367  // the code generator.
368  //
369  // Just remember to:
370  // - Close the class declaration with };
371  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
372  // - Close the include guard with #endif
373  // ===================================================================== //
374  // --(BEGIN CUSTOM CODE)--
375 };
376 
377 PXR_NAMESPACE_CLOSE_SCOPE
378 
379 #endif
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 CreateMaxDistanceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMaxDistanceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateHorizontalVelocityGainAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetHorizontalVelocityGainAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Creat...
PHYSXSCHEMA_API UsdAttribute GetFollowDistanceAttr() const
The distance from the subject that the drone attempts to maintain.
PHYSXSCHEMA_API UsdAttribute GetRotationFilterTimeConstantAttr() const
The angular velocity of the drone is filtered to make it appear as if it is accelerating.
PHYSXSCHEMA_API UsdAttribute GetVerticalVelocityGainAttr() const
The higher the gain, the higher the climb or descent rate of the drone to get to the target altitude...
PHYSXSCHEMA_API UsdAttribute GetVelocityFilterTimeConstantAttr() const
The velocity of the drone is filtered to make it appear as if it is accelerating. ...
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
PHYSXSCHEMA_API UsdAttribute GetMaxSpeedAttr() const
The maximum speed the drone is allowed to move.
PHYSXSCHEMA_API UsdAttribute GetMaxDistanceAttr() const
The maximum distance allowed from the subject before the drone resets to the target position...
PHYSXSCHEMA_API UsdAttribute GetPositionOffsetAttr() const
An offset vector from the subject origin at which the drone looks.
PHYSXSCHEMA_API UsdAttribute CreateRotationFilterTimeConstantAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRotationFilterTimeConstantAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs C...
PHYSXSCHEMA_API UsdAttribute CreateVerticalVelocityGainAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetVerticalVelocityGainAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PhysX drone camera that follows its subject from the air as it drives.
PHYSXSCHEMA_API UsdAttribute CreateFollowDistanceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFollowDistanceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetFeedForwardVelocityGainAttr() const
The higher the gain, the more closely the drone will match the velocity of the subject and the more c...
PHYSXSCHEMA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
PHYSXSCHEMA_API UsdAttribute CreateMaxSpeedAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMaxSpeedAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute GetFollowHeightAttr() const
The height above the subject that the drone attmepts to maintain.
PHYSXSCHEMA_API UsdAttribute GetHorizontalVelocityGainAttr() const
The higher the gain, the faster the drone will accelerate towards the target position.
PhysxSchemaPhysxCameraDroneAPI(const UsdSchemaBase &schemaObj)
Construct a PhysxSchemaPhysxCameraDroneAPI on the prim held by schemaObj .
static PHYSXSCHEMA_API PhysxSchemaPhysxCameraDroneAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a PhysxSchemaPhysxCameraDroneAPI holding the prim adhering to this schema at path on stage...
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxCameraDroneAPI()
Destructor.
PHYSXSCHEMA_API UsdAttribute CreateFeedForwardVelocityGainAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFeedForwardVelocityGainAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Crea...
PhysxSchemaPhysxCameraDroneAPI(const UsdPrim &prim=UsdPrim())
Construct a PhysxSchemaPhysxCameraDroneAPI on UsdPrim prim .
PHYSXSCHEMA_API UsdAttribute CreatePositionOffsetAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPositionOffsetAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateFollowHeightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFollowHeightAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create...
PHYSXSCHEMA_API UsdAttribute CreateVelocityFilterTimeConstantAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetVelocityFilterTimeConstantAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs C...
static PHYSXSCHEMA_API PhysxSchemaPhysxCameraDroneAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.