definePlane

Fully qualified name: usdex::core::definePlane

pxr::UsdGeomPlane usdex::core::definePlane(

pxr::UsdPrim prim,

const double width = 2.0,

const double length = 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 plane 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 plane

• width – The width of the plane

• length – The length of the plane

• axis – The axis of the plane

• displayColor – Values to be authored for the display color

• displayOpacity – Values to be authored for the display opacity

Returns:

UsdGeomPlane schema wrapping the defined UsdPrim