You are reading Tres v1 docs. Head over tresjs.org for V2 docs.
Skip to content
On this page

Plane ^1.5.0

The cientos package provides a <Plane /> component that serves as a short-cut for a PlaneGeometry and a MeshBasicMaterial with a Mesh object.

typescript
args: [width: number, height: number, widthSegments: number, heightSegments: number]

Reference: PlaneGeometry

INFO

A convenient default rotation is applied to the x-axis of the plane (-Math.PI / 2), so that it is facing up (along the Y axis).

Usage

html
<Plane :args="[1, 1]" color="teal" />

// Plane with a custom material transformations
<Plane ref="planeRef" :args="[8, 8]" :position="[0, 4, 0]">
  <TresMeshToonMaterial color="teal" />
</Plane>