PhysX drone camera that follows its subject from the air as it drives. More...
Public Member Functions | |
PhysxSchemaPhysxCameraDroneAPI (const UsdPrim &prim=UsdPrim()) | |
Construct a PhysxSchemaPhysxCameraDroneAPI on UsdPrim prim . More... | |
PhysxSchemaPhysxCameraDroneAPI (const UsdSchemaBase &schemaObj) | |
Construct a PhysxSchemaPhysxCameraDroneAPI on the prim held by schemaObj . More... | |
virtual PHYSXSCHEMA_API | ~PhysxSchemaPhysxCameraDroneAPI () |
Destructor. More... | |
PHYSXSCHEMA_API UsdAttribute | GetFollowHeightAttr () const |
The height above the subject that the drone attmepts to maintain. More... | |
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. More... | |
PHYSXSCHEMA_API UsdAttribute | GetFollowDistanceAttr () const |
The distance from the subject that the drone attempts to maintain. More... | |
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. More... | |
PHYSXSCHEMA_API UsdAttribute | GetMaxDistanceAttr () const |
The maximum distance allowed from the subject before the drone resets to the target position. More... | |
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. More... | |
PHYSXSCHEMA_API UsdAttribute | GetMaxSpeedAttr () const |
The maximum speed the drone is allowed to move. More... | |
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. More... | |
PHYSXSCHEMA_API UsdAttribute | GetHorizontalVelocityGainAttr () const |
The higher the gain, the faster the drone will accelerate towards the target position. More... | |
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 Create. More... | |
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. More... | |
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. More... | |
PHYSXSCHEMA_API UsdAttribute | GetFeedForwardVelocityGainAttr () const |
The higher the gain, the more closely the drone will match the velocity of the subject and the more connected it will appear. More... | |
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 Create. More... | |
PHYSXSCHEMA_API UsdAttribute | GetVelocityFilterTimeConstantAttr () const |
The velocity of the drone is filtered to make it appear as if it is accelerating. More... | |
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 Create. More... | |
PHYSXSCHEMA_API UsdAttribute | GetRotationFilterTimeConstantAttr () const |
The angular velocity of the drone is filtered to make it appear as if it is accelerating. More... | |
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 Create. More... | |
PHYSXSCHEMA_API UsdAttribute | GetPositionOffsetAttr () const |
An offset vector from the subject origin at which the drone looks. More... | |
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. More... | |
Public Member Functions inherited from PhysxSchemaPhysxCameraAPI | |
PhysxSchemaPhysxCameraAPI (const UsdPrim &prim=UsdPrim()) | |
Construct a PhysxSchemaPhysxCameraAPI on UsdPrim prim . More... | |
PhysxSchemaPhysxCameraAPI (const UsdSchemaBase &schemaObj) | |
Construct a PhysxSchemaPhysxCameraAPI on the prim held by schemaObj . More... | |
virtual PHYSXSCHEMA_API | ~PhysxSchemaPhysxCameraAPI () |
Destructor. More... | |
PHYSXSCHEMA_API UsdRelationship | GetPhysxCameraSubjectRel () const |
Reference to the subject this camera is to track. More... | |
PHYSXSCHEMA_API UsdRelationship | CreatePhysxCameraSubjectRel () const |
See GetPhysxCameraSubjectRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More... | |
Static Public Member Functions | |
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 classes. More... | |
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 . More... | |
static PHYSXSCHEMA_API PhysxSchemaPhysxCameraDroneAPI | Apply (const UsdPrim &prim) |
Applies this single-apply API schema to the given prim . More... | |
Static Public Member Functions inherited from PhysxSchemaPhysxCameraAPI | |
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 classes. More... | |
static PHYSXSCHEMA_API PhysxSchemaPhysxCameraAPI | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a PhysxSchemaPhysxCameraAPI holding the prim adhering to this schema at path on stage . More... | |
static PHYSXSCHEMA_API PhysxSchemaPhysxCameraAPI | Apply (const UsdPrim &prim) |
Applies this single-apply API schema to the given prim . More... | |
Static Public Attributes | |
static const UsdSchemaType | schemaType = UsdSchemaType::SingleApplyAPI |
Compile time constant representing what kind of schema this class is. More... | |
Static Public Attributes inherited from PhysxSchemaPhysxCameraAPI | |
static const UsdSchemaType | schemaType = UsdSchemaType::SingleApplyAPI |
Compile time constant representing what kind of schema this class is. More... | |
Protected Member Functions | |
PHYSXSCHEMA_API UsdSchemaType | _GetSchemaType () const override |
Returns the type of schema this class belongs to. More... | |
Protected Member Functions inherited from PhysxSchemaPhysxCameraAPI | |
PHYSXSCHEMA_API UsdSchemaType | _GetSchemaType () const override |
Returns the type of schema this class belongs to. More... | |
Friends | |
class | UsdSchemaRegistry |
PhysX drone camera that follows its subject from the air as it drives.
Definition at line 57 of file physxCameraDroneAPI.h.
|
inlineexplicit |
Construct a PhysxSchemaPhysxCameraDroneAPI on UsdPrim prim
.
Equivalent to PhysxSchemaPhysxCameraDroneAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim
, but will not immediately throw an error for an invalid prim
Definition at line 69 of file physxCameraDroneAPI.h.
|
inlineexplicit |
Construct a PhysxSchemaPhysxCameraDroneAPI on the prim held by schemaObj
.
Should be preferred over PhysxSchemaPhysxCameraDroneAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.
Definition at line 77 of file physxCameraDroneAPI.h.
|
virtual |
Destructor.
|
overrideprotected |
Returns the type of schema this class belongs to.
|
static |
Applies this single-apply API schema to the given prim
.
This information is stored by adding "PhysxCameraDroneAPI" to the token-valued, listOp metadata apiSchemas on the prim.
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 Create.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
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.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
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.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
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 Create.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
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.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
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.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
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.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
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 Create.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
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 Create.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
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.
If specified, author defaultValue
as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely
is true
- the default for writeSparsely
is false
.
|
static |
Return a PhysxSchemaPhysxCameraDroneAPI holding the prim adhering to this schema at path
on stage
.
If no prim exists at path
on stage
, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:
PHYSXSCHEMA_API UsdAttribute GetFeedForwardVelocityGainAttr | ( | ) | const |
The higher the gain, the more closely the drone will match the velocity of the subject and the more connected it will appear.
e.g. 0.1
Declaration | float physxDroneCamera:feedForwardVelocityGain |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
PHYSXSCHEMA_API UsdAttribute GetFollowDistanceAttr | ( | ) | const |
The distance from the subject that the drone attempts to maintain.
e.g. 30 meters
Declaration | float physxDroneCamera:followDistance |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
PHYSXSCHEMA_API UsdAttribute GetFollowHeightAttr | ( | ) | const |
The height above the subject that the drone attmepts to maintain.
e.g. 15 meters
Declaration | float physxDroneCamera:followHeight |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
PHYSXSCHEMA_API UsdAttribute GetHorizontalVelocityGainAttr | ( | ) | const |
The higher the gain, the faster the drone will accelerate towards the target position.
e.g. 1.0
Declaration | float physxDroneCamera:horizontalVelocityGain |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
PHYSXSCHEMA_API UsdAttribute GetMaxDistanceAttr | ( | ) | const |
The maximum distance allowed from the subject before the drone resets to the target position.
e.g. 100 meters
Declaration | float physxDroneCamera:maxDistance |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
PHYSXSCHEMA_API UsdAttribute GetMaxSpeedAttr | ( | ) | const |
The maximum speed the drone is allowed to move.
e.g. 20.0 meters/second
Declaration | float physxDroneCamera:maxSpeed |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
PHYSXSCHEMA_API UsdAttribute GetPositionOffsetAttr | ( | ) | const |
An offset vector from the subject origin at which the drone looks.
e.g. (0.0 m, 0.0 m, 0.0 m)
Declaration | float3 physxDroneCamera:positionOffset |
C++ Type | GfVec3f |
Usd Type | SdfValueTypeNames->Float3 |
PHYSXSCHEMA_API UsdAttribute GetRotationFilterTimeConstantAttr | ( | ) | const |
The angular velocity of the drone is filtered to make it appear as if it is accelerating.
e.g. 0.2 seconds
Declaration | float physxDroneCamera:rotationFilterTimeConstant |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
|
static |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.
Does not include attributes that may be authored by custom/extended methods of the schemas involved.
PHYSXSCHEMA_API UsdAttribute GetVelocityFilterTimeConstantAttr | ( | ) | const |
The velocity of the drone is filtered to make it appear as if it is accelerating.
e.g. 1.0 seconds
Declaration | float physxDroneCamera:velocityFilterTimeConstant |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
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.
e.g. 1.0
Declaration | float physxDroneCamera:verticalVelocityGain |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 63 of file physxCameraDroneAPI.h.