definePlane

Fully qualified name: usdex::core::definePlane

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

pxr::UsdStagePtr stage,

const pxr::SdfPath &path,

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.

Defines a plane centered at the origin. The normal vector direction can be specified using axis as ‘X’, ‘Y’, or ‘Z’.

While the width and length specify limits for rendering/visualization, it is common to consider the plane as infinite when used as a physics collision in simulation.

Parameters:

• stage – The stage on which to define the plane

• path – The absolute prim path at 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