Struct cam_geom::RayBundle

pub struct RayBundle<Coords, BType, R, NPTS, StorageMultiple>where
    Coords: CoordinateSystem,
    BType: Bundle<R>,
    R: RealField,
    NPTS: Dim,
    StorageMultiple: Storage<R, NPTS, U3>,{
    pub data: Matrix<R, NPTS, U3, StorageMultiple>,
    /* private fields */
}

3D rays. Can be in any CoordinateSystem.

Any given RayBundle will have a particular bundle type, which implements the Bundle trait.

Fields

data: Matrix<R, NPTS, U3, StorageMultiple>

The matrix storing the ray data.

Implementations

impl<Coords, BType, R, NPTS, StorageMultiple> RayBundle<Coords, BType, R, NPTS, StorageMultiple>where
    Coords: CoordinateSystem,
    BType: Bundle<R>,
    R: RealField,
    NPTS: DimName,
    StorageMultiple: Storage<R, NPTS, U3>,
    DefaultAllocator: Allocator<R, NPTS, U3>,

pub fn directions(&self) -> Matrix<R, NPTS, U3, Owned<R, NPTS, U3>>

get directions of each ray in bundle

pub fn centers(&self) -> Matrix<R, NPTS, U3, Owned<R, NPTS, U3>>

get centers (origins) of each ray in bundle

impl<Coords, BType, R> RayBundle<Coords, BType, R, U1, Owned<R, U1, U3>>where
    Coords: CoordinateSystem,
    BType: Bundle<R>,
    R: RealField,

pub fn to_single_ray(&self) -> Ray<Coords, R>

Return the single ray from the RayBundle with exactly one ray.

impl<Coords, R, NPTS, StorageMultiple> RayBundle<Coords, SharedOriginRayBundle<R>, R, NPTS, StorageMultiple>where
    Coords: CoordinateSystem,
    R: RealField,
    NPTS: Dim,
    StorageMultiple: Storage<R, NPTS, U3>,

pub fn new_shared_zero_origin(
    data: Matrix<R, NPTS, U3, StorageMultiple>
) -> Self

Create a new RayBundle instance in which all rays share origin at zero.

The number of points allocated is given by the npts parameter, which should agree with the NPTS type. The coordinate system is given by the Coords type.

impl<Coords, R, NPTS, StorageMultiple> RayBundle<Coords, SharedDirectionRayBundle<R>, R, NPTS, StorageMultiple>where
    Coords: CoordinateSystem,
    R: RealField,
    NPTS: Dim,
    StorageMultiple: Storage<R, NPTS, U3>,

pub fn new_shared_plusz_direction(
    data: Matrix<R, NPTS, U3, StorageMultiple>
) -> Self

Create a new RayBundle instance in which all rays share +z direction.

The number of points allocated is given by the npts parameter, which should agree with the NPTS type. The coordinate system is given by the Coords type.

impl<Coords, BType, R, NPTS, StorageMultiple> RayBundle<Coords, BType, R, NPTS, StorageMultiple>where
    Coords: CoordinateSystem,
    BType: Bundle<R>,
    R: RealField,
    NPTS: Dim,
    StorageMultiple: Storage<R, NPTS, U3>,

pub fn point_on_ray(&self) -> Points<Coords, R, NPTS, Owned<R, NPTS, U3>>where
    DefaultAllocator: Allocator<R, NPTS, U3>,

get a 3D point on the ray, obtained by adding the direction(s) to the origin(s)

The distance of the point from the ray bundle center is not definted and can be arbitrary.

pub fn point_on_ray_at_distance(
    &self,
    distance: R
) -> Points<Coords, R, NPTS, Owned<R, NPTS, U3>>where
    DefaultAllocator: Allocator<R, NPTS, U3>,

get a 3D point on the ray at a defined distance from the origin(s)

Trait Implementations

impl<Coords, BType, R, NPTS, StorageMultiple> Clone for RayBundle<Coords, BType, R, NPTS, StorageMultiple>where
    Coords: CoordinateSystem + Clone,
    BType: Bundle<R> + Clone,
    R: RealField + Clone,
    NPTS: Dim + Clone,
    StorageMultiple: Storage<R, NPTS, U3> + Clone,

fn clone(&self) -> RayBundle<Coords, BType, R, NPTS, StorageMultiple>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Coords, BType, R, NPTS, StorageMultiple> Debug for RayBundle<Coords, BType, R, NPTS, StorageMultiple>where
    Coords: CoordinateSystem + Debug,
    BType: Bundle<R> + Debug,
    R: RealField + Debug,
    NPTS: Dim + Debug,
    StorageMultiple: Storage<R, NPTS, U3> + Debug,

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

Formats the value using the given formatter.

impl<'de, Coords, BType, R, NPTS, StorageMultiple> Deserialize<'de> for RayBundle<Coords, BType, R, NPTS, StorageMultiple>where
    Coords: CoordinateSystem,
    BType: Bundle<R> + Deserialize<'de>,
    R: RealField + Deserialize<'de>,
    NPTS: Dim + Deserialize<'de>,
    StorageMultiple: Storage<R, NPTS, U3> + Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Coords, BType, R, NPTS, StorageMultiple> PartialEq<RayBundle<Coords, BType, R, NPTS, StorageMultiple>> for RayBundle<Coords, BType, R, NPTS, StorageMultiple>where
    Coords: CoordinateSystem + PartialEq,
    BType: Bundle<R> + PartialEq,
    R: RealField + PartialEq,
    NPTS: Dim + PartialEq,
    StorageMultiple: Storage<R, NPTS, U3> + PartialEq,

fn eq(&self, other: &RayBundle<Coords, BType, R, NPTS, StorageMultiple>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Coords, BType, R, NPTS, StorageMultiple> Serialize for RayBundle<Coords, BType, R, NPTS, StorageMultiple>where
    Coords: CoordinateSystem,
    BType: Bundle<R> + Serialize,
    R: RealField + Serialize,
    NPTS: Dim + Serialize,
    StorageMultiple: Storage<R, NPTS, U3> + Serialize,

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

Serialize this value into the given Serde serializer.

impl<Coords, BType, R, NPTS, StorageMultiple> StructuralPartialEq for RayBundle<Coords, BType, R, NPTS, StorageMultiple>where
    Coords: CoordinateSystem,
    BType: Bundle<R>,
    R: RealField,
    NPTS: Dim,
    StorageMultiple: Storage<R, NPTS, U3>,