Struct bsp_pathfinding::Portal

pub struct Portal<'a> { /* private fields */ }

Represents a surface connecting two nodes

Implementations

impl<'a> Portal<'a>

pub fn portal_ref(&self) -> PortalRef

Get the portal’s portal ref.

pub fn dst(&self) -> NodeIndex

pub fn src(&self) -> NodeIndex

Get the portal’s src.

pub fn normal(&self) -> Vec2

Returns the normal which points into the portal

pub fn face(&self) -> &Face

Get the portal’s face.

pub fn apply_margin(&self, margin: f32) -> (Vec2, Vec2)

Methods from Deref<Target = Face>

pub fn length(&self) -> f32

pub fn length_squared(&self) -> f32

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

Get the face’s vertices.

pub fn into_tuple(&self) -> (Vec2, Vec2)

pub fn normal(&self) -> Vec2

Get the face’s normal.

pub fn transform(&self, transform: Mat3) -> Self

Transforms the face

pub fn side_of(&self, p: Vec2, normal: Vec2) -> Side

Returns the side self is in respect to a point and normal

pub fn split(&self, p: Vec2, normal: Vec2) -> [Self; 2]

Splits the face around p

pub fn adjacent(&self, other: Face) -> bool

Returns true if the face is touching the other face

pub fn midpoint(&self) -> Vec2

pub fn contains(&self, other: &Self) -> bool

Returns true if other is completely contained wihtin self

pub fn dir(&self) -> Vec2

Trait Implementations

impl<'a> Clone for Portal<'a>

fn clone(&self) -> Portal<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Portal<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for Portal<'a>

type Target = Face

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> PartialEq<Portal<'a>> for Portal<'a>

fn eq(&self, other: &Portal<'a>) -> bool

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

fn ne(&self, other: &Portal<'a>) -> bool

This method tests for !=.

impl<'a> Copy for Portal<'a>

impl<'a> StructuralPartialEq for Portal<'a>