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

Represents the device, such as a phone or a digital eyewear device, of which a position is tracked enabling/disabling the Device MonoBehaviour causes the device to start/stop being tracked. More...

Inheritance diagram for DevicePoseBehaviour:
ObserverBehaviour VuforiaMonoBehaviour

Public Member Functions

void RecenterPose ()
 Recenters the device pose to the current transform of the ARCamera.
 
bool Reset ()
 Reset the device pose observer On some platforms a new world coordinate system may be created with the device's current position and orientation as the origin. On some platforms the underlying Vuforia Fusion provider may also be reset. Any internal data will be destroyed.
 
bool SetStaticMode (bool value)
 Configures the device pose for statically mounted devices, e.g. a mobile device on a tripod looking at an object.
 

Properties

bool StaticMode [get]
 Get if the device pose is set to static.
 
- Properties inherited from ObserverBehaviour
int? ID [get]
 The runtime Id of the Observer.
 
string TargetName [get]
 Name of the target of the Observer.
 
TargetStatus TargetStatus = TargetStatus.NotObserved [get]
 Current status information of the target.
 

Additional Inherited Members

- Events inherited from ObserverBehaviour
Action< ObserverBehaviourOnBehaviourDestroyed
 Triggered when this behaviour is destroyed. Can be used for script cleanup.
 
Action< ObserverBehaviour, TargetStatusOnTargetStatusChanged
 Triggered when the TargetStatus changes.
 

Detailed Description

Represents the device, such as a phone or a digital eyewear device, of which a position is tracked enabling/disabling the Device MonoBehaviour causes the device to start/stop being tracked.

Member Function Documentation

◆ RecenterPose()

void RecenterPose ( )
inline

Recenters the device pose to the current transform of the ARCamera.

◆ Reset()

bool Reset ( )
inline

Reset the device pose observer On some platforms a new world coordinate system may be created with the device's current position and orientation as the origin. On some platforms the underlying Vuforia Fusion provider may also be reset. Any internal data will be destroyed.

Returns
true if positional device tracking was reset correctly

◆ SetStaticMode()

bool SetStaticMode ( bool value)
inline

Configures the device pose for statically mounted devices, e.g. a mobile device on a tripod looking at an object.

In such a case, standard Vuforia fusion tracking will not succeed to initialize for lack of movement. This setting configures the device tracker to return static poses to stabilize tracking e.g. in case of the object being occluded. This method can be called while Vuforia is running, however, doing so will cause the device pose observer to be reset.

Parameters
valueIf static mode is enabled
Returns
True if the value could be set

Property Documentation

◆ StaticMode

bool StaticMode
get

Get if the device pose is set to static.