SceneModule Overview
SceneModule Overview
Plane

Plane

The Plane class describes a plane.

Inherits From : SceneObjectBase

Properties

PropertyDescription
height
(get) height: ScalarSignal
(set) height: ScalarSignal


Specifies the vertical size, in 3D units.
material
(get) material: MaterialBase | null
(set) material: MaterialBase | null


Specifies the material of the scene object.
width
(get) width: ScalarSignal
(set) width: ScalarSignal


Specifies the horizontal size, in 3D units.
x
(get) x: ScalarSignal
(set) x: ScalarSignal


Specifies the horizontal offset, in 3D units.
y
(get) y: ScalarSignal
(set) y: ScalarSignal


Specifies the vertical offset, in 3D units.

Methods

MethodDescription
getMaterial
getMaterial(): Promise<MaterialBase | null>


Returns a promise that is resolved with the material associated with a given scene object or null if no material was assigned.

Was this article helpful?