Struct Obb 

pub struct Obb { /* private fields */ }

Oriented bounding box with four vertices and metadata.

Implementations

impl Obb

pub fn with_vertices(self, x: [[f32; 2]; 4]) -> Self

Sets the vertices field.

Arguments

• x - The new value to be assigned

Returns

Returns Self for method chaining.

Example

let obj = Obb::default().with_vertices(value);

---

Generated by aksr - Builder pattern macro

pub fn vertices(&self) -> &[[f32; 2]; 4]

Returns a reference to the vertices field.

Example

let obj = Obb::default();
let value = obj.vertices();

---

Generated by aksr - Builder pattern macro

pub fn into_vertices(self) -> [[f32; 2]; 4]

Consumes self and returns the vertices field.

This method moves the owned value out of the struct without cloning.

Returns

Returns the owned value of type [[f32; 2]; 4].

Example

let obj = Obb::default().with_vertices(value);
let value = obj.into_vertices();
// obj is now consumed and cannot be used

---

Generated by aksr - Builder pattern macro

pub fn with_meta(self, x: InstanceMeta) -> Self

Sets the meta field.

Arguments

• x - The new value to be assigned

Returns

Returns Self for method chaining.

Example

let obj = Obb::default().with_meta(value);

---

Generated by aksr - Builder pattern macro

pub fn meta(&self) -> &InstanceMeta

Returns a reference to the meta field.

Example

let obj = Obb::default();
let value = obj.meta();

---

Generated by aksr - Builder pattern macro

pub fn into_meta(self) -> InstanceMeta

Consumes self and returns the meta field.

This method moves the owned value out of the struct without cloning.

Returns

Returns the owned value of type InstanceMeta.

Example

let obj = Obb::default().with_meta(value);
let value = obj.into_meta();
// obj is now consumed and cannot be used

---

Generated by aksr - Builder pattern macro

pub fn with_style(self, x: ObbStyle) -> Self

Sets the optional style field.

Arguments

• x - The value that will be automatically wrapped in Some

Returns

Returns Self for method chaining.

Note

The value is automatically wrapped in Some, so you don’t need to pass Some(value).

Example

let obj = Obb::default().with_style(value);

---

Generated by aksr - Builder pattern macro

pub fn style(&self) -> Option<&ObbStyle>

Returns an optional reference to the style field.

Example

let obj = Obb::default();
let value = obj.style();

---

Generated by aksr - Builder pattern macro

pub fn into_style(self) -> Option<ObbStyle>

Consumes self and returns the style field.

This method moves the owned value out of the struct without cloning.

Returns

Returns Option containing the field value, or None if the field was None.

Example

let obj = Obb::default().with_style(value);
let value = obj.into_style();

---

Generated by aksr - Builder pattern macro

pub fn take_style(&mut self) -> Option<ObbStyle>

Takes the style field, leaving None in its place.

This method moves the value out and replaces it with None, allowing you to continue using the struct.

Returns

Returns Option containing the field value, or None if the field was None.

Note

This does not require the inner type to implement Default.

Example

let mut obj = Obb::default().with_style(value);
let value = obj.take_style();
// obj.style is now None

---

Generated by aksr - Builder pattern macro

pub fn with_keypoints(self, x: &[Keypoint]) -> Self

Sets the optional keypoints field from a slice.

Arguments

• x - A slice of elements that will be automatically converted to a vector and wrapped in Some

Returns

Returns Self for method chaining.

Note

If the slice is empty, the field remains unchanged. Otherwise, it’s automatically converted to Vec and wrapped in Some.

Example

let obj = Obb::default().with_keypoints(&[item1, item2]);

---

Generated by aksr - Builder pattern macro

pub fn keypoints(&self) -> Option<&[Keypoint]>

Returns an optional slice view of the keypoints field.

Example

let obj = Obb::default();
let items = obj.keypoints();

---

Generated by aksr - Builder pattern macro

pub fn into_keypoints(self) -> Option<Vec<Keypoint>>

Consumes self and returns the keypoints field.

This method moves the owned value out of the struct without cloning.

Returns

Returns Option<Vec < Keypoint >> containing the field value, or None if the field was None.

Example

let obj = Obb::default().with_keypoints(value);
let value = obj.into_keypoints();

---

Generated by aksr - Builder pattern macro

pub fn take_keypoints(&mut self) -> Option<Vec<Keypoint>>

Takes the keypoints field, leaving None in its place.

This method moves the value out and replaces it with None, allowing you to continue using the struct.

Returns

Returns Option<Vec < Keypoint >> containing the field value, or None if the field was None.

Note

This does not require the inner type to implement Default.

Example

let mut obj = Obb::default().with_keypoints(value);
let value = obj.take_keypoints();
// obj.keypoints is now None

---

Generated by aksr - Builder pattern macro

impl Obb

pub fn with_track_id(self, track_id: usize) -> Self

pub fn track_id(&self) -> Option<usize>

pub fn with_uid(self, uid: usize) -> Self

pub fn with_id(self, id: usize) -> Self

pub fn with_name(self, name: &str) -> Self

pub fn with_confidence(self, confidence: f32) -> Self

pub fn uid(&self) -> usize

pub fn name(&self) -> Option<&str>

pub fn confidence(&self) -> Option<f32>

pub fn id(&self) -> Option<usize>

pub fn from_cxcywhd(cx: f32, cy: f32, w: f32, h: f32, d: f32) -> Self

Build from (cx, cy, width, height, degrees)

pub fn from_cxcywhr(cx: f32, cy: f32, w: f32, h: f32, r: f32) -> Self

Build from (cx, cy, width, height, radians)

pub fn coords(&self) -> &[[f32; 2]; 4]

Get the 4 vertices as slice (CCW ordered, starting from bottom-left)

pub fn is_hbb(&self) -> bool

Check if this OBB is axis-aligned (i.e., it’s actually an Hbb) Returns true if all edges are parallel to x or y axis

pub fn tlbr(&self) -> [[f32; 2]; 4]

Get [top-left, top-right, bottom-right, bottom-left] corners for Hbb Or [top, left, bottom, right] extreme points for rotated OBB

For axis-aligned rectangles (Hbb), returns 4 distinct corner points. For rotated OBB, returns extreme points (some may coincide at corners).

pub fn top(&self) -> [f32; 2]

Get the topmost point (minimum y coordinate)

pub fn left(&self) -> [f32; 2]

Get the leftmost point (minimum x coordinate)

pub fn bottom(&self) -> [f32; 2]

Get the bottommost point (maximum y coordinate)

pub fn right(&self) -> [f32; 2]

Get the rightmost point (maximum x coordinate)

pub fn to_polygon(&self) -> Polygon

Convert to Polygon with metadata

pub fn area(&self) -> f32

Calculate area directly using Shoelace formula

pub fn intersect(&self, other: &Self) -> f32

Calculate intersection area with another OBB using optimized Sutherland-Hodgman

pub fn union(&self, other: &Self) -> f32

pub fn iou(&self, other: &Self) -> f32

Trait Implementations

impl Clone for Obb

fn clone(&self) -> Obb

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Obb

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

Formats the value using the given formatter.

impl Default for Obb

fn default() -> Obb

Returns the “default value” for a type.

impl Drawable for Obb

fn draw(&self, ctx: &DrawContext<'_>, canvas: &mut RgbaImage) -> Result<()>

impl From<[[f32; 2]; 4]> for Obb

fn from(vertices: [[f32; 2]; 4]) -> Self

Converts to this type from the input type.

impl From<Obb> for [[f32; 2]; 4]

fn from(obb: Obb) -> Self

Converts to this type from the input type.

impl From<Vec<[f32; 2]>> for Obb

fn from(vertices: Vec<[f32; 2]>) -> Self

Converts to this type from the input type.

impl HasIoU for Obb

fn iou(&self, other: &Self) -> f32

Calculates IoU with another object.

impl HasScore for Obb

fn score(&self) -> f32

Returns the confidence score.

impl PartialEq for Obb

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Obb