Struct ezinput::view::InputView

source · [−]

pub struct InputView<Keys> where
    Keys: BindingTypeView,  {
    pub last_input_source: Option<InputSource>,
    pub bindings: HashMap<Keys, ActionBinding<Keys>>,
    pub descriptors: Vec<ReceiverDescriptor>,
}

Expand description

A view is a object where all input states are stored. It also has useful methods such checking if a key or axis for a BindingTypeView is pressed or released by proving the PressState.

Fields

last_input_source: Option<InputSource>bindings: HashMap<Keys, ActionBinding<Keys>>descriptors: Vec<ReceiverDescriptor>

Implementations

source

impl<Keys> InputView<Keys> where
Keys: BindingTypeView,

source

pub fn new() -> Self

Creates an empty input view with a default of 16 capacity.

source

pub fn with_capacity(capacity: usize) -> Self

Creates an empty input view with a specific capacity.

source

pub fn capacity(&self) -> usize

Returns the current capcity for this input view.

source

pub fn set_capacity(&mut self, capacity: usize)

Sets a new capacity for this input view.

source

pub fn add_descriptor(&mut self, descriptor: ReceiverDescriptor)

Add a new binding to the input view.

source

pub fn descriptor(&self, rcv: &InputReceiver) -> Option<&ReceiverDescriptor>

Get an existing descriptor.

source

pub fn descriptor_mut(
&mut self,
rcv: &InputReceiver
) -> Option<&mut ReceiverDescriptor>

Get an existing descriptor mutably.

source

pub fn descriptor_or_insert(
&mut self,
input: InputReceiver
) -> &mut ReceiverDescriptor

Get a descriptor or insert it if it doesn’t exist.

source

pub fn add_binding(&mut self, binding: &mut ActionBinding<Keys>) -> &mut Self

Insert a new binding into the storage.

source

pub fn state(&self, key: &InputReceiver) -> &AxisState

Set the button state for a specific key receiver.

source

pub fn set_axis_value(
    &mut self,
    input: InputReceiver,
    value: f32,
    element_state: PressState
)

Set the axis state for a specific input receiver.

source

pub fn set_key_receiver_state(
    &mut self,
    input: InputReceiver,
    state: PressState
)

Set the axis state for a specific input receiver.

source

pub fn key(&self, kind: &Keys) -> PressState

Return the current press state for a specific binding matching with the given BindingTypeView.

source

pub fn axis(&self, kind: &Keys) -> Vec<AxisState>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Return the current axis state for a specific binding matching with the given BindingTypeView.

source

pub fn clear_from_specific_source(&mut self, source: InputSource)

A utility function for removing all receivers with a specific source.

source

pub fn combine<const T: usize>(&self, array: &[&Keys; T]) -> Vec<AxisState>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Combine the axis states of all given keys into a Vec.

source

pub fn combine_first<const T: usize>(
 &self,
 array: &[&Keys; T]
) -> Vec<Option<AxisState>>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Combine the first axis states of all given keys into a Vec.

source

pub fn cleanup(&mut self)

Remove all irrelevant descriptors to be with accordance with the descriptor vector capacity.

Trait Implementations

source

impl<Keys: Clone> Clone for InputView<Keys> where
Keys: BindingTypeView,

source

fn clone(&self) -> InputView<Keys>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<Keys> Component for InputView<Keys> where
Keys: BindingTypeView,
Self: Send + Sync + 'static,

type Storage = TableStorage

source

impl<Keys: Debug> Debug for InputView<Keys> where
Keys: BindingTypeView,

source

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

Formats the value using the given formatter. Read more

source

impl<Keys: Default> Default for InputView<Keys> where
Keys: BindingTypeView,

source

fn default() -> InputView<Keys>

Returns the “default value” for a type. Read more

source

impl<Keys: PartialEq> PartialEq<InputView<Keys>> for InputView<Keys> where
Keys: BindingTypeView,

source

fn eq(&self, other: &InputView<Keys>) -> bool

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

source

fn ne(&self, other: &InputView<Keys>) -> bool

This method tests for !=.

source

impl<Keys> StructuralPartialEq for InputView<Keys> where
Keys: BindingTypeView,

Auto Trait Implementations

impl<Keys> RefUnwindSafe for InputView<Keys> where
Keys: RefUnwindSafe,

impl<Keys> Send for InputView<Keys>

impl<Keys> Sync for InputView<Keys>

impl<Keys> Unpin for InputView<Keys> where
Keys: Unpin,

impl<Keys> UnwindSafe for InputView<Keys> where
Keys: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromWorld for T where
T: Default,

fn from_world(_world: &mut World) -> T

Creates Self using data from the given [World]

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,

fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct ezinput::view::InputView

Fields

Implementations

impl<Keys> InputView<Keys> where Keys: BindingTypeView,

pub fn new() -> Self

pub fn with_capacity(capacity: usize) -> Self

pub fn capacity(&self) -> usize

pub fn set_capacity(&mut self, capacity: usize)

pub fn add_descriptor(&mut self, descriptor: ReceiverDescriptor)

pub fn descriptor(&self, rcv: &InputReceiver) -> Option<&ReceiverDescriptor>

pub fn descriptor_mut( &mut self, rcv: &InputReceiver) -> Option<&mut ReceiverDescriptor>

pub fn descriptor_or_insert( &mut self, input: InputReceiver) -> &mut ReceiverDescriptor

pub fn add_binding(&mut self, binding: &mut ActionBinding<Keys>) -> &mut Self

pub fn state(&self, key: &InputReceiver) -> &AxisState

pub fn set_axis_value( &mut self, input: InputReceiver, value: f32, element_state: PressState)

pub fn set_key_receiver_state( &mut self, input: InputReceiver, state: PressState)

pub fn key(&self, kind: &Keys) -> PressState

pub fn axis(&self, kind: &Keys) -> Vec<AxisState>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn clear_from_specific_source(&mut self, source: InputSource)

pub fn combine<const T: usize>(&self, array: &[&Keys; T]) -> Vec<AxisState>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn combine_first<const T: usize>( &self, array: &[&Keys; T]) -> Vec<Option<AxisState>>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn cleanup(&mut self)

Trait Implementations

impl<Keys: Clone> Clone for InputView<Keys> where Keys: BindingTypeView,

fn clone(&self) -> InputView<Keys>

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

impl<Keys> Component for InputView<Keys> where Keys: BindingTypeView, Self: Send + Sync + 'static,

type Storage = TableStorage

impl<Keys: Debug> Debug for InputView<Keys> where Keys: BindingTypeView,

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

impl<Keys: Default> Default for InputView<Keys> where Keys: BindingTypeView,

fn default() -> InputView<Keys>

impl<Keys: PartialEq> PartialEq<InputView<Keys>> for InputView<Keys> where Keys: BindingTypeView,

fn eq(&self, other: &InputView<Keys>) -> bool

fn ne(&self, other: &InputView<Keys>) -> bool

impl<Keys> StructuralPartialEq for InputView<Keys> where Keys: BindingTypeView,

Auto Trait Implementations

impl<Keys> RefUnwindSafe for InputView<Keys> where Keys: RefUnwindSafe,

impl<Keys> Send for InputView<Keys>

impl<Keys> Sync for InputView<Keys>

impl<Keys> Unpin for InputView<Keys> where Keys: Unpin,

impl<Keys> UnwindSafe for InputView<Keys> where Keys: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast for T where T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> DowncastSync for T where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FromWorld for T where T: Default,

fn from_world(_world: &mut World) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> TypeData for T where T: 'static + Send + Sync + Clone,

fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

impl<Keys> InputView<Keys> where
Keys: BindingTypeView,

pub fn descriptor_mut(
&mut self,
rcv: &InputReceiver
) -> Option<&mut ReceiverDescriptor>

pub fn descriptor_or_insert(
&mut self,
input: InputReceiver
) -> &mut ReceiverDescriptor

pub fn set_axis_value(
&mut self,
input: InputReceiver,
value: f32,
element_state: PressState
)

pub fn set_key_receiver_state(
&mut self,
input: InputReceiver,
state: PressState
)

pub fn axis(&self, kind: &Keys) -> Vec<AxisState>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn combine<const T: usize>(&self, array: &[&Keys; T]) -> Vec<AxisState>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn combine_first<const T: usize>(
&self,
array: &[&Keys; T]
) -> Vec<Option<AxisState>>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

impl<Keys: Clone> Clone for InputView<Keys> where
Keys: BindingTypeView,

impl<Keys> Component for InputView<Keys> where
Keys: BindingTypeView,
Self: Send + Sync + 'static,

impl<Keys: Debug> Debug for InputView<Keys> where
Keys: BindingTypeView,

impl<Keys: Default> Default for InputView<Keys> where
Keys: BindingTypeView,

impl<Keys: PartialEq> PartialEq<InputView<Keys>> for InputView<Keys> where
Keys: BindingTypeView,

impl<Keys> StructuralPartialEq for InputView<Keys> where
Keys: BindingTypeView,

impl<Keys> RefUnwindSafe for InputView<Keys> where
Keys: RefUnwindSafe,

impl<Keys> Unpin for InputView<Keys> where
Keys: Unpin,

impl<Keys> UnwindSafe for InputView<Keys> where
Keys: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> Downcast for T where
T: Any,

impl<T> DowncastSync for T where
T: Any + Send + Sync,

impl<T> FromWorld for T where
T: Default,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

impl<T> Resource for T where
T: 'static + Send + Sync,