objc2-ar-kit 0.3.2

Bindings to the ARKit framework
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ptr::NonNull;
#[cfg(feature = "objc2")]
use objc2::__framework_prelude::*;

use crate::*;

/// A value describing the target of a ray used for raycasting.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/arkit/arraycasttarget?language=objc)
// NS_ENUM
#[cfg(feature = "objc2")]
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct ARRaycastTarget(pub NSInteger);
#[cfg(feature = "objc2")]
impl ARRaycastTarget {
    /// Ray's target is an already detected plane, considering the plane's estimated size and shape.
    #[doc(alias = "ARRaycastTargetExistingPlaneGeometry")]
    pub const ExistingPlaneGeometry: Self = Self(0);
    /// Ray's target is an already detected plane, without considering the plane's size.
    #[doc(alias = "ARRaycastTargetExistingPlaneInfinite")]
    pub const ExistingPlaneInfinite: Self = Self(1);
    /// Ray's target is a plane that is estimated using the feature points around the ray.
    /// When alignment is ARRaycastTargetAlignmentAny, alignment of estimated planes is based on the normal of the real world
    /// surface corresponding to the estimated plane.
    #[doc(alias = "ARRaycastTargetEstimatedPlane")]
    pub const EstimatedPlane: Self = Self(2);
}

#[cfg(feature = "objc2")]
unsafe impl Encode for ARRaycastTarget {
    const ENCODING: Encoding = NSInteger::ENCODING;
}

#[cfg(feature = "objc2")]
unsafe impl RefEncode for ARRaycastTarget {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

/// A value describing the alignment of a target.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/arkit/arraycasttargetalignment?language=objc)
// NS_ENUM
#[cfg(feature = "objc2")]
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct ARRaycastTargetAlignment(pub NSInteger);
#[cfg(feature = "objc2")]
impl ARRaycastTargetAlignment {
    /// A target that is horizontal with respect to gravity.
    #[doc(alias = "ARRaycastTargetAlignmentHorizontal")]
    pub const Horizontal: Self = Self(0);
    /// A target that is vertical with respect to gravity.
    #[doc(alias = "ARRaycastTargetAlignmentVertical")]
    pub const Vertical: Self = Self(1);
    /// A target that is in any alignment, inclusive of horizontal and vertical.
    #[doc(alias = "ARRaycastTargetAlignmentAny")]
    pub const Any: Self = Self(2);
}

#[cfg(feature = "objc2")]
unsafe impl Encode for ARRaycastTargetAlignment {
    const ENCODING: Encoding = NSInteger::ENCODING;
}

#[cfg(feature = "objc2")]
unsafe impl RefEncode for ARRaycastTargetAlignment {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

#[cfg(feature = "objc2")]
extern_class!(
    /// Representation of a ray and its target which is used for raycasting.
    ///
    /// Represents a 3D ray and its target which is used to perform raycasting.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/arkit/arraycastquery?language=objc)
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    #[cfg(feature = "objc2")]
    pub struct ARRaycastQuery;
);

#[cfg(feature = "objc2")]
extern_conformance!(
    unsafe impl NSObjectProtocol for ARRaycastQuery {}
);

#[cfg(feature = "objc2")]
impl ARRaycastQuery {
    extern_methods!(
        /// Type of target where the ray should terminate.
        #[unsafe(method(target))]
        #[unsafe(method_family = none)]
        pub unsafe fn target(&self) -> ARRaycastTarget;

        /// The alignment of the target that should be considered for raycasting.
        #[unsafe(method(targetAlignment))]
        #[unsafe(method_family = none)]
        pub unsafe fn targetAlignment(&self) -> ARRaycastTargetAlignment;

        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new(&self) -> Retained<Self>;
    );
}

/// Methods declared on superclass `NSObject`.
#[cfg(feature = "objc2")]
impl ARRaycastQuery {
    extern_methods!(
        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new_class() -> Retained<Self>;
    );
}