Enum bevy_picking_highlight::HighlightKind

pub enum HighlightKind<T: Asset> {
    Fixed(Handle<T>),
    Dynamic {
        function: fn(initial: &T) -> T,
        cache: Option<Handle<T>>,
    },
}

Used to override each highlighting state in Highlight.

Variants

Fixed(Handle<T>)

A fixed override for this entity. For example, to change a material to a specific color.

Dynamic

Fields

function: fn(initial: &T) -> T

The function to set.

cache: Option<Handle<T>>

The function will be run when the entity’s Handle changes, and the output will be stored here.

A function that takes the base asset of the entity, and outputs a new, modified asset. This can be used to make “tinted” materials.

Implementations

impl<T: Asset> HighlightKind<T>

pub fn get_handle(&self) -> Option<Handle<T>>

Get a handle to the override Asset.

pub fn get_dynamic( &mut self ) -> Option<(&fn(initial: &T) -> T, &mut Option<Handle<T>>)>

Get the dynamic override function and cache if it exists.

pub const fn new_dynamic(function: fn(initial: &T) -> T) -> Self

Create a HighlightKind::Dynamic with the supplied function. Useful when you want to tweak the initial Asset when highlighting, e.g. tinting StandardMaterial blue.

Trait Implementations

impl<T: Clone + Asset> Clone for HighlightKind<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Asset> Debug for HighlightKind<T>

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

Formats the value using the given formatter.