Enum gut::mesh::attrib::AttributeData

pub enum AttributeData {
    Direct(DirectData),
    Indirect(IndirectData),
}

Mesh attribute data.

An attribute could store attribute values directly with the corresponding mesh elements, or indirectly in a secondary storage indexed at each mesh element.

Variants

Direct(DirectData)

A direct attribute stores values located directly (and uniquely) for each mesh element.

Tuple Fields of Direct

0: DirectData

Indirect(IndirectData)

An indirect attribute stores values located on the heap an referenced using smart pointers (so non-uniquely) for each mesh element.

Additionally these values are cached in an external cache data structure to make clones cheaper and reduce memory usage.

Tuple Fields of Indirect

0: IndirectData

Implementations

impl AttributeData

pub fn is_direct(&self) -> bool

Returns true if the underlying attribute is a direct attribute and false otherwise.

pub fn is_indirect(&self) -> bool

Returns true if the underlying attribute is an indirect attribute and false otherwise.

pub fn direct_with_size<T>(n: usize, def: T) -> AttributeData where
    T: AttributeValue, 

Construct a direct attribute with a given size.

pub fn indirect_with_size<T>(n: usize, def: T) -> AttributeData where
    T: AttributeValueHash, 

Construct an indirect attribute with a given size.

pub fn direct_from_vec<T>(vec: Vec<T, Global>) -> AttributeData where
    T: AttributeValue + Default, 

Construct a direct attribute from a given Vec<T> of data reusing the space already allocated by the Vec.

pub fn indirect_from_vec<T>(
    vec: Vec<T, Global>,
    cache: &mut HashSet<Value<MaybeUninit<usize>, AttributeValueHashVTable>, RandomState, Global>
) -> AttributeData where
    T: AttributeValueHash + Default, 

Construct an indirect attribute from a given Vec<T> of data, while saving any repeated values in the given cache.

pub fn indirect_from_data(data: IndirectData) -> AttributeData

Construct an indirect attribute from a given IndirectData instance. It is assumed that the included data is already cached correctly in the associated cache.

pub fn direct_from_slice<T>(data: &[T]) -> AttributeData where
    T: AttributeValue + Default, 

Construct an attribute from a given slice of data, by copying the data.

pub fn indirect_from_slice<T>(
    data: &[T],
    cache: &mut HashSet<Value<MaybeUninit<usize>, AttributeValueHashVTable>, RandomState, Global>
) -> AttributeData where
    T: AttributeValueHash + Default, 

Construct an attribute from a given slice of data, by copying the data.

pub fn map_to<'a, O>(
    &'a self,
    direct: impl FnOnce(&'a DirectData) -> O,
    indirect: impl FnOnce(&'a IndirectData) -> O
) -> O

A utility function to map over the direct and indirect attribute variants given the two closures.

pub fn map_mut_to<'a, O>(
    &'a mut self,
    direct: impl FnOnce(&'a mut DirectData) -> O,
    indirect: impl FnOnce(&'a mut IndirectData) -> O
) -> O

A utility function to mutably map over the direct and indirect attribute variants given the two closures.

pub fn as_slice<T>(&self) -> Result<&[T], Error> where
    T: Any, 

Produce a slice to the underlying direct attribute data.

pub fn as_mut_slice<T>(&mut self) -> Result<&mut [T], Error> where
    T: Any, 

Produce a mutable slice to the underlying direct attribute data.

pub fn duplicate_empty(&self) -> AttributeData

Construct a new empty attribute with the same buffer type, default element and topology as self.

pub fn duplicate_with(
    &self,
    dup_data: impl FnOnce(&mut VecDyn<dyn HasAttributeValue + 'static>, Slice<'_, dyn HasAttributeValue + 'static>)
) -> AttributeData

Construct a new attribute with the same buffer type, default element and topology type as self.

pub fn duplicate_with_len(
    &self,
    len: usize,
    init: impl FnOnce(SliceMut<'_, AttributeValueVTable>, Slice<'_, AttributeValueVTable>)
) -> AttributeData

Construct a new attribute with the same buffer type, default element and topology type as self.

The attribute is first initialized with the default value by allocating len default elements. Then the newly created buffer is expected to be modified by the init function.

pub fn check<T>(&self) -> Result<&AttributeData, Error> where
    T: Any, 

Get the type data stored within this attribute

pub fn check_mut<T>(&mut self) -> Result<&mut AttributeData, Error> where
    T: Any, 

Get the mutable typed data stored within this attribute

pub fn iter<T>(
    &'a self
) -> Result<Box<dyn Iterator<Item = &'a T> + 'a, Global>, Error> where
    T: Any, 

Produce an iterator over the underlying data elements regardless of kind.

This incurs an additional Box deref when iterating.

pub fn direct_iter<T>(&self) -> Result<Iter<'_, T>, Error> where
    T: Any, 

Produce an iterator over the underlying data elements for a direct attribute.

pub fn indirect_iter<T>(&self) -> Result<impl Iterator<Item = &T>, Error> where
    T: Any, 

Produce an iterator over the underlying data elements for an indirect attribute.

pub fn direct_iter_mut<T>(&mut self) -> Result<IterMut<'_, T>, Error> where
    T: Any, 

Produce a mutable iterator over the underlying data elements for a direct attribute.

pub fn indirect_update_with<T>(
    &mut self,
    f: impl FnMut(usize, &Arc<T>) -> Option<Arc<T>>,
    cache: &mut HashSet<Value<MaybeUninit<usize>, AttributeValueHashVTable>, RandomState, Global>
) -> Result<&mut AttributeData, Error> where
    T: AttributeValueHash, 

Iterate over all the value in this attribute and update them as needed.

This function takes a closure which takes an index and a smart pointer to the stored value and produces an optional new value. The new value is then used to update the attribute using the provided cache.

pub fn element_type_id(&self) -> TypeId

Get the type data stored within this attribute

pub fn clone_into_vec<T>(&self) -> Result<Vec<T, Global>, Error> where
    T: AttributeValueHash, 

Convert the data stored by this attribute into a vector of the same size.

pub fn direct_clone_into_vec<T>(&self) -> Result<Vec<T, Global>, Error> where
    T: Any + Clone, 

Convert the data stored by this direct attribute into a vector of the same size.

pub fn len(&self) -> usize

Number of elements stored by this attribute. This is the same as the number of elements in the associated topology.

pub fn is_empty(&self) -> bool

Check if there are any values in this attribute.

pub fn data_slice(&self) -> Slice<'_, AttributeValueVTable>

Get a reference to the internal data as a DataSlice.

pub fn data_mut_slice(&mut self) -> SliceMut<'_, AttributeValueVTable>

Get a mutable reference to the internal data as a DataSliceMut.

pub fn indirect_data(&self) -> Result<&IndirectData, Error>

Get a reference to the internal indirect data as an HDataVec.

pub fn indirect_data_mut(&mut self) -> Result<&mut IndirectData, Error>

Get a mutable reference to the internal indirect data as an HDataVec.

pub fn direct_data(&self) -> Result<&DirectData, Error>

Get a reference to the internal direct data as a DirectData struct.

pub fn direct_data_mut(&mut self) -> Result<&mut DirectData, Error>

Get a mutable reference to the internal direct data as a DirectData struct.

pub fn into_data(self) -> VecDyn<AttributeValueVTable>

Convert this attribute into the underlying vector.

This consumes the attribute.

pub fn extend_by(&mut self, n: usize)

Extend this attribute by n elements. Effectively, this function appends the default element n number of times to this attribute.

pub fn rotate_left(&mut self, mid: usize)

Rotate this attribute in-place such that the first mid elements of the underlying buffer move to the end while the last self.len() - mid elements move to the front. After calling rotate_left, the element previously at index mid will become the first element in the slice.

pub fn rotate_right(&mut self, k: usize)

Rotate this attribute in-place such that the first self.len() - k elements of the underlying buffer move to the end while the last k elements move to the front. After calling rotate_right, the element previously at index self.len() - k will become the first element in the slice.

pub fn default_element(&self) -> ValueRef<'_, AttributeValueVTable>

Get a reference to the default element as a byte slice.

Trait Implementations

impl Clone for AttributeData

pub fn clone(&self) -> AttributeData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AttributeData

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

Formats the value using the given formatter.

impl PartialEq<AttributeData> for AttributeData

pub fn eq(&self, other: &AttributeData) -> bool

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

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

This method tests for !=.

impl StructuralPartialEq for AttributeData