Struct objectron::objectron::ArPlaneAnchor

pub struct ArPlaneAnchor {
    pub identifier: Option<String>,
    pub transform: Vec<f32>,
    pub alignment: Option<i32>,
    pub geometry: Option<ArPlaneGeometry>,
    pub center: Option<PlaneVector>,
    pub extent: Option<PlaneVector>,
    pub classification_supported: Option<bool>,
    pub classification: Option<i32>,
    pub classification_status: Option<i32>,
}

Information about the position and orientation of a real-world flat surface.

Fields

identifier: Option<String>

The ID of the plane.

transform: Vec<f32>

4x4 row-major matrix encoding the position, orientation, and scale of the anchor relative to the world coordinate space.

alignment: Option<i32>

The general orientation of the detected plane with respect to gravity.

geometry: Option<ArPlaneGeometry>

A coarse triangle mesh representing the general shape of the detected plane.

center: Option<PlaneVector>

The center point of the plane relative to its anchor position. Although the type of this property is a 3D vector, a plane anchor is always two-dimensional, and is always positioned in only the x and z directions relative to its transform position. (That is, the y-component of this vector is always zero.)

extent: Option<PlaneVector>

The estimated width and length of the detected plane.

classification_supported: Option<bool>

A Boolean value that indicates whether plane classification is available on the current device. On devices without plane classification support, all plane anchors report a classification value of NONE and a classification_status value of UNAVAILABLE.

classification: Option<i32>

A general characterization of what kind of real-world surface the plane anchor represents.

classification_status: Option<i32>

The current state of process for classifying the plane anchor. When this property’s value is KNOWN, the classification property represents characterization of the real-world surface corresponding to the plane anchor.

Implementations

impl ArPlaneAnchor

pub fn identifier(&self) -> &str

Returns the value of identifier, or the default value if identifier is unset.

pub fn alignment(&self) -> Alignment

Returns the enum value of alignment, or the default if the field is unset or set to an invalid enum value.

pub fn set_alignment(&mut self, value: Alignment)

Sets alignment to the provided enum value.

pub fn classification_supported(&self) -> bool

Returns the value of classification_supported, or the default value if classification_supported is unset.

pub fn classification(&self) -> PlaneClassification

Returns the enum value of classification, or the default if the field is unset or set to an invalid enum value.

pub fn set_classification(&mut self, value: PlaneClassification)

Sets classification to the provided enum value.

pub fn classification_status(&self) -> PlaneClassificationStatus

Returns the enum value of classification_status, or the default if the field is unset or set to an invalid enum value.

pub fn set_classification_status(&mut self, value: PlaneClassificationStatus)

Sets classification_status to the provided enum value.

Trait Implementations

impl Clone for ArPlaneAnchor

fn clone(&self) -> ArPlaneAnchor

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ArPlaneAnchor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ArPlaneAnchor

fn default() -> Self

Returns the “default value” for a type.

impl Message for ArPlaneAnchor

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ArPlaneAnchor

fn eq(&self, other: &ArPlaneAnchor) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ArPlaneAnchor