[−][src]Enum amethyst_ui::UiWidget

pub enum UiWidget<C = NoCustomUi, W = u32, G = ()> where
    C: ToNativeWidget<W>,
    W: WidgetId,  {
    Container {
        transform: UiTransformData<G>,
        background: Option<UiImagePrefab>,
        children: Vec<UiWidget<C, W>>,
    },
    Image {
        transform: UiTransformData<G>,
        image: UiImagePrefab,
    },
    Label {
        transform: UiTransformData<G>,
        text: UiTextData,
    },
    Button {
        transform: UiTransformData<G>,
        button: UiButtonData<W>,
    },
    Custom(Box<C>),
}

Loadable ui components

Type parameters:

W: Type used for Widget ID for this widget and its children

Variants

Container

Container widget

Fields of Container

transform: UiTransformData<G>

Spatial information for the container

background: Option<UiImagePrefab>

Background image

children: Vec<UiWidget<C, W>>

Child widgets

Image

Image widget

Fields of Image

transform: UiTransformData<G>

Spatial information

image: UiImagePrefab

Image

Label

Text widget

Fields of Label

transform: UiTransformData<G>

Spatial information

text: UiTextData

Text

Button

Button widget

Fields of Button

transform: UiTransformData<G>

Spatial information

button: UiButtonData<W>

Button

Custom(Box<C>)

Custom UI widget

Methods

`impl<C, W, G> UiWidget<C, W, G> where C: ToNativeWidget<W>, W: WidgetId,` [src]

`pub fn transform(&self) -> Option<&UiTransformData<G>>`[src]

Convenience function to access widgets UiTransformData

`pub fn transform_mut(&mut self) -> Option<&mut UiTransformData<G>>`[src]

Convenience function to access widgets UiTransformData

`pub fn image(&self) -> Option<&UiImagePrefab>`[src]

Convenience function to access widgets UiImagePrefab

`pub fn image_mut(&mut self) -> Option<&mut UiImagePrefab>`[src]

Convenience function to access widgets UiImagePrefab

Trait Implementations

`impl<C: Clone, W: Clone, G: Clone> Clone for UiWidget<C, W, G> where C: ToNativeWidget<W>, W: WidgetId,` [src]

`fn clone(&self) -> UiWidget<C, W, G>`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

Performs copy-assignment from source. Read more

`impl<C: Debug, W: Debug, G: Debug> Debug for UiWidget<C, W, G> where C: ToNativeWidget<W>, W: WidgetId,` [src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl<C, W, G> Serialize for UiWidget<C, W, G> where C: ToNativeWidget<W>, W: WidgetId, C: Serialize, W: Serialize, G: Serialize,` [src]

`fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer,` [src]

`impl<'de, C, W, G> Deserialize<'de> for UiWidget<C, W, G> where C: ToNativeWidget<W>, W: WidgetId, C: Deserialize<'de>, W: Deserialize<'de>, G: Deserialize<'de>,` [src]

`fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where __D: Deserializer<'de>,` [src]

Auto Trait Implementations

`impl<C, W, G> Unpin for UiWidget<C, W, G> where G: Unpin, W: Unpin,`

`impl<C, W, G> Sync for UiWidget<C, W, G> where C: Sync, G: Sync,`

`impl<C, W, G> Send for UiWidget<C, W, G> where C: Send, G: Send,`

`impl<C = NoCustomUi, W = u32, G = ()> !UnwindSafe for UiWidget<C, W, G>`

`impl<C = NoCustomUi, W = u32, G = ()> !RefUnwindSafe for UiWidget<C, W, G>`

Blanket Implementations

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

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

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, >::Error>`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Same<T> for T`[src]

`type Output = T`

Should always be Self

`impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,` [src]

`fn to_subset(&self) -> Option<SS>`[src]

`fn is_in_subset(&self) -> bool`[src]

`unsafe fn to_subset_unchecked(&self) -> SS`[src]

`fn from_subset(element: &SS) -> SP`[src]

`impl<T> DeserializeOwned for T where T: Deserialize<'de>,` [src]

`impl<T> Resource for T where T: Any + Send + Sync,` [src]

`impl<T> Any for T where T: Any,` [src]

`fn get_type_id(&self) -> TypeId`[src]

`impl<T> Event for T where T: Send + Sync + 'static,` [src]

`impl<T> Serialize for T where T: Serialize + ?Sized,` [src]

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

`impl<T> Erased for T`[src]

`impl<T> Clone for T where T: Clone,` [src]

`unsafe fn clone_box(&self) -> *mut ()`[src]

`impl<T> SetParameter for T`[src]

`fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where T: Parameter<Self>,` [src]

Sets value as a parameter of self.

`impl<T> Supports<T> for T`[src]

`impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where D: AdaptFrom<S, Swp, Dwp, T>, Dwp: WhitePoint, Swp: WhitePoint, T: Component + Float,` [src]

`fn adapt_into_using<M>(self, method: M) -> D where M: TransformMatrix<Swp, Dwp, T>,` [src]

`fn adapt_into(self) -> D`[src]

Convert the source color to the destination color using the bradford method by default Read more

[−][src]Enum amethyst_ui::UiWidget

Type parameters:

Variants

Fields of Container

Fields of Image

Fields of Label

Fields of Button

Methods

impl<C, W, G> UiWidget<C, W, G> where C: ToNativeWidget<W>, W: WidgetId, [src]

pub fn transform(&self) -> Option<&UiTransformData<G>>[src]

pub fn transform_mut(&mut self) -> Option<&mut UiTransformData<G>>[src]

pub fn image(&self) -> Option<&UiImagePrefab>[src]

pub fn image_mut(&mut self) -> Option<&mut UiImagePrefab>[src]

Trait Implementations

impl<C: Clone, W: Clone, G: Clone> Clone for UiWidget<C, W, G> where C: ToNativeWidget<W>, W: WidgetId, [src]

fn clone(&self) -> UiWidget<C, W, G>[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl<C: Debug, W: Debug, G: Debug> Debug for UiWidget<C, W, G> where C: ToNativeWidget<W>, W: WidgetId, [src]

fn fmt(&self, f: &mut Formatter) -> Result[src]

impl<C, W, G> Serialize for UiWidget<C, W, G> where C: ToNativeWidget<W>, W: WidgetId, C: Serialize, W: Serialize, G: Serialize, [src]

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

impl<'de, C, W, G> Deserialize<'de> for UiWidget<C, W, G> where C: ToNativeWidget<W>, W: WidgetId, C: Deserialize<'de>, W: Deserialize<'de>, G: Deserialize<'de>, [src]

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where __D: Deserializer<'de>, [src]

Auto Trait Implementations

impl<C, W, G> Unpin for UiWidget<C, W, G> where G: Unpin, W: Unpin,

impl<C, W, G> Sync for UiWidget<C, W, G> where C: Sync, G: Sync,

impl<C, W, G> Send for UiWidget<C, W, G> where C: Send, G: Send,

impl<C = NoCustomUi, W = u32, G = ()> !UnwindSafe for UiWidget<C, W, G>

impl<C = NoCustomUi, W = u32, G = ()> !RefUnwindSafe for UiWidget<C, W, G>

Blanket Implementations

impl<T> ToOwned for T where T: Clone, [src]

type Owned = T

fn to_owned(&self) -> T[src]

fn clone_into(&self, target: &mut T)[src]

impl<T> From<T> for T[src]

fn from(t: T) -> T[src]

impl<T, U> Into<U> for T where U: From<T>, [src]

fn into(self) -> U[src]

impl<T, U> TryFrom<U> for T where U: Into<T>, [src]

type Error = Infallible

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>, [src]

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

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

impl<T> Borrow<T> for T where T: ?Sized, [src]

fn borrow(&self) -> &T[src]

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

fn borrow_mut(&mut self) -> &mut T[src]

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

fn type_id(&self) -> TypeId[src]

impl<T> Same<T> for T[src]

type Output = T

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>, [src]

fn to_subset(&self) -> Option<SS>[src]

fn is_in_subset(&self) -> bool[src]

unsafe fn to_subset_unchecked(&self) -> SS[src]

fn from_subset(element: &SS) -> SP[src]

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

impl<T> Resource for T where T: Any + Send + Sync, [src]

impl<T> Any for T where T: Any, [src]

fn get_type_id(&self) -> TypeId[src]

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

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

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

impl<T> Erased for T[src]

impl<T> Clone for T where T: Clone, [src]

unsafe fn clone_box(&self) -> *mut ()[src]

impl<T> SetParameter for T[src]

fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where T: Parameter<Self>, [src]

impl<T> Supports<T> for T[src]

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where D: AdaptFrom<S, Swp, Dwp, T>, Dwp: WhitePoint, Swp: WhitePoint, T: Component + Float, [src]

fn adapt_into_using<M>(self, method: M) -> D where M: TransformMatrix<Swp, Dwp, T>, [src]

fn adapt_into(self) -> D[src]

impl<V, T> VZip<V> for T where V: MultiLane<T>, [src]

fn vzip(self) -> V[src]

`impl<C, W, G> UiWidget<C, W, G> where C: ToNativeWidget<W>, W: WidgetId,` [src]

`pub fn transform(&self) -> Option<&UiTransformData<G>>`[src]

`pub fn transform_mut(&mut self) -> Option<&mut UiTransformData<G>>`[src]

`pub fn image(&self) -> Option<&UiImagePrefab>`[src]

`pub fn image_mut(&mut self) -> Option<&mut UiImagePrefab>`[src]

`impl<C: Clone, W: Clone, G: Clone> Clone for UiWidget<C, W, G> where C: ToNativeWidget<W>, W: WidgetId,` [src]

`fn clone(&self) -> UiWidget<C, W, G>`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl<C: Debug, W: Debug, G: Debug> Debug for UiWidget<C, W, G> where C: ToNativeWidget<W>, W: WidgetId,` [src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl<C, W, G> Serialize for UiWidget<C, W, G> where C: ToNativeWidget<W>, W: WidgetId, C: Serialize, W: Serialize, G: Serialize,` [src]

`fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer,` [src]

`impl<'de, C, W, G> Deserialize<'de> for UiWidget<C, W, G> where C: ToNativeWidget<W>, W: WidgetId, C: Deserialize<'de>, W: Deserialize<'de>, G: Deserialize<'de>,` [src]

`fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where __D: Deserializer<'de>,` [src]

`impl<C, W, G> Unpin for UiWidget<C, W, G> where G: Unpin, W: Unpin,`

`impl<C, W, G> Sync for UiWidget<C, W, G> where C: Sync, G: Sync,`

`impl<C, W, G> Send for UiWidget<C, W, G> where C: Send, G: Send,`

`impl<C = NoCustomUi, W = u32, G = ()> !UnwindSafe for UiWidget<C, W, G>`

`impl<C = NoCustomUi, W = u32, G = ()> !RefUnwindSafe for UiWidget<C, W, G>`

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

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

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

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

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

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Same<T> for T`[src]

`type Output = T`

`impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,` [src]

`fn to_subset(&self) -> Option<SS>`[src]

`fn is_in_subset(&self) -> bool`[src]

`unsafe fn to_subset_unchecked(&self) -> SS`[src]

`fn from_subset(element: &SS) -> SP`[src]

`impl<T> DeserializeOwned for T where T: Deserialize<'de>,` [src]

`impl<T> Resource for T where T: Any + Send + Sync,` [src]

`impl<T> Any for T where T: Any,` [src]

`fn get_type_id(&self) -> TypeId`[src]

`impl<T> Event for T where T: Send + Sync + 'static,` [src]

`impl<T> Serialize for T where T: Serialize + ?Sized,` [src]

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

`impl<T> Erased for T`[src]

`impl<T> Clone for T where T: Clone,` [src]

`unsafe fn clone_box(&self) -> *mut ()`[src]

`impl<T> SetParameter for T`[src]

`fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where T: Parameter<Self>,` [src]

`impl<T> Supports<T> for T`[src]

`impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where D: AdaptFrom<S, Swp, Dwp, T>, Dwp: WhitePoint, Swp: WhitePoint, T: Component + Float,` [src]

`fn adapt_into_using<M>(self, method: M) -> D where M: TransformMatrix<Swp, Dwp, T>,` [src]

`fn adapt_into(self) -> D`[src]

`impl<V, T> VZip<V> for T where V: MultiLane<T>,` [src]

`fn vzip(self) -> V`[src]