Enum CircularCone

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

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

A cone which is the whole space.

Empty

An empty cone containing only the zero vector.

Spread

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

Fields

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.

Implementations

impl<N: RealField + Copy> 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 + Copy> Clone for CircularCone<N>

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: Debug + RealField + Copy> Debug for CircularCone<N>

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

Formats the value using the given formatter.

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

fn eq(&self, other: &CircularCone<N>) -> 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<N: Copy + RealField + Copy> Copy for CircularCone<N>

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

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