Struct grafen::surface::Cylinder

pub struct Cylinder {
    pub name: Option<String>,
    pub residue: Option<Residue>,
    pub lattice: LatticeType,
    pub alignment: Direction,
    pub cap: Option<CylinderCap>,
    pub origin: Coord,
    pub radius: f64,
    pub height: f64,
    pub coords: Vec<Coord>,
}

A 2D cylindrical surface.

Fields

name: Option<String>

Name of cylinder in database.

residue: Option<Residue>

Optional residue placed at each coordinate. If not set the cylinder describes a general collection of coordinates.

lattice: LatticeType

lattice type used to construct the cylinder surface structure.

alignment: Direction

The axis along which the cylinder is aligned.

cap: Option<CylinderCap>

Cylinders can be capped at its ends.

origin: Coord

Origin of the cylinder. Located in the center of the bottom.

radius: f64

Radius of cylinder.

height: f64

Height of cylinder.

coords: Vec<Coord>

List of coordinates belonging to the cylinder. Relative to the `origin.

Methods

impl Cylinder

fn construct(self) -> Result<Cylinder>

Construct the cylinder coordinates and return the object.

Errors

Returns an error if either the radius or height is non-positive.

Trait Implementations

impl<'a> Component<'a> for Cylinder

fn box_size(&self) -> Coord

Return the size of the object's bounding box seen from origo.

fn iter_atoms(&self) -> AtomIterItem

Return an Iterator over all atoms in the object as CurrentAtom objects.

fn num_atoms(&self) -> u64

Return the number of atoms in the object.

fn with_pbc(self) -> Self

Return the component with its coordinates adjusted to lie within its box.

impl Translate for Cylinder

fn translate(self, coord: Coord) -> Self

Translate the object by an input Coord.

fn translate_in_place(&mut self, coord: Coord)

Translate the object by an input Coord in-place.

impl Clone for Cylinder

fn clone(&self) -> Cylinder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cylinder

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Describe for Cylinder

fn describe(&self) -> String

Return a descriptive String of the object.

fn describe_short(&self) -> String

Return a very short descriptive String of the object. Typically just a name or type.