usdrt::PhysxSchemaPhysxCameraDroneAPI

Defined in usdrt/scenegraph/usd/physxSchema/physxCameraDroneAPI.h

Functions

usdrt::PhysxSchemaPhysxCameraDroneAPI::Apply: 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.
usdrt::PhysxSchemaPhysxCameraDroneAPI::CreateFeedForwardVelocityGainAttr: See GetFeedForwardVelocityGainAttr() , and also Create vs Get Property Methods 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 .
usdrt::PhysxSchemaPhysxCameraDroneAPI::CreateFollowDistanceAttr: See GetFollowDistanceAttr() , and also Create vs Get Property Methods 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 .
usdrt::PhysxSchemaPhysxCameraDroneAPI::CreateFollowHeightAttr: See GetFollowHeightAttr() , and also Create vs Get Property Methods 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 .
usdrt::PhysxSchemaPhysxCameraDroneAPI::CreateHorizontalVelocityGainAttr: See GetHorizontalVelocityGainAttr() , and also Create vs Get Property Methods 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 .
usdrt::PhysxSchemaPhysxCameraDroneAPI::CreateMaxDistanceAttr: See GetMaxDistanceAttr() , and also Create vs Get Property Methods 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 .
usdrt::PhysxSchemaPhysxCameraDroneAPI::CreateMaxSpeedAttr: See GetMaxSpeedAttr() , and also Create vs Get Property Methods 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 .
usdrt::PhysxSchemaPhysxCameraDroneAPI::CreatePositionOffsetAttr: See GetPositionOffsetAttr() , and also Create vs Get Property Methods 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 .
usdrt::PhysxSchemaPhysxCameraDroneAPI::CreateRotationFilterTimeConstantAttr: See GetRotationFilterTimeConstantAttr() , and also Create vs Get Property Methods 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 .
usdrt::PhysxSchemaPhysxCameraDroneAPI::CreateVelocityFilterTimeConstantAttr: See GetVelocityFilterTimeConstantAttr() , and also Create vs Get Property Methods 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 .
usdrt::PhysxSchemaPhysxCameraDroneAPI::CreateVerticalVelocityGainAttr: See GetVerticalVelocityGainAttr() , and also Create vs Get Property Methods 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 .
usdrt::PhysxSchemaPhysxCameraDroneAPI::GetFeedForwardVelocityGainAttr: 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.
usdrt::PhysxSchemaPhysxCameraDroneAPI::GetFollowDistanceAttr: The distance from the subject that the drone attempts to maintain. e.g. 30 meters.
usdrt::PhysxSchemaPhysxCameraDroneAPI::GetFollowHeightAttr: The height above the subject that the drone attmepts to maintain. e.g. 15 meters.
usdrt::PhysxSchemaPhysxCameraDroneAPI::GetHorizontalVelocityGainAttr: The higher the gain, the faster the drone will accelerate towards the target position. e.g. 1.0.
usdrt::PhysxSchemaPhysxCameraDroneAPI::GetMaxDistanceAttr: The maximum distance allowed from the subject before the drone resets to the target position. e.g. 100 meters.
usdrt::PhysxSchemaPhysxCameraDroneAPI::GetMaxSpeedAttr: The maximum speed the drone is allowed to move. e.g. 20.0 meters/second.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::PhysxSchemaPhysxCameraDroneAPI::GetPositionOffsetAttr: An offset vector from the subject origin at which the drone looks. e.g. (0.0 m, 0.0 m, 0.0 m)
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::PhysxSchemaPhysxCameraDroneAPI::GetRotationFilterTimeConstantAttr: The angular velocity of the drone is filtered to make it appear as if it is accelerating. e.g. 0.2 seconds.
usdrt::PhysxSchemaPhysxCameraDroneAPI::GetVelocityFilterTimeConstantAttr: The velocity of the drone is filtered to make it appear as if it is accelerating. e.g. 1.0 seconds.
usdrt::PhysxSchemaPhysxCameraDroneAPI::GetVerticalVelocityGainAttr: The higher the gain, the higher the climb or descent rate of the drone to get to the target altitude. e.g. 1.0.
usdrt::PhysxSchemaPhysxCameraDroneAPI::PhysxSchemaPhysxCameraDroneAPI: Construct a PhysxSchemaPhysxCameraDroneAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxCameraDroneAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::PhysxSchemaPhysxCameraDroneAPI::PhysxSchemaPhysxCameraDroneAPI: 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 .
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::PhysxSchemaPhysxCameraDroneAPI::operator bool: Boolean operator.
usdrt::PhysxSchemaPhysxCameraDroneAPI::~PhysxSchemaPhysxCameraDroneAPI: Destructor.

Variables

usdrt::PhysxSchemaPhysxCameraDroneAPI::schemaType: Compile time constant representing what kind of schema this class is.

class PhysxSchemaPhysxCameraDroneAPI : public usdrt::UsdAPISchemaBase 

PhysX drone camera that follows its subject from the air as it drives.

Public Functions

inline explicit PhysxSchemaPhysxCameraDroneAPI(const UsdPrim &prim = UsdPrim()): 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.

inline explicit PhysxSchemaPhysxCameraDroneAPI(const UsdSchemaBase &schemaObj): Construct a PhysxSchemaPhysxCameraDroneAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxCameraDroneAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~PhysxSchemaPhysxCameraDroneAPI(): Destructor.

inline operator bool() const

Boolean operator.

Returns: Return true if the contained prim is has this api schema applied using HasAPI, and false otherwise.

inline 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

inline UsdAttribute CreateFollowHeightAttr() const: See GetFollowHeightAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateFollowDistanceAttr() const: See GetFollowDistanceAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateMaxDistanceAttr() const: See GetMaxDistanceAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateMaxSpeedAttr() const: See GetMaxSpeedAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateHorizontalVelocityGainAttr() const: See GetHorizontalVelocityGainAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateVerticalVelocityGainAttr() const: See GetVerticalVelocityGainAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateFeedForwardVelocityGainAttr() const: See GetFeedForwardVelocityGainAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateVelocityFilterTimeConstantAttr() const: See GetVelocityFilterTimeConstantAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreateRotationFilterTimeConstantAttr() const: See GetRotationFilterTimeConstantAttr(), and also Create vs Get Property Methods 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.

inline 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

inline UsdAttribute CreatePositionOffsetAttr() const: See GetPositionOffsetAttr(), and also Create vs Get Property Methods 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.

UsdPrim GetPrim() const: Return this schema object’s held prim.

SdfPath GetPath() const: Return the SdfPath to this schema object’s held prim.

Public Static Functions

static inline PhysxSchemaPhysxCameraDroneAPI Apply(const UsdPrim &prim)

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.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns: A valid PhysxSchemaPhysxCameraDroneAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxCameraDroneAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI 

Compile time constant representing what kind of schema this class is.

See also

UsdSchemaType

Protected Functions

inline const TfToken &_GetInstanceName() const

Returns the instance name of the API schema object belonging to a multiple-apply API schema.

The returned instance name will be empty for non-applied and single-apply API schemas.