Struct SpritePickingSettings

pub struct SpritePickingSettings {
    pub require_markers: bool,
    pub picking_mode: SpritePickingMode,
}

Runtime settings for the SpritePickingPlugin.

Fields

require_markers: bool

When set to true sprite picking will only consider cameras marked with SpritePickingCamera.

This setting is provided to give you fine-grained control over which cameras and entities should be used by the sprite picking backend at runtime.

picking_mode: SpritePickingMode

Should the backend count transparent pixels as part of the sprite for picking purposes or should it use the bounding box of the sprite alone.

Defaults to an inclusive alpha threshold of 0.1

Trait Implementations

impl Default for SpritePickingSettings

fn default() -> SpritePickingSettings

Returns the “default value” for a type.

impl FromArg for &'static SpritePickingSettings

where SpritePickingSettings: Any + Send + Sync, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, SpritePickingMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

type This<'from_arg> = &'from_arg SpritePickingSettings

The type to convert into.

fn from_arg( arg: Arg<'_>, ) -> Result<<&'static SpritePickingSettings as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromArg for &'static mut SpritePickingSettings

where SpritePickingSettings: Any + Send + Sync, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, SpritePickingMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

type This<'from_arg> = &'from_arg mut SpritePickingSettings

The type to convert into.

fn from_arg( arg: Arg<'_>, ) -> Result<<&'static mut SpritePickingSettings as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromArg for SpritePickingSettings

where SpritePickingSettings: Any + Send + Sync, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, SpritePickingMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

type This<'from_arg> = SpritePickingSettings

The type to convert into.

fn from_arg( arg: Arg<'_>, ) -> Result<<SpritePickingSettings as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromReflect for SpritePickingSettings

where SpritePickingSettings: Any + Send + Sync, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, SpritePickingMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect( reflect: &(dyn PartialReflect + 'static), ) -> Option<SpritePickingSettings>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetOwnership for &SpritePickingSettings

where SpritePickingSettings: Any + Send + Sync, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, SpritePickingMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetOwnership for &mut SpritePickingSettings

where SpritePickingSettings: Any + Send + Sync, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, SpritePickingMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetOwnership for SpritePickingSettings

where SpritePickingSettings: Any + Send + Sync, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, SpritePickingMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetTypeRegistration for SpritePickingSettings

where SpritePickingSettings: Any + Send + Sync, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, SpritePickingMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl IntoReturn for &SpritePickingSettings

where SpritePickingSettings: Any + Send + Sync, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, SpritePickingMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_return<'into_return>(self) -> Return<'into_return>

where &SpritePickingSettings: 'into_return,

Converts Self into a Return value.

impl IntoReturn for &mut SpritePickingSettings

where SpritePickingSettings: Any + Send + Sync, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, SpritePickingMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_return<'into_return>(self) -> Return<'into_return>

where &mut SpritePickingSettings: 'into_return,

Converts Self into a Return value.

impl IntoReturn for SpritePickingSettings

where SpritePickingSettings: Any + Send + Sync, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, SpritePickingMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_return<'into_return>(self) -> Return<'into_return>

where SpritePickingSettings: 'into_return,

Converts Self into a Return value.

impl PartialReflect for SpritePickingSettings

where SpritePickingSettings: Any + Send + Sync, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, SpritePickingMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply( &mut self, value: &(dyn PartialReflect + 'static), ) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

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

Returns an immutable enumeration of “kinds” of type.

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

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<SpritePickingSettings>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<SpritePickingSettings>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&(dyn Reflect + 'static)>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut (dyn Reflect + 'static)>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect( self: Box<SpritePickingSettings>, ) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

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

Returns a “partial equality” comparison result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

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

Applies a reflected value to this value.

fn clone_value(&self) -> Box<dyn PartialReflect>

👎Deprecated since 0.16.0: to clone reflected values, prefer using reflect_clone. To convert reflected values to dynamic ones, use to_dynamic.

Clones Self into its dynamic representation.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

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

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

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

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for SpritePickingSettings

where SpritePickingSettings: Any + Send + Sync, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, SpritePickingMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

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 into_reflect(self: Box<SpritePickingSettings>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

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

Casts this type to a fully-reflected value.

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

Casts this type to a mutable, fully-reflected value.

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

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

impl Struct for SpritePickingSettings

where SpritePickingSettings: Any + Send + Sync, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, SpritePickingMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, name: &str) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut( &mut self, name: &str, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut( &mut self, index: usize, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn to_dynamic_struct(&self) -> DynamicStruct

fn clone_dynamic(&self) -> DynamicStruct

👎Deprecated since 0.16.0: use to_dynamic_struct instead

Clones the struct into a DynamicStruct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for SpritePickingSettings

where SpritePickingSettings: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for SpritePickingSettings

where SpritePickingSettings: Any + Send + Sync, bool: FromReflect + TypePath + MaybeTyped + RegisterForReflection, SpritePickingMode: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Resource for SpritePickingSettings

where SpritePickingSettings: Send + Sync + 'static,