Plane

Draws a flat rectangle — the workhorse surface — oriented perpendicular to any axis, for grounds, walls, and displacement fields.

Declarative element: <sk-plane>

Global: available as sk.Plane inside a scene <script>.

Remarks

This is a member of the AbstractMeshNode geometry-primitive family: a solid, renderable shape you position, paint, and animate like any scene node. It is the shape to reach for whenever you need a floor, a backdrop wall, or a subdividable sheet to deform.

Key attributes. width and height are the two in-plane dimensions and are both animatable — a plane can stretch or grow. They are named orientation-relative, so they read correctly whatever the orientation: that attribute picks which axis the plane faces (+x, -x, +y, -y, +z, -z), so a +y plane is a ground and a +z plane is a wall. width-segments and height-segments subdivide each axis — raise them to give wave or deformation effects a grid to bend. Because a plane is flat it is double-sided by default (cull-mode="none"), so it shows from both faces.

Related. Give it appearance with a sk-surface-paint (fills the face) or an sk-edge-paint (draws the wireframe), each naming a sk-plain-material. It sits alongside the other flat and boxy primitives — sk-disc, sk-cube — and, like every mesh, can supply clone positions to a sk-cloner.

Constructor

constructor(config?: { width?: number; height?: number; widthSegments?: number; heightSegments?: number; orientation?: AxisOrientation; includeQuadDiagonals?: boolean; cullMode?: CullMode; overlay?: boolean; overlayOccludedOpacity?: number; id?: string; x?: number; y?: number; z?: number; h?: number; p?: number; b?: number; quaternion?: Quaternion; sx?: number; sy?: number; sz?: number; s?: number; class?: string; style?: string })

Inherited from: AbstractMeshNode, RenderableNode, SceneNode, SkenraAnimatable — see those pages for inherited members.

Properties

Config Properties

Other Properties

Methods

Example

// Create a horizontal ground plane with default parameters
const ground = new Plane({ id: 'ground' });

// Create a square plane with subdivisions
const square = new Plane({ id: 'square', width: 10, height: 10, widthSegments: 8, heightSegments: 8 });

// Create a rectangular plane with per-axis control
const rect = new Plane({
    id: 'rect',
    width: 20,
    height: 5,
    widthSegments: 40,
    heightSegments: 10
});

// Create a vertical wall (perpendicular to +Z)
const wall = new Plane({ id: 'wall', width: 5, height: 5, orientation: '+z' });

Used in guides: Scene basics

↑ Documentation home · ← All classes