All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Modules Pages
Loading...
Searching...
No Matches
World Class Reference

Provides functions to perform hit tests and create anchors in the world. More...

Public Member Functions

IEnumerable< ObserverBehaviourGetObserverBehaviours ()
 Get all the ObserverBehaviours currently in the scene.
 
IEnumerable< T > GetObserverBehaviours< T > ()
 Get all the ObserverBehaviours of type T currently in the scene.
 
IEnumerable< ObserverBehaviourGetTrackedObserverBehaviours ()
 Get all the ObserverBehaviours in the scene that are currently tracked.
 
IEnumerable< T > GetTrackedObserverBehaviours< T > ()
 Get all the ObserverBehaviours of type T in the scene that are currently tracked.
 
bool HitTest (Vector2 imageSpacePos, float defaultHeight, out HitTestResult hitTestResult)
 Perform a hit test in the world. The result is always of the first plane that is intersected with.
 

Properties

bool AnchorsSupported [get]
 Returns true if anchors and hit test are supported.
 
IlluminationData IlluminationData [get]
 Provides data on the estimated illumination values in the current frame such as illumination intensity or ambient light color temperature.
 

Events

Action< ObserverBehaviourOnObserverCreated
 Called whenever an observer is newly discovered by Vuforia. This can happen with VuMarks, CloudReco, Anchors or Barcodes.
 
Action< ObserverBehaviourOnObserverDestroyed
 Called whenever an observer tracked by Vuforia is lost. This can happen with VuMarks, CloudReco, Anchors or Barcodes.
 
Action OnStateUpdated
 Updated whenever a new state of the world has been processed.
 

Detailed Description

Provides functions to perform hit tests and create anchors in the world.

Member Function Documentation

◆ GetObserverBehaviours()

IEnumerable< ObserverBehaviour > GetObserverBehaviours ( )
inline

Get all the ObserverBehaviours currently in the scene.

Returns

◆ GetObserverBehaviours< T >()

IEnumerable< T > GetObserverBehaviours< T > ( )
inline

Get all the ObserverBehaviours of type T currently in the scene.

Template Parameters
TType of the ObserverBehaviour
Returns
Type Constraints
T :ObserverBehaviour 

◆ GetTrackedObserverBehaviours()

IEnumerable< ObserverBehaviour > GetTrackedObserverBehaviours ( )
inline

Get all the ObserverBehaviours in the scene that are currently tracked.

Returns

◆ GetTrackedObserverBehaviours< T >()

IEnumerable< T > GetTrackedObserverBehaviours< T > ( )
inline

Get all the ObserverBehaviours of type T in the scene that are currently tracked.

Template Parameters
TType of the ObserverBehaviour
Returns
Type Constraints
T :ObserverBehaviour 

◆ HitTest()

bool HitTest ( Vector2 imageSpacePos,
float defaultHeight,
out HitTestResult hitTestResult )
inline

Perform a hit test in the world. The result is always of the first plane that is intersected with.

Parameters
imageSpacePosThe 2d position of the hit test in image space
defaultHeightThe assumed height of the device whe performing the hit test is usually 1.4m
hitTestResultResult of the hit test. If an intersection with a plane was detected, it's reflected here'
Returns
True if there is a hit test result

Property Documentation

◆ AnchorsSupported

bool AnchorsSupported
get

Returns true if anchors and hit test are supported.

◆ IlluminationData

Provides data on the estimated illumination values in the current frame such as illumination intensity or ambient light color temperature.

Event Documentation

◆ OnObserverCreated

Action<ObserverBehaviour> OnObserverCreated

Called whenever an observer is newly discovered by Vuforia. This can happen with VuMarks, CloudReco, Anchors or Barcodes.

◆ OnObserverDestroyed

Action<ObserverBehaviour> OnObserverDestroyed

Called whenever an observer tracked by Vuforia is lost. This can happen with VuMarks, CloudReco, Anchors or Barcodes.

◆ OnStateUpdated

Action OnStateUpdated

Updated whenever a new state of the world has been processed.