Struct StructureView 

pub struct StructureView { /* private fields */ }

A zero-copy subset of a structure.

Examples

use molframe_core::structure::{Structure, StructureData};
use molframe_core::AtomSelection;

let structure = Structure::new(StructureData::empty());
let everything = structure.view();
let nothing = everything.narrow(&AtomSelection::Empty);

assert!(nothing.is_empty());
assert_eq!(everything.len(), u64::from(structure.atom_count()));

Implementations

impl StructureView

pub fn new(structure: &Structure, atoms: AtomSelection) -> StructureView

Creates a view over atoms of structure.

pub const fn selection(&self) -> &AtomSelection

The atoms this view covers.

pub fn data(&self) -> &StructureData

The structure this view is over.

pub fn len(&self) -> u64

The number of atoms covered.

pub fn is_empty(&self) -> bool

Returns true when the view covers no atoms.

pub const fn generation(&self) -> CoordinateGeneration

The generation this view was made against.

pub fn is_stale_for(&self, structure: &Structure) -> bool

Returns true when structure has moved on since this view was made.

A view of an earlier snapshot is still perfectly usable against that snapshot — it holds its own reference to it. This asks a different question: whether the view may be used to talk about the newer one.

pub fn narrow(&self, other: &AtomSelection) -> StructureView

A view of the atoms in both this view and other.

pub fn union(&self, other: &StructureView) -> StructureView

A view of the atoms in either this view or other.

pub fn intersect(&self, other: &StructureView) -> StructureView

A view of the atoms in both views.

pub fn difference(&self, other: &StructureView) -> StructureView

A view of the atoms in this view but not the other.

pub fn positions(&self, model: ModelIndex) -> impl Iterator<Item = [f32; 3]>

The positions of the covered atoms in one model.

Yields values rather than a slice: the atoms of a view are not in general contiguous, so a slice would either be a lie or a copy.

pub fn bounds(&self, model: ModelIndex) -> Aabb

The box enclosing the covered atoms in one model.

Trait Implementations

impl Clone for StructureView

fn clone(&self) -> StructureView

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StructureView

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

Formats the value using the given formatter.

impl From<StructureView> for Selection

fn from(view: StructureView) -> Self

Converts to this type from the input type.