Enum ncollide3d::bounding_volume::CircularCone

[−] Show declaration

pub enum CircularCone<N: RealField> {
    Full,
    Empty,
    Spread {
        axis: Unit<Vector<N>>,
        angle: N,
    },
}

[−] Expand description

A cone with a circular basis and its apex at the origin.

A circular cone is a set of half-lines emanating from its apex and forming an angle of at most angle with its axis. It is usually used to bound a set of directions like normals and tangents. It is convex and have a circular basis.

Variants

Full

[−] Expand description

A cone which is the whole space.

Empty

[−] Expand description

An empty cone containing only the zero vector.

Spread

[−] Expand description

All the vectors emanating from the origin, with a maximal angle wrt the given axis.

[−] Show fields

Fields of Spread

axis: Unit<Vector<N>>

The cone axis.

angle: N

Half of the cone apex angle, i.e., the largest angle possible between the axis and a vector contained by this cone.

Methods

impl<N: RealField> CircularCone<N>[−]

pub fn from_vectors(dirs: &[Unit<Vector<N>>]) -> Self[−]

Creates a circular cone from a set of vectors.

pub fn is_empty(&self) -> bool[−]

Returns true if this cone is empty.

pub fn push(&mut self, dir: Unit<Vector<N>>)[−]

Enlarge this cone so it contains dir too.

pub fn intersects(&self, other: &Self) -> bool[−]

Returns true if this cone intersects other.

pub fn double_cones_intersect(&self, other: &Self) -> bool[−]

Tests if this circular cone, extended to be a double cone, intersects the other circular cone, also seen as a double cone.

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

Returns true if this cone contains other.

pub fn merge(&mut self, other: &Self)[−]

Merges this cone with other in-place.

pub fn merged(&self, other: &Self) -> Self[−]

Merges this cone with other.

Trait Implementations

impl<N: Clone + RealField> Clone for CircularCone<N>[+]

[+] Show hidden undocumented items

fn clone(&self) -> CircularCone<N>[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl<N: Copy + RealField> Copy for CircularCone<N>

impl<N: Debug + RealField> Debug for CircularCone<N>[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl<N: Eq + RealField> Eq for CircularCone<N>

impl<N: PartialEq + RealField> PartialEq<CircularCone<N>> for CircularCone<N>[+]

[+] Show hidden undocumented items

fn eq(&self, other: &CircularCone<N>) -> bool[−]

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

fn ne(&self, other: &CircularCone<N>) -> bool[−]

This method tests for !=.

impl<N: RealField> StructuralEq for CircularCone<N>

impl<N: RealField> StructuralPartialEq for CircularCone<N>