PercentageBar ClassDelta Engine Documentation
Used to visualise how close to full or complete something is. eg. it could be used for a health bar floating above a creep or as a progress bar. The percentile colors are lerped between; eg. Three colors would give the color at 0%, 50% and 100% View code on GitHub
Inheritance Hierarchy

System Object
  DeltaEngine.Entities Entity
    DeltaEngine.Entities DrawableEntity
      DeltaEngine.Rendering2D Entity2D
        DeltaEngine.Rendering2D.Shapes Polygon2D
          DeltaEngine.Rendering2D.Shapes FilledRect
            DeltaEngine.Scenes.Controls PercentageBar

Namespace: DeltaEngine.Scenes.Controls
Assembly: DeltaEngine.Scenes (in DeltaEngine.Scenes.dll) Version: 1.1.1.0 (1.1.1)
Syntax

public class PercentageBar : FilledRect

The PercentageBar type exposes the following members.

Constructors

  NameDescription
Public methodPercentageBar
Initializes a new instance of the PercentageBar class
Top
Methods

  NameDescription
Public methodAdd T  (Inherited from Entity2D.)
Public methodAddTag (Inherited from Entity.)
Public methodClearTags (Inherited from Entity.)
Public methodContains T  (Inherited from Entity2D.)
Public methodContainsBehavior T  (Inherited from Entity.)
Public methodContainsTag (Inherited from Entity.)
Protected methodDeactivate (Inherited from Entity.)
Public methodDispose (Inherited from Entity.)
Public methodGet T  (Inherited from Entity2D.)
Protected methodGetActiveBehaviors (Inherited from Entity.)
Public methodGetComponentsForEditing (Inherited from Entity2D.)
Protected methodGetComponentsForSaving (Inherited from Entity2D.)
Protected methodGetDrawBehaviors (Inherited from DrawableEntity.)
Public methodGetInterpolatedArray T  (Inherited from DrawableEntity.)
Public methodGetInterpolatedList T  (Inherited from DrawableEntity.)
Public methodGetOrDefault T  (Inherited from Entity.)
Public methodGetTags (Inherited from Entity.)
Protected methodNextUpdateStarted (Inherited from Entity2D.)
Public methodOnDraw T  (Inherited from DrawableEntity.)
Protected methodOnPositionChanged (Inherited from Entity2D.)
Protected methodOnRotationChanged (Inherited from FilledRect.)
Public methodRemove T  (Inherited from Entity.)
Public methodRemoveTag (Inherited from Entity.)
Public methodRotatedDrawAreaContains (Inherited from Entity2D.)
Public methodSet (Inherited from Entity2D.)
Public methodSetComponents (Inherited from Entity.)
Public methodSetWithoutInterpolation T  (Inherited from Entity2D.)
Public methodStart T  (Inherited from Entity.)
Public methodStop T  (Inherited from Entity.)
Public methodToggleVisibility (Inherited from DrawableEntity.)
Public methodToString (Inherited from Entity.)
Top
Extension Methods

  NameDescription
Public Extension MethodAffixToPhysics (Defined by Entity2DPhysicsExtensions.)
Public Extension MethodStartBouncingOffScreenEdges (Defined by Entity2DExtensions.)
Public Extension MethodStartFalling (Defined by Entity2DExtensions.)
Public Extension MethodStartMoving (Defined by Entity2DExtensions.)
Public Extension MethodStartRotating (Defined by Entity2DExtensions.)
Top
Fields

  NameDescription
Protected fieldcomponents (Inherited from Entity.)
Protected fieldlastTickLerpComponents
Each element can either be a Lerp, a Lerp List or an array of Lerp objects. View code on GitHub
(Inherited from DrawableEntity.)
Top
Properties

  NameDescription
Public propertyAlignment
Public propertyAlpha (Inherited from Entity2D.)
Public propertyCenter (Inherited from Entity2D.)
Public propertyColor (Inherited from Entity2D.)
Public propertyDidFootprintChange (Inherited from Entity2D.)
Public propertyDrawArea (Inherited from Polygon2D.)
Public propertyIsActive (Inherited from DrawableEntity.)
Public propertyIsPauseable (Inherited from Entity.)
Public propertyIsVisible (Inherited from DrawableEntity.)
Public propertyLastColor (Inherited from Entity2D.)
Public propertyLastDrawArea (Inherited from Entity2D.)
Public propertyMaximum
Public propertyMaxWidth
Public propertyMinimum
Public propertyNumberOfComponents (Inherited from Entity.)
Public propertyPercentage
Public propertyPercentileColors
Public propertyPoints (Inherited from Polygon2D.)
Public propertyRenderLayer (Inherited from DrawableEntity.)
Public propertyRotation (Inherited from Entity2D.)
Public propertyRotationCenter (Inherited from Entity2D.)
Public propertySize (Inherited from Entity2D.)
Public propertyTopLeft (Inherited from Entity2D.)
Public propertyUpdatePriority (Inherited from Entity.)
Public propertyValue
Top
Remarks

Tests: DeltaEngine.Scenes.Tests.Controls.PercentageBarTests
Examples

16 unit tests call DeltaEngine.Scenes.Controls.PercentageBar
[Test]
public void RenderShrinkingLeftAlignedBar()
{
    bar.Start<Shrink>();
}
[Test]
public void RenderShrinkingCenterAlignedBar()
{
    bar.Alignment = PercentageBar.HorizontalAlignment.Center;
    bar.Start<Shrink>();
}
[Test, CloseAfterFirstFrame]
public void DefaultValues()
{
    Assert.AreEqual(0, bar.Minimum);
    Assert.AreEqual(100, bar.Maximum);
    Assert.AreEqual(100, bar.Value);
    Assert.AreEqual(Center, bar.DrawArea);
    Assert.AreEqual(Width, bar.MaxWidth);
    Assert.AreEqual(HighColor, bar.Color);
    Assert.AreEqual(PercentileColors, bar.PercentileColors);
    Assert.AreEqual(PercentageBar.HorizontalAlignment.Left, bar.Alignment);
}
See Also