Struct meshx::attrib::IndirectData

pub struct IndirectData { /* private fields */ }

Mesh attribute data.

This stores unique values shared among mesh elements via smart pointers. This type doesn’t store the location of the attribute.

Implementations

impl IndirectData

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

Get the type data stored within this attribute

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

Get the mutable typed data stored within this attribute

pub fn element_type_id(&self) -> TypeId

Get the type data stored within this attribute

pub fn element_size(&self) -> usize

Get the number of bytes per element stored in this attribute.

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 byte_len(&self) -> usize

Number of bytes stored by this attribute. This is the same as the number of elements multiplied by the size of each element.

pub fn is_empty(&self) -> bool

Check if there are any values in this attribute.

pub unsafe fn get_unchecked_ref<T: Any>(&self, i: usize) -> &T

Get a const reference to the i’th attribute value.

Safety

Calling this method with an out-of-bounds index is undefined behavior even if the output is not used. For a safe alternative use the get_ref method.

pub unsafe fn get_unchecked_mut<T: Any>(&mut self, i: usize) -> &mut T

Get a mutable reference to the i’th attribute value.

Safety

Calling this method with an out-of-bounds index is undefined behavior even if the output is not used. For a safe alternative use the get_mut method.

pub fn data_ref(&self) -> &HDataVec

👎Deprecated since 0.2.1: Please use data instead.

Get a reference to the internal value vector.

pub fn data(&self) -> &HDataVec

Get a reference to the internal value vector.

pub fn data_mut(&mut self) -> &mut HDataVec

Get a mutable reference to the internal value vector.

pub fn into_data(self) -> HDataVec

Convert this attribute into the underlying buffer. 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)

Rotates elements of this attribute in-place to the left.

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)

Rotates elements of this attribute in-place to the right.

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 with_size<T: AttributeValueHash>(n: usize, def: T) -> Self

Construct an attribute with a given size.

pub fn from_vec<T: AttributeValueHash + Default>( vec: Vec<T>, cache: &mut AttribValueCache ) -> Self

Construct an attribute from a given Vec<T> of data.

pub fn from_slice<T: AttributeValueHash + Default>( buf: &[T], cache: &mut AttribValueCache ) -> Self

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

pub fn duplicate_empty(&self) -> Self

Construct a new empty attribute with the same values and default element as self.

pub fn duplicate_with( &self, dup_data: impl FnOnce(HDataSlice<'_>) -> VecDyn<dyn HasAttributeValue> ) -> Self

Construct a new attribute with the same values and default element as self.

pub fn duplicate_with_len( &self, len: usize, init: impl FnOnce(HDataSliceMut<'_>, HDataSlice<'_>) ) -> Self

Construct a new attribute with the same values and default element 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. The output HDataVec must be composed of values from the original HDataVec or the default element.

The init function is only allowed to clone data from the second argument into the first. Adding new data will cause this attribute to go out of sync with the cache.

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

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

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

Produce an iterator over the underlying data elements.

pub fn update_with<T, F>( &mut self, f: F, cache: &mut AttribValueCache ) -> Result<&mut Self, Error>

where T: AttributeValueHash, F: FnMut(usize, &Irc<T>) -> Option<Irc<T>>,

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 set_at<'a, T>( &'a mut self, i: usize, new_value: T, cache: &'a mut AttribValueCache ) -> Result<&'a mut Self, Error>

where T: AttributeValueHash,

Set the value of a particular element.

pub fn set_value_at<'a>( &'a mut self, i: usize, new_value: &HValue, cache: &'a mut AttribValueCache ) -> Result<&'a mut Self, Error>

Set the value of a particular element.

pub fn push_cloned( &mut self, new_value_ref: HValueRef<'_>, cache: &mut AttribValueCache ) -> Result<&mut Self, Error>

Push a value onto the underlying data buffer.

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

Produce a slice to the underlying data referenced by smart pointers.

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

Produce a mutable slice to the underlying data referenced by smart pointers.

pub fn default_element(&self) -> HValueRef<'_>

Get a reference to the default element.

Trait Implementations

impl Clone for IndirectData

fn clone(&self) -> IndirectData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IndirectData

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

Formats the value using the given formatter.

impl PartialEq for IndirectData

fn eq(&self, other: &IndirectData) -> 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 StructuralPartialEq for IndirectData