Flutter Engine
The Flutter Engine
Typedefs | Functions
Point

Typedefs

typedef struct ArPoint_ ArPoint
 

Functions

 AR_DEFINE_ENUM (ArPointOrientationMode)
 
void ArPoint_getPose (const ArSession *session, const ArPoint *point, ArPose *out_pose)
 
void ArPoint_getOrientationMode (const ArSession *session, const ArPoint *point, ArPointOrientationMode *out_orientation_mode)
 

Detailed Description

Represents a point in space that ARCore is tracking.

Typedef Documentation

◆ ArPoint

typedef struct ArPoint_ ArPoint

An arbitrary point in space (reference type, long-lived).

Trackable type: #AR_TRACKABLE_POINT
Release with: ArTrackable_release()

Definition at line 297 of file arcore_c_api.h.

Function Documentation

◆ AR_DEFINE_ENUM()

AR_DEFINE_ENUM ( ArPointOrientationMode  )

Indicates the orientation mode of the ArPoint.

The orientation of the ArPoint is initialized to identity but may adjust slightly over time.

The orientation of the ArPoint will follow the behavior described in ArHitResult_getHitPose().

Definition at line 761 of file arcore_c_api.h.

761 {
762 /// The orientation of the ::ArPoint is initialized to identity but may
763 /// adjust slightly over time.
764 AR_POINT_ORIENTATION_INITIALIZED_TO_IDENTITY = 0,
765 /// The orientation of the ::ArPoint will follow the behavior described in
766 /// ArHitResult_getHitPose().
767 AR_POINT_ORIENTATION_ESTIMATED_SURFACE_NORMAL = 1};

◆ ArPoint_getOrientationMode()

void ArPoint_getOrientationMode ( const ArSession session,
const ArPoint point,
ArPointOrientationMode *  out_orientation_mode 
)

Returns the OrientationMode of the point. For Point objects created by ArFrame_hitTest(). If OrientationMode is ESTIMATED_SURFACE_NORMAL, then normal of the surface centered around the ArPoint was estimated succesfully.

Parameters
[in]sessionThe ARCore session.
[in]pointThe point to retrieve the pose of.
[in,out]out_orientation_modeOrientationMode output result for the the point.

◆ ArPoint_getPose()

void ArPoint_getPose ( const ArSession session,
const ArPoint point,
ArPose out_pose 
)

Returns the pose of the point. If ArPoint_getOrientationMode() returns ESTIMATED_SURFACE_NORMAL, the orientation will follow the behavior described in ArHitResult_getHitPose(). If ArPoint_getOrientationMode() returns INITIALIZED_TO_IDENTITY, then returns an orientation that is identity or close to identity.

Parameters
[in]sessionThe ARCore session.
[in]pointThe point to retrieve the pose of.
[in,out]out_poseAn already-allocated ArPose object into which the pose will be stored.