Enum bevy::ui::Interaction

[−]

pub enum Interaction {
    Clicked,
    Hovered,
    None,
}

Expand description

Describes what type of input interaction has occurred for a UI node.

This is commonly queried with a Changed<Interaction> filter.

Updated in ui_focus_system.

If a UI node has both Interaction and ComputedVisibility components, Interaction will always be Interaction::None when ComputedVisibility::is_visible() is false. This ensures that hidden UI nodes are not interactable, and do not end up stuck in an active state if hidden at the wrong time.

Note that you can also control the visibility of a node using the Display property, which fully collapses it during layout calculations.

Variants

`Clicked`

The node has been clicked

`Hovered`

The node has been hovered over

`None`

Nothing has happened

Trait Implementations

impl Clone for Interaction

fn clone(&self) -> Interaction

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

impl Component for Interaction where
    Interaction: 'static,
    Interaction: Send,
    Interaction: Sync,

type Storage = TableStorage

impl Debug for Interaction

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

Formats the value using the given formatter. Read more

impl Default for Interaction

fn default() -> Interaction

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

impl<'de> Deserialize<'de> for Interaction

fn deserialize<D>(
deserializer: D
) -> Result<Interaction, <D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl GetTypeRegistration for Interaction

fn get_type_registration() -> TypeRegistration

impl PartialEq<Interaction> for Interaction

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

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

1.0.0 · source

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. Read more

impl Reflect for Interaction

fn type_name(&self) -> &str

Returns the type name of the underlying type.

fn get_type_info(&self) -> &'static TypeInfo

Returns the TypeInfo of the underlying type. Read more

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

Returns the value as a Box<dyn Any>.

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

Returns the value as a &dyn Any.

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

Returns the value as a &mut dyn Any.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value

fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>

Clones the value as a Reflect trait object. Read more

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value. Read more

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

Performs a type-checked assignment of a reflected value to this value. Read more

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an enumeration of “kinds” of type. Read more

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type. Read more

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result. Read more

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type). Read more

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

Debug formatter for the value. Read more

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value. Read more

impl Serialize for Interaction

fn serialize<S>(
 &self,
 serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
 S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl Typed for Interaction

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type. Read more

impl Copy for Interaction

impl Eq for Interaction

impl StructuralEq for Interaction

impl StructuralPartialEq for Interaction

Auto Trait Implementations

impl RefUnwindSafe for Interaction

impl Send for Interaction

impl Sync for Interaction

impl Unpin for Interaction

impl UnwindSafe for Interaction

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

impl<T, U> AsBindGroupShaderType for T where
U: ShaderType,
&'a T: for<'a> Into,

fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist. 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

impl<T> DynEq for T where
T: Any + Eq,

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

fn dyn_eq(&self, other: &(dyn DynEq + 'static)) -> bool

source

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

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

impl<T> GetPath for T where
T: Reflect,

fn path(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>

Returns a reference to the value specified by path. Read more

fn path_mut(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>

Returns a mutable reference to the value specified by path. Read more

fn get_path<T>(&'r self, path: &'p str) -> Result<&'r T, ReflectPathError<'p>> where
T: Reflect,

Returns a statically typed reference to the value specified by path.

fn get_path_mut<T>(
 &'r mut self,
 path: &'p str
) -> Result<&'r mut T, ReflectPathError<'p>> where
 T: Reflect,

Returns a statically typed mutable reference to the value specified by path. Read more

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

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

source

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

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> Serialize for T where
T: Serialize + ?Sized,

source

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>

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>

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;` 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>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`

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

source

Enum bevy::ui::Interaction

Variants

Clicked

Hovered

None

Trait Implementations

impl Clone for Interaction

fn clone(&self) -> Interaction

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

impl Component for Interaction where Interaction: 'static, Interaction: Send, Interaction: Sync,

type Storage = TableStorage

impl Debug for Interaction

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

impl Default for Interaction

fn default() -> Interaction

impl<'de> Deserialize<'de> for Interaction

fn deserialize<__D>( __deserializer: __D) -> Result<Interaction, <__D as Deserializer<'de>>::Error> where __D: Deserializer<'de>,

impl GetTypeRegistration for Interaction

fn get_type_registration() -> TypeRegistration

impl PartialEq<Interaction> for Interaction

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

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

impl Reflect for Interaction

fn type_name(&self) -> &str

fn get_type_info(&self) -> &'static TypeInfo

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

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

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

fn as_reflect(&self) -> &(dyn Reflect + 'static)

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>

fn apply(&mut self, value: &(dyn Reflect + 'static))

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

fn reflect_ref(&self) -> ReflectRef<'_>

fn reflect_mut(&mut self) -> ReflectMut<'_>

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

fn reflect_hash(&self) -> Option<u64>

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

fn serializable(&self) -> Option<Serializable<'_>>

impl Serialize for Interaction

fn serialize<__S>( &self, __serializer: __S) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where __S: Serializer,

impl Typed for Interaction

fn type_info() -> &'static TypeInfo

impl Copy for Interaction

impl Eq for Interaction

impl StructuralEq for Interaction

impl StructuralPartialEq for Interaction

Auto Trait Implementations

impl RefUnwindSafe for Interaction

impl Send for Interaction

impl Sync for Interaction

impl Unpin for Interaction

impl UnwindSafe for Interaction

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<T, U> AsBindGroupShaderType<U> for T where U: ShaderType, &'a T: for<'a> Into<U>,

fn as_bind_group_shader_type( &self, _images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>) -> U

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> DynEq for T where T: Any + Eq,

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

fn dyn_eq(&self, other: &(dyn DynEq + 'static)) -> bool

impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

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> GetPath for T where T: Reflect,

fn path( &'r self, path: &'p str) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>

`Clicked`

`Hovered`

`None`

impl Component for Interaction where
Interaction: 'static,
Interaction: Send,
Interaction: Sync,

fn deserialize<D>(
deserializer: D
) -> Result<Interaction, <D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,

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

fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,

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

impl<T, U> AsBindGroupShaderType<U> for T where
U: ShaderType,
&'a T: for<'a> Into<U>,

fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U

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> DynEq for T where
T: Any + Eq,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

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

impl<T> GetPath for T where
T: Reflect,

fn path(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>

fn path_mut(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>

fn get_path<T>(&'r self, path: &'p str) -> Result<&'r T, ReflectPathError<'p>> where
T: Reflect,

fn get_path_mut<T>(
&'r mut self,
path: &'p str
) -> Result<&'r mut T, ReflectPathError<'p>> where
T: Reflect,

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

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

impl<T> Serialize for T where
T: Serialize + ?Sized,

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,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;` where
S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,

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

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