Struct SpriteSheetFramesContainer

pub struct SpriteSheetFramesContainer<T>
where
    T: SpriteSheetTexture,
{ /* private fields */ }

Container for a sprite sheet animation frames.

Implementations

impl<T> SpriteSheetFramesContainer<T>

where T: SpriteSheetTexture,

pub const SIZE: &'static str = "size"

pub const FRAMES: &'static str = "frames"

pub const TEXTURE: &'static str = "texture"

impl<T> SpriteSheetFramesContainer<T>

where T: SpriteSheetTexture,

pub fn push( &mut self, bounds: Matrix<u32, Const<2>, Const<1>, ArrayStorage<u32, 2, 1>>, )

Adds a frame to the container.

pub fn remove( &mut self, index: usize, ) -> Matrix<u32, Const<2>, Const<1>, ArrayStorage<u32, 2, 1>>

Removes a frame from the container.

pub fn len(&self) -> usize

Returns total amount of frames in the container.

pub fn is_empty(&self) -> bool

Returns true if the container is empty, false - otherwise.

pub fn get( &self, index: usize, ) -> Option<&Matrix<u32, Const<2>, Const<1>, ArrayStorage<u32, 2, 1>>>

Tries to get a reference to a frame with given index.

pub fn set_size( &mut self, size: Matrix<u32, Const<2>, Const<1>, ArrayStorage<u32, 2, 1>>, )

Sets new container size. It does not affect frames!

pub fn size(&self) -> Matrix<u32, Const<2>, Const<1>, ArrayStorage<u32, 2, 1>>

Returns size of the container.

pub fn sort_by_position(&mut self)

Sorts frames by their position. (x,y) will be converted to index and then used for sorting. This method ensures that the frames will be ordered from the left top corner to right bottom corner line-by-line.

pub fn iter( &self, ) -> impl Iterator<Item = &Matrix<u32, Const<2>, Const<1>, ArrayStorage<u32, 2, 1>>>

Returns an iterator that yields frames position.

pub fn iter_mut( &mut self, ) -> impl Iterator<Item = &mut Matrix<u32, Const<2>, Const<1>, ArrayStorage<u32, 2, 1>>>

Returns an iterator that yields frames position.

pub fn texture(&self) -> Option<T>

Returns current texture of the container. To set a texture use sprite sheet animation methods.

Trait Implementations

impl<T> Clone for SpriteSheetFramesContainer<T>

where T: Clone + SpriteSheetTexture,

fn clone(&self) -> SpriteSheetFramesContainer<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for SpriteSheetFramesContainer<T>

where T: Debug + SpriteSheetTexture,

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

Formats the value using the given formatter.

impl<T> Default for SpriteSheetFramesContainer<T>

where T: SpriteSheetTexture,

fn default() -> SpriteSheetFramesContainer<T>

Returns the “default value” for a type.

impl<T> PartialEq for SpriteSheetFramesContainer<T>

where T: PartialEq + SpriteSheetTexture,

fn eq(&self, other: &SpriteSheetFramesContainer<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Reflect for SpriteSheetFramesContainer<T>

where T: SpriteSheetTexture, SpriteSheetFramesContainer<T>: 'static, Matrix<u32, Const<2>, Const<1>, ArrayStorage<u32, 2, 1>>: Reflect, Vec<Matrix<u32, Const<2>, Const<1>, ArrayStorage<u32, 2, 1>>>: Reflect, Option<T>: Reflect,

fn source_path() -> &'static str

fn type_name(&self) -> &'static str

fn doc(&self) -> &'static str

fn assembly_name(&self) -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn type_assembly_name() -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn fields_info(&self, func: &mut dyn FnMut(&[FieldInfo<'_, '_>]))

fn into_any(self: Box<SpriteSheetFramesContainer<T>>) -> Box<dyn Any>

fn set( &mut self, value: Box<dyn Reflect>, ) -> Result<Box<dyn Reflect>, Box<dyn Reflect>>

fn as_any(&self, func: &mut dyn FnMut(&(dyn Any + 'static)))

fn as_any_mut(&mut self, func: &mut dyn FnMut(&mut (dyn Any + 'static)))

fn as_reflect(&self, func: &mut dyn FnMut(&(dyn Reflect + 'static)))

fn as_reflect_mut(&mut self, func: &mut dyn FnMut(&mut (dyn Reflect + 'static)))

fn fields(&self, func: &mut dyn FnMut(&[&(dyn Reflect + 'static)]))

fn fields_mut( &mut self, func: &mut dyn FnMut(&mut [&mut (dyn Reflect + 'static)]), )

fn field( &self, name: &str, func: &mut dyn FnMut(Option<&(dyn Reflect + 'static)>), )

fn field_mut( &mut self, name: &str, func: &mut dyn FnMut(Option<&mut (dyn Reflect + 'static)>), )

fn set_field( &mut self, field: &str, value: Box<dyn Reflect>, func: &mut dyn FnMut(Result<Box<dyn Reflect>, Box<dyn Reflect>>), )

Calls user method specified with #[reflect(setter = ..)] or falls back to Reflect::field_mut

fn as_array(&self, func: &mut dyn FnMut(Option<&(dyn ReflectArray + 'static)>))

fn as_array_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectArray + 'static)>), )

fn as_list(&self, func: &mut dyn FnMut(Option<&(dyn ReflectList + 'static)>))

fn as_list_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectList + 'static)>), )

fn as_inheritable_variable( &self, func: &mut dyn FnMut(Option<&(dyn ReflectInheritableVariable + 'static)>), )

fn as_inheritable_variable_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectInheritableVariable + 'static)>), )

fn as_hash_map( &self, func: &mut dyn FnMut(Option<&(dyn ReflectHashMap + 'static)>), )

fn as_hash_map_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectHashMap + 'static)>), )

impl<T> Visit for SpriteSheetFramesContainer<T>

where T: SpriteSheetTexture, Matrix<u32, Const<2>, Const<1>, ArrayStorage<u32, 2, 1>>: Visit, Vec<Matrix<u32, Const<2>, Const<1>, ArrayStorage<u32, 2, 1>>>: Visit, Option<T>: Visit,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

Read or write this value, depending on whether Visitor::is_reading() is true or false.

impl<T> Eq for SpriteSheetFramesContainer<T>

where T: Eq + SpriteSheetTexture,

impl<T> StructuralPartialEq for SpriteSheetFramesContainer<T>

where T: SpriteSheetTexture,