defineCapsule

Fully qualified name: usdex::core::defineCapsule

pxr::UsdGeomCapsule usdex::core::defineCapsule(

pxr::UsdPrim prim,

const double radius = 1.0,

const double height = 2.0,

const pxr::TfToken axis = pxr::UsdGeomTokens->z,

const std::optional<pxr::GfVec3f> displayColor = std::nullopt,

const std::optional<float> displayOpacity = std::nullopt,

)

Defines a capsule primitive from an existing prim.

This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts.

Parameters:

• prim – Prim below which to define the capsule

• radius – The radius of the capsule

• height – The height of the capsule shaft, excluding the end caps

• axis – The axis of the capsule

• displayColor – Values to be authored for the display color

• displayOpacity – Values to be authored for the display opacity

Returns:

UsdGeomCapsule schema wrapping the defined UsdPrim