Picture Class

Delta Engine Documentation

Most basic visible control which is just a Sprite which can change appearance on request View code on GitHub

Inheritance Hierarchy

System Object
  DeltaEngine.Entities Entity
    DeltaEngine.Entities DrawableEntity
      DeltaEngine.Rendering2D Entity2D
        DeltaEngine.Rendering2D HierarchyEntity2D
          DeltaEngine.Rendering2D Sprite
            DeltaEngine.Scenes.Controls Control
              DeltaEngine.Scenes.Controls Picture
                DeltaEngine.Scenes.Controls BaseSlider
                DeltaEngine.Scenes.Controls Label
                DeltaEngine.Scenes.Controls SelectBox

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

Syntax

C++

Copy to Clipboard Print

public class Picture : Control

public class Picture : Control

Public Class Picture 
	Inherits Control

Public Class Picture 
	Inherits Control

public ref class Picture : public Control

public ref class Picture : public Control

type Picture =  
    class 
        inherit Control 
    end

type Picture =  
    class 
        inherit Control 
    end

The Picture type exposes the following members.

Constructors

	Name	Description
	Picture	Initializes a new instance of the Picture class
	Picture(Theme, Material, Rectangle)	Initializes a new instance of the Picture class

Top

Methods

	Name	Description
	Add(HierarchyObject2D)	View code on GitHub (Inherited from HierarchyEntity2D.)
	Add T (T)	(Inherited from Sprite.)
	AddChild	(Inherited from Control.)
	AddTag	View code on GitHub (Inherited from Entity.)
	ClearTags	View code on GitHub (Inherited from Entity.)
	Click	View code on GitHub (Inherited from Control.)
	Contains T	(Inherited from Entity2D.)
	ContainsBehavior T	(Inherited from Entity.)
	ContainsTag	View code on GitHub (Inherited from Entity.)
	Deactivate	(Inherited from Entity.)
	Dispose	View code on GitHub (Inherited from Entity.)
	Get T	(Inherited from Sprite.)
	GetActiveBehaviors	(Inherited from Entity.)
	GetComponentsForEditing	View code on GitHub (Inherited from Entity2D.)
	GetComponentsForSaving	(Inherited from Sprite.)
	GetDrawBehaviors	(Inherited from DrawableEntity.)
	GetFirstChildOfType T	(Inherited from HierarchyEntity2D.)
	GetInterpolatedArray T	(Inherited from DrawableEntity.)
	GetInterpolatedList T	(Inherited from DrawableEntity.)
	GetLevel	(Inherited from Control.)
	GetOrDefault T	(Inherited from Entity.)
	GetTags	View code on GitHub (Inherited from Entity.)
	NextUpdateStarted	(Inherited from Sprite.)
	OnDraw T	(Inherited from DrawableEntity.)
	OnPositionChanged	(Inherited from HierarchyEntity2D.)
	OnRotationChanged	(Inherited from HierarchyEntity2D.)
	Remove(HierarchyObject2D)	View code on GitHub (Inherited from HierarchyEntity2D.)
	Remove T	(Inherited from Entity.)
	RemoveChild	(Inherited from Control.)
	RemoveTag	View code on GitHub (Inherited from Entity.)
	Reset	View code on GitHub (Inherited from Sprite.)
	RotatedDrawAreaContains	View code on GitHub (Inherited from Entity2D.)
	Set	View code on GitHub (Inherited from Sprite.)
	SetAppearance	View code on GitHub
	SetAppearanceWithoutInterpolation	View code on GitHub
	SetComponents	(Inherited from Entity.)
	SetWithoutInterpolation T	(Inherited from Sprite.)
	Start T	(Inherited from Entity.)
	Stop T	(Inherited from Entity.)
	ToggleVisibility	(Inherited from Control.)
	ToString	View code on GitHub (Inherited from Entity.)
	Update	(Inherited from Control.)
	UpdateGlobalsFromParent	(Inherited from HierarchyEntity2D.)

Top

Extension Methods

	Name	Description
	AffixToPhysics	(Defined by Entity2DPhysicsExtensions.)
	StartBouncingOffScreenEdges	(Defined by Entity2DExtensions.)
	StartFalling	(Defined by Entity2DExtensions.)
	StartMoving	(Defined by Entity2DExtensions.)
	StartMovingUV	(Defined by Entity2DExtensions.)
	StartRotating	(Defined by Entity2DExtensions.)

Top

Fields

	Name	Description
	Clicked	(Inherited from Control.)
	components	(Inherited from Entity.)
	lastTickLerpComponents	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

	Name	Description
	Alpha	(Inherited from Entity2D.)
	BlendMode	View code on GitHub (Inherited from Sprite.)
	BottomMargin	(Inherited from Control.)
	Center	View code on GitHub (Inherited from Entity2D.)
	Children	View code on GitHub (Inherited from HierarchyEntity2D.)
	Color	View code on GitHub (Inherited from Entity2D.)
	CurrentFrame	(Inherited from Sprite.)
	DidFootprintChange	(Inherited from Entity2D.)
	DrawArea	View code on GitHub (Inherited from Entity2D.)
	Elapsed	View code on GitHub (Inherited from Sprite.)
	FlipMode	(Inherited from Sprite.)
	IsActive	View code on GitHub (Inherited from Control.)
	IsEnabled	View code on GitHub (Inherited from Control.)
	IsPauseable	View code on GitHub (Inherited from Control.)
	IsPlaying	(Inherited from Sprite.)
	IsVisible	View code on GitHub (Inherited from DrawableEntity.)
	LastColor	View code on GitHub (Inherited from Entity2D.)
	LastDrawArea	View code on GitHub (Inherited from Entity2D.)
	LastUV	View code on GitHub (Inherited from Sprite.)
	LeftMargin	(Inherited from Control.)
	Material	View code on GitHub (Inherited from Sprite.)
	Name	View code on GitHub (Inherited from Control.)
	NumberOfComponents	View code on GitHub (Inherited from Entity.)
	Parent	View code on GitHub (Inherited from HierarchyEntity2D.)
	RelativePosition	View code on GitHub (Inherited from HierarchyEntity2D.)
	RelativeRotation	View code on GitHub (Inherited from HierarchyEntity2D.)
	RenderLayer	View code on GitHub (Inherited from DrawableEntity.)
	RightMargin	(Inherited from Control.)
	Rotation	View code on GitHub (Inherited from Entity2D.)
	RotationCenter	(Inherited from Entity2D.)
	Size	View code on GitHub (Inherited from Entity2D.)
	State	View code on GitHub (Inherited from Control.)
	Theme
	TopLeft	View code on GitHub (Inherited from Entity2D.)
	TopMargin	(Inherited from Control.)
	UpdatePriority	View code on GitHub (Inherited from Entity.)
	UV	View code on GitHub (Inherited from Sprite.)

Top

Events

	Name	Description
	AnimationEnded	(Inherited from Sprite.)

Top

Remarks

Tests: DeltaEngine.Scenes.Tests.Controls.PictureTests

Examples

6 unit tests call DeltaEngine.Scenes.Controls.Picture

Copy to Clipboard Print

[Test, CloseAfterFirstFrame]
public void SaveAndLoad()
{
    var stream = BinaryDataExtensions.SaveToMemoryStream(picture);
    var loadedPicture = (Picture)stream.CreateFromMemoryStream();
    Assert.AreEqual("DeltaEngineLogo", loadedPicture.Material.DiffuseMap.Name);
    Assert.AreEqual("DeltaEngineLogo", loadedPicture.Get<Theme>().SliderPointer.DiffuseMap.Name);
    Assert.AreEqual(Rectangle.HalfCentered, loadedPicture.DrawArea);
}

[Test, CloseAfterFirstFrame]
public void SaveAndLoad()
{
    var stream = BinaryDataExtensions.SaveToMemoryStream(picture);
    var loadedPicture = (Picture)stream.CreateFromMemoryStream();
    Assert.AreEqual("DeltaEngineLogo", loadedPicture.Material.DiffuseMap.Name);
    Assert.AreEqual("DeltaEngineLogo", loadedPicture.Get<Theme>().SliderPointer.DiffuseMap.Name);
    Assert.AreEqual(Rectangle.HalfCentered, loadedPicture.DrawArea);
}

Copy to Clipboard Print

[Test]
public void DrawLoadedPicture()
{
    picture.IsActive = false;
    picture = new Picture(new Theme(), material, Rectangle.HalfCentered);
    var stream = BinaryDataExtensions.SaveToMemoryStream(picture);
    picture.IsActive = false;
    stream.CreateFromMemoryStream();
}

[Test]
public void DrawLoadedPicture()
{
    picture.IsActive = false;
    picture = new Picture(new Theme(), material, Rectangle.HalfCentered);
    var stream = BinaryDataExtensions.SaveToMemoryStream(picture);
    picture.IsActive = false;
    stream.CreateFromMemoryStream();
}

Copy to Clipboard Print

[Test]
public void SetAppearance()
{
    material = new Material(Color.Red);
    picture.SetAppearance(material);
    Assert.AreEqual(material, picture.Material);
    Assert.AreEqual(material.DefaultColor, picture.Color);
}

[Test]
public void SetAppearance()
{
    material = new Material(Color.Red);
    picture.SetAppearance(material);
    Assert.AreEqual(material, picture.Material);
    Assert.AreEqual(material.DefaultColor, picture.Color);
}