Struct vtkio::model::DataArrayBase

pub struct DataArrayBase<E> {
    pub name: String,
    pub elem: E,
    pub data: IOBuffer,
}

A named array of elements.

This is stored as contiguous chunks of components represening and element described by elem.

Fields

name: String

The name of the data array.

elem: E

The type of element stored by the data storage buffer.

data: IOBuffer

A contiguous typed storage buffer.

This stores the actual attribute values in an appropriately typed vector.

Implementations

impl<E> DataArrayBase<E>

pub fn scalar_type(&self) -> ScalarType

Returns the scalar data type stored by the underlying buffer.

pub fn num_elem(&self) -> usize

Returns the number of elements stored by this data array.

This is equal to self.len() / self.num_comp().

pub fn len(&self) -> usize

Returns the raw length of the underlying buffer.

This is equal to self.num_elem() * self.num_comp().

pub fn is_empty(&self) -> bool

Returns true if this data array is empty and false otherwise.

pub fn with_vec<T: ToPrimitive + 'static>(self, data: Vec<T>) -> Self

Assigns data from a Vec to this attribute.

If T is not one of the types supported by IOBuffer, then the given vector will be converted into a Vec<f64> before being assigned. This makes with_vec more forgiving than with_data.

Use this only when the type T is not known ahead of time, otherwise use with_data.

If the data was previously already set, it will be overwritten with the one given in this function.

pub fn with_buf(mut self: Self, data: IOBuffer) -> Self

Assigns data from an IOBuffer to this attribute.

If the data was previously already set, it will be overwritten with the one given in this function.

pub fn with_data(self, new_data: impl Into<IOBuffer>) -> Self

Sets the data of this data array to the given buffer.

If the data was previously already set, it will be overwritten with the one given in this function.

impl DataArrayBase<ElementType>

pub fn scalars_with_lookup(
    name: impl Into<String>,
    num_comp: u32,
    lookup_table: impl Into<String>
) -> Self

Constructs an empty scalars array with the given lookup table.

pub fn scalars(name: impl Into<String>, num_comp: u32) -> Self

Constructs an empty scalars array.

pub fn color_scalars(name: impl Into<String>, num_comp: u32) -> Self

Constructs an empty color scalars array.

pub fn lookup_table(name: impl Into<String>) -> Self

Constructs an empty lookup table.

pub fn vectors(name: impl Into<String>) -> Self

Constructs an empty vectors array.

pub fn normals(name: impl Into<String>) -> Self

Constructs an empty normals array.

pub fn tensors(name: impl Into<String>) -> Self

Constructs an empty tensors array.

pub fn tcoords(name: impl Into<String>, num_comp: u32) -> Self

Constructs an empty texture coordinates array with the given dimensionality.

pub fn new(name: impl Into<String>, num_comp: u32) -> Self

Constructs an empty generic array with the given number of components.

pub fn num_comp(&self) -> usize

Returns the number of components per element.

This is equal to self.len() / self.num_elem().

impl DataArrayBase<u32>

pub fn new(name: impl Into<String>, num_comp: u32) -> FieldArray

Constructs an empty field array with the given number of components.

pub fn num_comp(&self) -> usize

Returns the number of components per element.

This is equal to self.len() / self.num_elem().

Trait Implementations

impl<E: Clone> Clone for DataArrayBase<E>

fn clone(&self) -> DataArrayBase<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for DataArrayBase<E>

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

Formats the value using the given formatter.

impl<E: PartialEq> PartialEq<DataArrayBase<E>> for DataArrayBase<E>

fn eq(&self, other: &DataArrayBase<E>) -> bool

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

fn ne(&self, other: &DataArrayBase<E>) -> bool

This method tests for !=.

impl<E> StructuralPartialEq for DataArrayBase<E>