Struct NavArea

pub struct NavArea {
    pub area_id: u32,
    pub hull_index: u32,
    pub dynamic_attribute_flags: DynamicAttributeFlags,
    pub corners: Vec<Position>,
    pub connections: Vec<u32>,
    pub ladders_above: Vec<u32>,
    pub ladders_below: Vec<u32>,
    /* private fields */
}

A navigation area in the map.

Fields

area_id: u32

Unique ID of the area.

Only unique for a given mesh

hull_index: u32

dynamic_attribute_flags: DynamicAttributeFlags

corners: Vec<Position>

Corners of the polygon making up the area.

connections: Vec<u32>

IDs of areas this one is connected to.

Connections are not necessarily symmetric.

ladders_above: Vec<u32>

IDs of ladders above this area.

ladders_below: Vec<u32>

IDs of ladders below this area.

Implementations

impl NavArea

pub fn to_polygon_2d(&self) -> Polygon

Returns a 2D Shapely Polygon using the (x,y) of the corners.

impl NavArea

pub fn new( area_id: u32, hull_index: u32, dynamic_attribute_flags: DynamicAttributeFlags, corners: Vec<Position>, connections: Vec<u32>, ladders_above: Vec<u32>, ladders_below: Vec<u32>, ) -> Self

pub fn size(&self) -> f64

Compute the 2D polygon area (ignoring z) using the shoelace formula.

pub fn contains(&self, point: &Position) -> bool

Checks if a point is inside the area by converting to 2D.

pub fn centroid_distance(&self, point: &Position) -> f64

Trait Implementations

impl AreaLike for NavArea

fn centroid(&self) -> Position

fn requires_crouch(&self) -> bool

fn area_id(&self) -> u32

impl Clone for NavArea

fn clone(&self) -> NavArea

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NavArea

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NavArea

Custom deserialization for NavArea

Can handle a lack of the centroid and calculates it on NavArea creation.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NavArea

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

Formats the value using the given formatter.

impl IntoPy<Py<PyAny>> for NavArea

fn into_py(self, py: Python<'_>) -> PyObject

👎Deprecated since 0.23.0: IntoPy is going to be replaced by IntoPyObject. See the migration guide (https://pyo3.rs/v0.23.0/migration) for more information.

Performs the conversion.

impl<'py> IntoPyObject<'py> for NavArea

type Target = NavArea

The Python output type

type Output = Bound<'py, <NavArea as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PartialEq for NavArea

Equality is purely done through the area_id.

fn eq(&self, other: &Self) -> 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 PyClass for NavArea

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for NavArea

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<NavArea>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<NavArea> for PyClassImplCollector<NavArea>

fn new_text_signature(self) -> Option<&'static str>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a NavArea

type Holder = Option<PyRef<'py, NavArea>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a mut NavArea

type Holder = Option<PyRefMut<'py, NavArea>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<NavArea> for PyClassImplCollector<NavArea>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for NavArea

const NAME: &'static str = "NavArea"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for PyTypeInfo::type_object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for PyTypeInfo::is_type_of.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for PyTypeInfo::is_exact_type_of.

impl Serialize for NavArea

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl DerefToPyAny for NavArea