Class ScissorGroup

Namespace

MLEM.Ui.Elements

Assembly

MLEM.Ui.dll

A scissor group is a Group that sets the Microsoft.Xna.Framework.Graphics.GraphicsDevice.ScissorRectangle before drawing its content (and thus, its Children), preventing them from being drawn outside of this group's DisplayArea's bounds.

public class ScissorGroup : Group, IGenericDataHolder

Inheritance

object

GenericDataHolder

Element

Group

ScissorGroup

Implements

IGenericDataHolder

Inherited Members

Element.Epsilon

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.IsHidden

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.Style

Element.SelectionIndicator

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.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.ForceUpdateArea()

Element.SetAreaAndUpdateChildren(RectangleF)

Element.CalcActualSize(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.Update(GameTime)

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.TransformInverse(Vector2)

Element.TransformInverseAll(Vector2)

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.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

ElementExtensions.AddTooltip(Element, Paragraph.TextCallback)

ElementExtensions.AddTooltip(Element, Tooltip)

ElementExtensions.AddTooltip(Element, string)

Constructors

ScissorGroup(Anchor, Vector2, bool)

Creates a new scissor group with the given settings

public ScissorGroup(Anchor anchor, Vector2 size, bool setHeightBasedOnChildren = true)

Parameters

anchor Anchor

The group's anchor

size Vector2

The group's size

setHeightBasedOnChildren bool

Whether the group's height should be based on its children's height, see SetHeightBasedOnChildren.

ScissorGroup(Anchor, Vector2, bool, bool)

Creates a new scissor group with the given settings

public ScissorGroup(Anchor anchor, Vector2 size, bool setWidthBasedOnChildren, bool setHeightBasedOnChildren)

Parameters

anchor Anchor

The group's anchor

size Vector2

The group's size

setWidthBasedOnChildren bool

Whether the group's width should be based on its children's width, see SetWidthBasedOnChildren.

setHeightBasedOnChildren bool

Whether the group's height should be based on its children's height, see SetHeightBasedOnChildren.

Fields

Rasterizer

The rasterizer state that this scissor group should use when drawing. By default, Microsoft.Xna.Framework.Graphics.CullMode is set to Microsoft.Xna.Framework.Graphics.CullMode.CullCounterClockwiseFace in accordance with Microsoft.Xna.Framework.Graphics.SpriteBatch's default behavior, and Microsoft.Xna.Framework.Graphics.RasterizerState.ScissorTestEnable is set to true.

public readonly RasterizerState Rasterizer

Field Value

RasterizerState

Methods

Draw(GameTime, SpriteBatch, float, SpriteBatchContext)

Draws this element and all of its children. Override this method to draw the content of custom elements. Note that, when this is called, SpriteBatch.Begin has already been called with custom Transform etc. applied.

public override void Draw(GameTime time, SpriteBatch batch, float alpha, SpriteBatchContext context)

Parameters

time GameTime

The game's time

batch SpriteBatch

The sprite batch to use for drawing

alpha float

The alpha to draw this element and its children with

context SpriteBatchContext

The sprite batch context to use for drawing