arsceneview/io.github.sceneview.ar.scene/PlaneRenderer

PlaneRenderer

class PlaneRenderer(val engine: Engine, modelLoader: ModelLoader, materialLoader: MaterialLoader, scene: Scene)

Control rendering of ARCore planes.

Used to visualize detected planes and to control whether Renderables cast shadows on them.

Constructors

constructor(engine: Engine, modelLoader: ModelLoader, materialLoader: MaterialLoader, scene: Scene)

Types

object Companion

PlaneRendererMode

enum PlaneRendererMode : Enum<PlaneRenderer.PlaneRendererMode>

Use this enum to configure the Plane Rendering.

Properties

val engine: Engine

var isEnabled: Boolean

isShadowReceiver

var isShadowReceiver: Boolean

Control whether Renderables in the scene should cast shadows onto the planes

var isVisible: Boolean

Control visibility of plane visualization.

maxHitTestPerSecond

var maxHitTestPerSecond: Int

Decrease if you don't need a very precise position update and want to reduce frame consumption. Increase for a more accurate positioning update.

val planeMaterial: Material

Default material instance used to render the planes.

planeRendererMode

var planeRendererMode: PlaneRenderer.PlaneRendererMode

Determines how tracked planes should be visualized on the screen. Two options are available, RENDER_ALL and RENDER_TOP_MOST. To see all tracked planes which are visible to the camera set the PlaneRendererMode to RENDER_ALL. This mode eats up quite a few resources and should only be set with care. To optimize the rendering set the mode to RENDER_TOP_MOST. In that case only the top most plane visible to a camera is rendered on the screen. Especially on weaker smartphone models this improves the overall performance.

val planeTexture: Texture

lateinit var viewSize: Size

Functions

fun update(session: Session, frame: Frame)