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 "pxr/usd/usd/apiSchemaBase.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 
57 class PhysxSchemaPhysxCameraDroneAPI : public UsdAPISchemaBase
58 {
59 public:
63  static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
64 
69  explicit PhysxSchemaPhysxCameraDroneAPI(const UsdPrim& prim=UsdPrim())
70  : UsdAPISchemaBase(prim)
71  {
72  }
73 
77  explicit PhysxSchemaPhysxCameraDroneAPI(const UsdSchemaBase& schemaObj)
78  : UsdAPISchemaBase(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 
123  PHYSXSCHEMA_API
124  static bool
125  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
126 
142  PHYSXSCHEMA_API
144  Apply(const UsdPrim &prim);
145 
146 protected:
150  PHYSXSCHEMA_API
151  UsdSchemaKind _GetSchemaKind() const override;
152 
153 private:
154  // needs to invoke _GetStaticTfType.
155  friend class UsdSchemaRegistry;
156  PHYSXSCHEMA_API
157  static const TfType &_GetStaticTfType();
158 
159  static bool _IsTypedSchema();
160 
161  // override SchemaBase virtuals.
162  PHYSXSCHEMA_API
163  const TfType &_GetTfType() const override;
164 
165 public:
166  // --------------------------------------------------------------------- //
167  // FOLLOWHEIGHT
168  // --------------------------------------------------------------------- //
176  PHYSXSCHEMA_API
177  UsdAttribute GetFollowHeightAttr() const;
178 
184  PHYSXSCHEMA_API
185  UsdAttribute CreateFollowHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
186 
187 public:
188  // --------------------------------------------------------------------- //
189  // FOLLOWDISTANCE
190  // --------------------------------------------------------------------- //
198  PHYSXSCHEMA_API
199  UsdAttribute GetFollowDistanceAttr() const;
200 
206  PHYSXSCHEMA_API
207  UsdAttribute CreateFollowDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
208 
209 public:
210  // --------------------------------------------------------------------- //
211  // MAXDISTANCE
212  // --------------------------------------------------------------------- //
220  PHYSXSCHEMA_API
221  UsdAttribute GetMaxDistanceAttr() const;
222 
228  PHYSXSCHEMA_API
229  UsdAttribute CreateMaxDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
230 
231 public:
232  // --------------------------------------------------------------------- //
233  // MAXSPEED
234  // --------------------------------------------------------------------- //
242  PHYSXSCHEMA_API
243  UsdAttribute GetMaxSpeedAttr() const;
244 
250  PHYSXSCHEMA_API
251  UsdAttribute CreateMaxSpeedAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
252 
253 public:
254  // --------------------------------------------------------------------- //
255  // HORIZONTALVELOCITYGAIN
256  // --------------------------------------------------------------------- //
264  PHYSXSCHEMA_API
265  UsdAttribute GetHorizontalVelocityGainAttr() const;
266 
272  PHYSXSCHEMA_API
273  UsdAttribute CreateHorizontalVelocityGainAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
274 
275 public:
276  // --------------------------------------------------------------------- //
277  // VERTICALVELOCITYGAIN
278  // --------------------------------------------------------------------- //
286  PHYSXSCHEMA_API
287  UsdAttribute GetVerticalVelocityGainAttr() const;
288 
294  PHYSXSCHEMA_API
295  UsdAttribute CreateVerticalVelocityGainAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
296 
297 public:
298  // --------------------------------------------------------------------- //
299  // FEEDFORWARDVELOCITYGAIN
300  // --------------------------------------------------------------------- //
308  PHYSXSCHEMA_API
309  UsdAttribute GetFeedForwardVelocityGainAttr() const;
310 
316  PHYSXSCHEMA_API
317  UsdAttribute CreateFeedForwardVelocityGainAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
318 
319 public:
320  // --------------------------------------------------------------------- //
321  // VELOCITYFILTERTIMECONSTANT
322  // --------------------------------------------------------------------- //
330  PHYSXSCHEMA_API
331  UsdAttribute GetVelocityFilterTimeConstantAttr() const;
332 
338  PHYSXSCHEMA_API
339  UsdAttribute CreateVelocityFilterTimeConstantAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
340 
341 public:
342  // --------------------------------------------------------------------- //
343  // ROTATIONFILTERTIMECONSTANT
344  // --------------------------------------------------------------------- //
352  PHYSXSCHEMA_API
353  UsdAttribute GetRotationFilterTimeConstantAttr() const;
354 
360  PHYSXSCHEMA_API
361  UsdAttribute CreateRotationFilterTimeConstantAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
362 
363 public:
364  // --------------------------------------------------------------------- //
365  // POSITIONOFFSET
366  // --------------------------------------------------------------------- //
374  PHYSXSCHEMA_API
375  UsdAttribute GetPositionOffsetAttr() const;
376 
382  PHYSXSCHEMA_API
383  UsdAttribute CreatePositionOffsetAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
384 
385 public:
386  // ===================================================================== //
387  // Feel free to add custom code below this line, it will be preserved by
388  // the code generator.
389  //
390  // Just remember to:
391  // - Close the class declaration with };
392  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
393  // - Close the include guard with #endif
394  // ===================================================================== //
395  // --(BEGIN CUSTOM CODE)--
396 };
397 
398 PXR_NAMESPACE_CLOSE_SCOPE
399 
400 #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. ...
PHYSXSCHEMA_API UsdAttribute GetMaxSpeedAttr() const
The maximum speed the drone is allowed to move.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
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...
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.
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...
PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
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.