Table of Contents

Class InputFrame

Namespace
easyar

Input frame. Contains image, camera parameters, timestamp, camera transformation relative to the world coordinate system, and tracking status. Among them, camera parameters, timestamp, camera transformation relative to the world coordinate system, and tracking status are all optional, but specific algorithm components may have specific requirements for the input.

InputFrame

Methods

index

Index, an auto-increment value, different for each input frame.

int easyar_InputFrame_index(const easyar_InputFrame * This)
int index()
public int index()
fun index(): Int
- (int)index
public func index() -> Int32
public virtual int index()

Returns

Int32

image

Get image.

void easyar_InputFrame_image(const easyar_InputFrame * This, easyar_Image * * Return)
std::shared_ptr<Image> image()
public @Nonnull Image image()
fun image(): Image
- (easyar_Image *)image
public func image() -> Image
public virtual Image image()

Returns

Image

hasCameraParameters

Whether to include camera parameters.

bool easyar_InputFrame_hasCameraParameters(const easyar_InputFrame * This)
bool hasCameraParameters()
public boolean hasCameraParameters()
fun hasCameraParameters(): Boolean
- (bool)hasCameraParameters
public func hasCameraParameters() -> Bool
public virtual bool hasCameraParameters()

Returns

Boolean

cameraParameters

Get camera parameters.

void easyar_InputFrame_cameraParameters(const easyar_InputFrame * This, easyar_CameraParameters * * Return)
std::shared_ptr<CameraParameters> cameraParameters()
public @Nonnull CameraParameters cameraParameters()
fun cameraParameters(): CameraParameters
- (easyar_CameraParameters *)cameraParameters
public func cameraParameters() -> CameraParameters
public virtual CameraParameters cameraParameters()

Returns

CameraParameters

hasTemporalInformation

Whether to include time information (timestamp).

bool easyar_InputFrame_hasTemporalInformation(const easyar_InputFrame * This)
bool hasTemporalInformation()
public boolean hasTemporalInformation()
fun hasTemporalInformation(): Boolean
- (bool)hasTemporalInformation
public func hasTemporalInformation() -> Bool
public virtual bool hasTemporalInformation()

Returns

Boolean

timestamp

Timestamp. Unit is seconds.

double easyar_InputFrame_timestamp(const easyar_InputFrame * This)
double timestamp()
public double timestamp()
fun timestamp(): Double
- (double)timestamp
public func timestamp() -> Double
public virtual double timestamp()

Returns

Double

hasSpatialInformation

Whether to include spatial information (cameraTransform and trackingStatus).

bool easyar_InputFrame_hasSpatialInformation(const easyar_InputFrame * This)
bool hasSpatialInformation()
public boolean hasSpatialInformation()
fun hasSpatialInformation(): Boolean
- (bool)hasSpatialInformation
public func hasSpatialInformation() -> Bool
public virtual bool hasSpatialInformation()

Returns

Boolean

cameraTransform

Camera transformation relative to the world coordinate system. Both the camera coordinate system and the world coordinate system are right-handed coordinate systems. The origin of the camera coordinate system is the camera's optical center, the positive direction of the x-axis is to the right, the positive direction of the y-axis is upward, and the positive direction of the z-axis is the direction the light enters the camera. (The 'right' and 'up' here refer to the right and up in the camera image, which may be different from the device's natural orientation.) The data arrangement is row-major, opposite to OpenGL's column-major.

easyar_Matrix44F easyar_InputFrame_cameraTransform(const easyar_InputFrame * This)
Matrix44F cameraTransform()
public @Nonnull Matrix44F cameraTransform()
fun cameraTransform(): Matrix44F
- (easyar_Matrix44F *)cameraTransform
public func cameraTransform() -> Matrix44F
public virtual Matrix44F cameraTransform()

Returns

Matrix44F

cameraTransformType

Camera transformation type.

easyar_CameraTransformType easyar_InputFrame_cameraTransformType(const easyar_InputFrame * This)
CameraTransformType cameraTransformType()
public int cameraTransformType()
fun cameraTransformType(): Int
- (easyar_CameraTransformType)cameraTransformType
public func cameraTransformType() -> CameraTransformType
public virtual CameraTransformType cameraTransformType()

Returns

CameraTransformType

trackingStatus

Get device motion tracking status: MotionTrackingStatus .

easyar_MotionTrackingStatus easyar_InputFrame_trackingStatus(const easyar_InputFrame * This)
MotionTrackingStatus trackingStatus()
public int trackingStatus()
fun trackingStatus(): Int
- (easyar_MotionTrackingStatus)trackingStatus
public func trackingStatus() -> MotionTrackingStatus
public virtual MotionTrackingStatus trackingStatus()

Returns

MotionTrackingStatus

motion

Motion input data.

void easyar_InputFrame_motion(const easyar_InputFrame * This, easyar_OptionalOfMotionInputData * Return)
std::optional<std::shared_ptr<MotionInputData>> motion()
public @Nullable MotionInputData motion()
fun motion(): MotionInputData?
- (easyar_MotionInputData *)motion
public func motion() -> MotionInputData?
public virtual Optional<MotionInputData> motion()

Returns

Optional<MotionInputData>

tryCreate

Create.

void easyar_InputFrame_tryCreate(easyar_Image * image, easyar_CameraParameters * cameraParameters, double timestamp, easyar_Matrix44F cameraTransform, easyar_CameraTransformType cameraTransformType, easyar_MotionTrackingStatus trackingStatus, easyar_OptionalOfInputFrame * Return)
static std::optional<std::shared_ptr<InputFrame>> tryCreate(std::shared_ptr<Image> image, std::shared_ptr<CameraParameters> cameraParameters, double timestamp, Matrix44F cameraTransform, CameraTransformType cameraTransformType, MotionTrackingStatus trackingStatus)
public static @Nullable InputFrame tryCreate(@Nonnull Image image, @Nonnull CameraParameters cameraParameters, double timestamp, @Nonnull Matrix44F cameraTransform, int cameraTransformType, int trackingStatus)
companion object fun tryCreate(image: Image, cameraParameters: CameraParameters, timestamp: Double, cameraTransform: Matrix44F, cameraTransformType: Int, trackingStatus: Int): InputFrame?
+ (easyar_InputFrame *)tryCreate:(easyar_Image *)image cameraParameters:(easyar_CameraParameters *)cameraParameters timestamp:(double)timestamp cameraTransform:(easyar_Matrix44F *)cameraTransform cameraTransformType:(easyar_CameraTransformType)cameraTransformType trackingStatus:(easyar_MotionTrackingStatus)trackingStatus
public static func tryCreate(_ image: Image, _ cameraParameters: CameraParameters, _ timestamp: Double, _ cameraTransform: Matrix44F, _ cameraTransformType: CameraTransformType, _ trackingStatus: MotionTrackingStatus) -> InputFrame?
public static Optional<InputFrame> tryCreate(Image image, CameraParameters cameraParameters, double timestamp, Matrix44F cameraTransform, CameraTransformType cameraTransformType, MotionTrackingStatus trackingStatus)

Parameters

image Image
cameraParameters CameraParameters
timestamp Double
cameraTransform Matrix44F
cameraTransformType CameraTransformType
trackingStatus MotionTrackingStatus

Returns

Optional<InputFrame>

createWithImageAndCameraParametersAndTemporal

Create, contains only image, camera parameters, and timestamp.

void easyar_InputFrame_createWithImageAndCameraParametersAndTemporal(easyar_Image * image, easyar_CameraParameters * cameraParameters, double timestamp, easyar_InputFrame * * Return)
static std::shared_ptr<InputFrame> createWithImageAndCameraParametersAndTemporal(std::shared_ptr<Image> image, std::shared_ptr<CameraParameters> cameraParameters, double timestamp)
public static @Nonnull InputFrame createWithImageAndCameraParametersAndTemporal(@Nonnull Image image, @Nonnull CameraParameters cameraParameters, double timestamp)
companion object fun createWithImageAndCameraParametersAndTemporal(image: Image, cameraParameters: CameraParameters, timestamp: Double): InputFrame
+ (easyar_InputFrame *)createWithImageAndCameraParametersAndTemporal:(easyar_Image *)image cameraParameters:(easyar_CameraParameters *)cameraParameters timestamp:(double)timestamp
public static func createWithImageAndCameraParametersAndTemporal(_ image: Image, _ cameraParameters: CameraParameters, _ timestamp: Double) -> InputFrame
public static InputFrame createWithImageAndCameraParametersAndTemporal(Image image, CameraParameters cameraParameters, double timestamp)

Parameters

image Image
cameraParameters CameraParameters
timestamp Double

Returns

InputFrame

createWithImageAndCameraParameters

Create, contains only image and camera parameters. The input created by this method can only be used for CloudRecognizer , other functions will not work.

void easyar_InputFrame_createWithImageAndCameraParameters(easyar_Image * image, easyar_CameraParameters * cameraParameters, easyar_InputFrame * * Return)
static std::shared_ptr<InputFrame> createWithImageAndCameraParameters(std::shared_ptr<Image> image, std::shared_ptr<CameraParameters> cameraParameters)
public static @Nonnull InputFrame createWithImageAndCameraParameters(@Nonnull Image image, @Nonnull CameraParameters cameraParameters)
companion object fun createWithImageAndCameraParameters(image: Image, cameraParameters: CameraParameters): InputFrame
+ (easyar_InputFrame *)createWithImageAndCameraParameters:(easyar_Image *)image cameraParameters:(easyar_CameraParameters *)cameraParameters
public static func createWithImageAndCameraParameters(_ image: Image, _ cameraParameters: CameraParameters) -> InputFrame
public static InputFrame createWithImageAndCameraParameters(Image image, CameraParameters cameraParameters)

Parameters

image Image
cameraParameters CameraParameters

Returns

InputFrame

createWithImage

Create, contains only image. The input created by this method can only be used for CloudRecognizer , other functions will not work.

void easyar_InputFrame_createWithImage(easyar_Image * image, easyar_InputFrame * * Return)
static std::shared_ptr<InputFrame> createWithImage(std::shared_ptr<Image> image)
public static @Nonnull InputFrame createWithImage(@Nonnull Image image)
companion object fun createWithImage(image: Image): InputFrame
+ (easyar_InputFrame *)createWithImage:(easyar_Image *)image
public static func createWithImage(_ image: Image) -> InputFrame
public static InputFrame createWithImage(Image image)

Parameters

image Image

Returns

InputFrame