Contents

PortalFactory.Style.plane(width:height:radius:)

A flat or curved planar portal.

Declaration

case plane(width: Float, height: Float, radius: Float = 0.0)

Parameters

  • width:

    The width of the portal plane in meters. Must be positive.

  • height:

    The height of the portal plane in meters. Must be positive.

  • radius:

    The radius of curvature. Zero creates a flat plane (default), positive values create a cylindrical curved portal. Must be non-negative.

Discussion

Creates a rectangular portal that can be flat or curved into a cylindrical shape. The portal surface uses a plane mesh generated with MeshResource.generatePlane.

Coordinate Space

The portal plane is positioned at the entity’s local origin [0, 0, 0] with a normal facing the positive Z direction [0, 0, 1].