Struct VirtualDPad3D

pub struct VirtualDPad3D {
    pub up: Box<dyn Buttonlike>,
    pub down: Box<dyn Buttonlike>,
    pub left: Box<dyn Buttonlike>,
    pub right: Box<dyn Buttonlike>,
    pub forward: Box<dyn Buttonlike>,
    pub backward: Box<dyn Buttonlike>,
}

A virtual triple-axis control constructed from six Buttonlikes. Each button represents a specific direction (up, down, left, right, forward, backward), functioning similarly to a three-dimensional directional pad (D-pad) on all X, Y, and Z axes, and offering intermediate diagonals by means of two/three-key combinations.

The raw axis values are determined based on the state of the associated buttons:

• -1.0 if only the negative button is currently pressed (Down/Left/Forward).
• 1.0 if only the positive button is currently pressed (Up/Right/Backward).
• 0.0 if neither button is pressed, or both are pressed simultaneously.

Fields

up: Box<dyn Buttonlike>

The button for the upward direction.

down: Box<dyn Buttonlike>

The button for the downward direction.

left: Box<dyn Buttonlike>

The button for the leftward direction.

right: Box<dyn Buttonlike>

The button for the rightward direction.

forward: Box<dyn Buttonlike>

The button for the forward direction.

backward: Box<dyn Buttonlike>

The button for the backward direction.

Implementations

impl VirtualDPad3D

pub fn new( up: impl Buttonlike, down: impl Buttonlike, left: impl Buttonlike, right: impl Buttonlike, forward: impl Buttonlike, backward: impl Buttonlike, ) -> Self

Creates a new VirtualDPad3D with six given Buttonlikes. Each button represents a specific direction (up, down, left, right, forward, backward).

Trait Implementations

impl Clone for VirtualDPad3D

fn clone(&self) -> VirtualDPad3D

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VirtualDPad3D

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VirtualDPad3D

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromReflect for VirtualDPad3D

where VirtualDPad3D: Any + Send + Sync, Box<dyn Buttonlike>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

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 GetTypeRegistration for VirtualDPad3D

where VirtualDPad3D: Any + Send + Sync, Box<dyn Buttonlike>: 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 Hash for VirtualDPad3D

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for VirtualDPad3D

fn eq(&self, other: &VirtualDPad3D) -> 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 PartialReflect for VirtualDPad3D

where VirtualDPad3D: Any + Send + Sync, Box<dyn Buttonlike>: 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) -> 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<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Self>, ) -> 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>

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

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

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

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

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> 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 VirtualDPad3D

where VirtualDPad3D: Any + Send + Sync, Box<dyn Buttonlike>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

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

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

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<'de> RegisterTypeTag<'de, dyn TripleAxislike> for VirtualDPad3D

fn register_typetag(registry: &mut InfallibleMapRegistry<dyn TripleAxislike>)

Registers the specified type tag into the InfallibleMapRegistry.

impl Serialize for VirtualDPad3D

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for VirtualDPad3D

where VirtualDPad3D: Any + Send + Sync, Box<dyn Buttonlike>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

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>

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>

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>

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 TripleAxislike for VirtualDPad3D

fn axis_triple(&self, input_store: &CentralInputStore, gamepad: Entity) -> Vec3

Retrieves the current X, Y, and Z values of this D-pad.

fn set_axis_triple_as_gamepad( &self, world: &mut World, value: Vec3, gamepad: Option<Entity>, )

Sets the value of corresponding button on each axis based on the given value.

When value along an axis is non-zero, set its absolute value to the value of:

• the negative button of the axis if the value is negative;
• the positive button of the axis if the value is positive.

fn set_axis_triple(&self, world: &mut World, value: Vec3)

Simulate a triple-axis-like input by sending the appropriate event.

impl TypePath for VirtualDPad3D

where VirtualDPad3D: 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 VirtualDPad3D

where VirtualDPad3D: Any + Send + Sync, Box<dyn Buttonlike>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl UserInput for VirtualDPad3D

fn kind(&self) -> InputControlKind

VirtualDPad3D acts as a virtual triple-axis input.

fn decompose(&self) -> BasicInputs

VirtualDPad3D represents a compositions of six Buttonlikes.

impl Eq for VirtualDPad3D

impl StructuralPartialEq for VirtualDPad3D