PlaneFinderBehaviour Class Reference

This component provides convenience functionality for typical use cases of detecting a plane and showing a preview of where content would be placed on that plane. Can also be used to perform manual hit tests. More...

Inheritance diagram for PlaneFinderBehaviour:

Public Member Functions
void	PerformHitTest (Vector2 screenPosition)
	Perform a manual hit test at the position in screen space. The OnInteractiveHitTest event is triggered if a hit test result is available.

Public Attributes
float	Height = 1.4f
	The assumed real world height of the camera in meters.
HitTestEvent	OnAutomaticHitTest
	Triggered on an automatic hit test.
HitTestEvent	OnInteractiveHitTest
	Triggered on an interactive hit test.
GameObject	PlaneIndicator
	The GameObject that is shown where a point on a plane is detected.

Properties
HitTestMode	HitTestMode [get, set]
	The currently set HitTestMode.

Detailed Description

This component provides convenience functionality for typical use cases of detecting a plane and showing a preview of where content would be placed on that plane. Can also be used to perform manual hit tests.

Member Function Documentation

PerformHitTest()

void PerformHitTest ( Vector2 screenPosition )

inline

Perform a manual hit test at the position in screen space. The OnInteractiveHitTest event is triggered if a hit test result is available.

Parameters

screenPosition

Screen space position

Member Data Documentation

Height

float Height = 1.4f

The assumed real world height of the camera in meters.

OnAutomaticHitTest

HitTestEvent OnAutomaticHitTest

Triggered on an automatic hit test.

OnInteractiveHitTest

HitTestEvent OnInteractiveHitTest

Triggered on an interactive hit test.

PlaneIndicator

GameObject PlaneIndicator

The GameObject that is shown where a point on a plane is detected.

Property Documentation

HitTestMode

HitTestMode HitTestMode

getset

The currently set HitTestMode.