Google ARCore Base

The base module for Google ARCore plugin.

Summary

Enumerations

EGoogleARCoreAugmentedFaceMode enum
Describes the possible modes for Augmented Face detection.
EGoogleARCoreCameraFacing enum
Describes the orientation of the selected camera relative to the device display.
EGoogleARCoreCoordinates2DType{
  Texture = 0,
  Image = 1,
  Viewport = 2
}
enum
2d coordinate systems referenced by ARCore.
EGoogleARCoreFunctionStatus{
  Success,
  Fatal,
  SessionPaused,
  NotTracking,
  ResourceExhausted,
  NotAvailable,
  InvalidType,
  IllegalState,
  Unknown
}
enum
Describes the status of most ARCore functions.
EGoogleARCoreLineTraceChannel{
  FeaturePoint = 1,
  InfinitePlane = 2,
  PlaneUsingExtent = 4,
  PlaneUsingBoundaryPolygon = 8,
  FeaturePointWithSurfaceNormal = 16,
  AugmentedImage = 32
}
enum
Describes which channel ARLineTrace will be performed on.
EGoogleARCoreTrackingFailureReason{
  None = 0,
  BadState = 1,
  InsufficientLight = 2,
  ExcessiveMotion = 3,
  InsufficientFeatures = 4
}
enum
Describes the possible tracking failure reasons in ARCore.
EGoogleARCoreTrackingState{
  Tracking = 0,
  NotTracking = 1,
  StoppedTracking = 2
}
enum
Describes the tracking state of the current ARCore session.

Enumerations

EGoogleARCoreAugmentedFaceMode

 EGoogleARCoreAugmentedFaceMode

Describes the possible modes for Augmented Face detection.

EGoogleARCoreCameraFacing

 EGoogleARCoreCameraFacing

Describes the orientation of the selected camera relative to the device display.

EGoogleARCoreCoordinates2DType

 EGoogleARCoreCoordinates2DType

2d coordinate systems referenced by ARCore.

Properties
Image

ARCore normalized pass-through camera image(for CPU usage) space with top-left (0.0f, 0.0f) and bottom-right(1.0f, 1.0f).

Texture

ARCore normalized pass-through camera texture(for GPU usage) space with top-left (0.0f, 0.0f) and bottom-right(1.0f, 1.0f).

Viewport

UE4 normalized viewport space with top-left(0,0f ,0.0f) and bottom-right(1.0f, 1.0f)

EGoogleARCoreFunctionStatus

 EGoogleARCoreFunctionStatus

Describes the status of most ARCore functions.

Properties
Fatal

Function failed due to Fatal error.

IllegalState

Function failed due to it is invoked at an illegal or inappropriate time.

InvalidType

Function failed due to the function augment has invalid type.

NotAvailable

Function failed due to ARCore session hasn't started or the requested resource isn't available yet.

NotTracking

Function failed due to ARCore session isn't in tracking state.

ResourceExhausted

Function failed due to the requested resource is exhausted.

SessionPaused

Function failed due to the session isn't running.

Success

Function returned successfully.

Unknown

Function failed with unknown reason.

EGoogleARCoreLineTraceChannel

 EGoogleARCoreLineTraceChannel

Describes which channel ARLineTrace will be performed on.

Properties
AugmentedImage

Trace against augmented images.

FeaturePoint

Trace against feature point cloud.

FeaturePointWithSurfaceNormal

Trace against feature point and attempt to estimate the normal of the surface centered around the trace hit point.

Surface normal estimation is most likely to succeed on textured surfaces and with camera motion.

InfinitePlane

Trace against the infinite plane.

PlaneUsingBoundaryPolygon

Trace against the plane using its boundary polygon.

PlaneUsingExtent

Trace against the plane using its extent.

EGoogleARCoreTrackingFailureReason

 EGoogleARCoreTrackingFailureReason

Describes the possible tracking failure reasons in ARCore.

Properties
BadState

Tracking lost due to bad internal state.

Please try restarting the AR experience. This should be seen rarely, and should be reported to and fixed by ARCore team.

ExcessiveMotion

Tracking lost due to excessive motion.

Please move device more slowly.

InsufficientFeatures

Tracking lost due to insufficient trackable features.

Please move to area with more features, such as corners, objects, surfaces with texture. Avoid blank walls and surfaces without detail.

InsufficientLight

Tracking lost due to poor lighting conditions.

Please move to a more brightly lit area

None

Tracking is working normally, or ARCore session is not currently running.

EGoogleARCoreTrackingState

 EGoogleARCoreTrackingState

Describes the tracking state of the current ARCore session.

Properties
NotTracking

Tracking is temporary lost but could recover in the future.

StoppedTracking

Tracking is lost will not recover.

Tracking

Tracking is valid.