C API Unity API
Unity API Reference (Version 10.22.5)
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:
SmartTerrainBehaviour VuforiaMonoBehaviour

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 More...
 

Public Attributes

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

Properties

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

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
screenPositionScreen 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

The currently set HitTestMode