Plane #

Plane constructs a plane-type 3D primitive in your scene.

It can be sized through dimWidth and dimHeight properties, which take numeric values measured in meters. If not specified, these props default to 1.

<Plane dimWidth={10} dimHeight={10} />

Like all 3D primitives, Plane also supports the lit, texture, and wireframe props. If lit is true, the Plane's materials are affected by scene lighting. If wireframe is true, the Plane will render in a wireframe style. If texture is specified, React VR will look up the corresponding image and use it to texture the Plane. This can be a string, an asset() call, or a require().

Props #

dimHeight?: PropTypes.number #

height of the box in meters

dimWidth?: PropTypes.number #

width of the box in meters

lit?: PropTypes.bool #

The lit property specifies if the Model will be affected by lights placed in the scene.

materialParameters?: PropTypes.object #

set material parameters in three.js

style?: style #

color color
opacity PropTypes.number

texture?: PropTypes.oneOfType([PropTypes.number, PropTypes.string, PropTypes.object]) #

texture is a string specifying the url of the texture to be used for the Plane face, this will be an http address

wireframe?: PropTypes.bool #

Specifying true for this property will cause the object to be displayed as a wireframe

You can file an issue on GitHub if you see a typo or error on this page!