Struct CollisionChecker

pub struct CollisionChecker {
    pub n_triangles: usize,
    pub root: BVHNode,
}

Collision checker using a Bounding Volume Hierarchy tree.

Fields

n_triangles: usize

root: BVHNode

Implementations

impl CollisionChecker

pub fn new(tri_file: &Path) -> Self

Construct a new CollisionChecker from a file of triangles or an existing list.

pub fn read_tri_file<P: AsRef<Path>>( tri_file: P, buffer_size: usize, ) -> Vec<Triangle>

Read a .tri file containing triangles.

From https://github.com/pnxenopoulos/awpy/blob/main/awpy/visibility.py#L757

Panics

Will panic if no file exists at the given path or if the file cannot be read.

pub fn build_bvh(triangles: Vec<Triangle>) -> BVHNode

Build a Bounding Volume Hierarchy tree from a list of triangles.

Panics

Will panic if not triangles were provided or a triangle centroid coordinate comparison fails.

pub fn save_to_binary(&self, filename: &Path)

Save the loaded collision checker with the BVH to a file.

Panics

Will panic if the file cannot be created or written to.

pub fn from_binary(filename: &Path) -> Self

Load a struct instance from a JSON file

Panics

Will panic if the file cannot be read or deserialized.

impl CollisionChecker

pub fn py_new( path: Option<PathBuf>, triangles: Option<Vec<Triangle>>, ) -> PyResult<Self>

Construct a new CollisionChecker from a file of triangles or an existing list.

Errors

Will return an error if both or neither of tri_file and triangles are provided.

pub fn connection_unobstructed(&self, start: Position, end: Position) -> bool

Check if the line segment between start and end is visible. Returns true if no triangle obstructs the view.

pub fn __repr__(&self) -> String

pub fn ray_triangle_intersection( ray_origin: &Position, ray_direction: &Position, triangle: &Triangle, ) -> Option<f64>

Check for ray-triangle intersection. Returns Some(distance) if intersecting; otherwise None.

Trait Implementations

impl Clone for CollisionChecker

fn clone(&self) -> CollisionChecker

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CollisionChecker

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CollisionChecker

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CollisionChecker

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

Formats the value using the given formatter.

impl IntoPy<Py<PyAny>> for CollisionChecker

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 CollisionChecker

type Target = CollisionChecker

The Python output type

type Output = Bound<'py, <CollisionChecker 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 PyClass for CollisionChecker

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for CollisionChecker

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<CollisionChecker>

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<CollisionChecker> for PyClassImplCollector<CollisionChecker>

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

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a CollisionChecker

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

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

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut CollisionChecker

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

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

impl PyMethods<CollisionChecker> for PyClassImplCollector<CollisionChecker>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for CollisionChecker

const NAME: &'static str = "VisibilityChecker"

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 CollisionChecker

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 CollisionChecker