Class SpriteAnimationImage

Namespace

MLEM.Ui.Elements

Assembly

MLEM.Ui.dll

A sprite animation image for use inside of a UiSystem. A sprite animation image is an Image that displays a SpriteAnimation or SpriteAnimationGroup.

public class SpriteAnimationImage : Image, IGenericDataHolder, ILayoutItem

Inheritance

object

GenericDataHolder

Element

Image

SpriteAnimationImage

Implements

IGenericDataHolder

ILayoutItem

Inherited Members

Image.Color

Image.GetTextureCallback

Image.Texture

Image.ScaleToImage

Image.MaintainImageAspect

Image.ImageEffects

Image.ImageScale

Image.ImageRotation

Image.UseImagePivot

Image.SetWidthBasedOnAspect

Image.SetHeightBasedOnAspect

Image.SamplerState

Image.IsHidden

Image.ForceUpdateArea()

Image.CalcActualSize(RectangleF)

Image.Draw(GameTime, SpriteBatch, float, SpriteBatchContext)

Element.Epsilon

Element.RecursionLimit

Element.System

Element.Controls

Element.Parent

Element.Root

Element.Scale

Element.Anchor

Element.Size

Element.ScaledSize

Element.AutoSizeAddedAbsolute

Element.ScaledAutoSizeAddedAbsolute

Element.PositionOffset

Element.ScaledOffset

Element.ScaledPadding

Element.ScaledChildPadding

Element.ChildPaddedArea

Element.UnscrolledArea

Element.Area

Element.DisplayArea

Element.ScrollOffset

Element.ScaledScrollOffset

Element.Priority

Element.Transform

Element.CanBeSelected

Element.CanBeMoused

Element.CanBePressed

Element.CanAutoAnchorsAttach

Element.SetWidthBasedOnChildren

Element.SetHeightBasedOnChildren

Element.TreatSizeAsMinimum

Element.TreatSizeAsMaximum

Element.PreventParentSpill

Element.DrawAlpha

Element.IsMouseOver

Element.IsSelected

Element.IsSelectedActive

Element.AreaDirty

Element.AutoNavGroup

Element.DebugName

Element.Style

Element.SelectionIndicator

Element.SelectionColor

Element.ActionSound

Element.SecondActionSound

Element.Padding

Element.ChildPadding

Element.MouseEnterAnimation

Element.MouseExitAnimation

Element.OnDrawn

Element.OnUpdated

Element.OnPressed

Element.OnSecondaryPressed

Element.OnSelected

Element.OnDeselected

Element.OnMouseEnter

Element.OnMouseExit

Element.OnTouchEnter

Element.OnTouchExit

Element.OnTextInput

Element.OnAreaDirty

Element.OnAreaUpdated

Element.OnStyleInit

Element.OnMousedElementChanged

Element.OnTouchedElementChanged

Element.OnSelectedElementChanged

Element.GetTabNextElement

Element.GetGamepadNextElement

Element.OnChildAdded

Element.OnChildRemoved

Element.OnAddedToUi

Element.OnRemovedFromUi

Element.Children

Element.PlayingAnimations

Element.SortedChildren

Element.Input

Element.ParentArea

Element.AddChild<T>(T, int)

Element.RemoveChild(Element)

Element.RemoveChildren(Func<Element, bool>)

Element.SetSortedChildrenDirty()

Element.UpdateSortedChildrenIfDirty()

Element.ForceUpdateSortedChildren()

Element.SetAreaDirty()

Element.UpdateAreaIfDirty()

Element.SetAreaAndUpdateChildren(RectangleF)

Element.GetAreaForAutoAnchors()

Element.GetLowestChild(Func<Element, bool>, bool)

Element.GetRightmostChild(Func<Element, bool>, bool)

Element.GetLowestOlderSibling(Func<Element, bool>, bool)

Element.GetOlderSibling(Func<Element, bool>)

Element.GetSiblings(Func<Element, bool>)

Element.GetChildren<T>(Func<T, bool>, bool, bool)

Element.GetChildren(Func<Element, bool>, bool, bool)

Element.GetParentTree()

Element.GetTotalCoveredArea(bool)

Element.GetRelevantChildren()

Element.DrawTransformed(GameTime, SpriteBatch, float, SpriteBatchContext)

Element.GetElementUnderPos(Vector2)

Element.PlayAnimation(UiAnimation)

Element.StopAnimation(UiAnimation)

Element.ToString()

Element.AndChildren(Action<Element>)

Element.ReorderChildren(Comparison<Element>)

Element.ReverseChildren(int, int?)

Element.ScaleTransform(float, Vector2?)

Element.InitStyle(UiStyle)

Element.OnChildAreaDirty(Element, bool)

Element.OnParentAreaDirty(Element, bool)

Element.TransformInverse(Vector2)

Element.TransformInverseAll(Vector2)

Element.OnLayoutRecursion(int, ILayoutItem)

Element.OnLayoutRecursionSettled(int, bool)

Element.AddedToUi(UiSystem, RootElement)

Element.RemovedFromUi()

GenericDataHolder.SetData<T>(string, T)

GenericDataHolder.GetData<T>(string)

GenericDataHolder.GetDataKeys()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

ElementExtensions.AddTooltip(Element, Paragraph.TextCallback)

ElementExtensions.AddTooltip(Element, Tooltip)

ElementExtensions.AddTooltip(Element, string)

Constructors

SpriteAnimationImage(Anchor, Vector2, SpriteAnimation, bool)

Creates a new sprite animation image with the given settings

public SpriteAnimationImage(Anchor anchor, Vector2 size, SpriteAnimation animation, bool scaleToImage = false)

Parameters

anchor Anchor

The image's anchor

size Vector2

The image's size

animation SpriteAnimation

The sprite group to display

scaleToImage bool

Whether this image element should scale to the texture

SpriteAnimationImage(Anchor, Vector2, SpriteAnimationGroup, bool)

Creates a new sprite animation image with the given settings

public SpriteAnimationImage(Anchor anchor, Vector2 size, SpriteAnimationGroup group, bool scaleToImage = false)

Parameters

anchor Anchor

The image's anchor

size Vector2

The image's size

group SpriteAnimationGroup

The sprite animation group to display

scaleToImage bool

Whether this image element should scale to the texture

Fields

Group

The sprite animation group that is displayed by this image

public SpriteAnimationGroup Group

Field Value

SpriteAnimationGroup

Methods

Update(GameTime)

Updates this element and all of its SortedChildren

public override void Update(GameTime time)

Parameters

time GameTime

The game's time