lume/src/meshes/Plane.ts

Build next-level interactive web applications.

import {element, type ElementAttributes} from '@lume/element'
import {Mesh, type MeshAttributes} from './Mesh.js'
import {autoDefineElements} from '../LumeConfig.js'

export type PlaneAttributes = MeshAttributes

/**
 * @class Plane -
 *
 * Element: `<lume-plane>`
 *
 * Extends from `Mesh` to apply default behaviors of
 * [`plane-geometry`](../behaviors/mesh-behaviors/geometries/PlaneGeometryBehavior)
 * and
 * [`phong-material`](../behaviors/mesh-behaviors/materials/PhongMaterialBehavior).
 *
 * The dimensions of the plane are determined by the
 * [`size`](../core/Sizeable#size) of the element on `x` and `y`.
 *
 * @extends Mesh
 */
export
@element('lume-plane', autoDefineElements)
class Plane extends Mesh {
	override initialBehaviors = {geometry: 'plane', material: 'physical'}
}

declare module 'solid-js' {
	namespace JSX {
		interface IntrinsicElements {
			'lume-plane': ElementAttributes<Plane, PlaneAttributes>
		}
	}
}

declare global {
	interface HTMLElementTagNameMap {
		'lume-plane': Plane
	}
}