Class ButtonAnimation

Allows changing properties of the button to "animate" it as it moves between states (idle, hover, pushed). Each ButtonAnimation represents one of this states, and can have a different animation (or image), border, background color (tint) or text rendering configuration (font, shadows, etc- ITextConfig).

Inheritance

System.Object

ButtonAnimation

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

[ConcreteImplementation(DisplayName = "Button State Animation")]
public class ButtonAnimation

Constructors

| Improve this Doc View Source

ButtonAnimation(IAnimation)

Initializes a new instance of the ButtonAnimation class.

Declaration

public ButtonAnimation(IAnimation animation)

Parameters

Type	Name	Description
IAnimation	animation	Animation.

| Improve this Doc View Source

ButtonAnimation(IAnimation, IBorderStyle, ITextConfig, Nullable<Color>)

Declaration

public ButtonAnimation(IAnimation animation, IBorderStyle border, ITextConfig textConfig, Color? tint)

Parameters

Type	Name	Description
IAnimation	animation
IBorderStyle	border
ITextConfig	textConfig
System.Nullable<Color>	tint

| Improve this Doc View Source

ButtonAnimation(IAnimation, IImage, IBorderStyle, ITextConfig, Nullable<Color>)

Declaration

public ButtonAnimation(IAnimation animation, IImage image, IBorderStyle border, ITextConfig textConfig, Color? tint)

Parameters

Type	Name	Description
IAnimation	animation
IImage	image
IBorderStyle	border
ITextConfig	textConfig
System.Nullable<Color>	tint

| Improve this Doc View Source

ButtonAnimation(IBorderStyle, ITextConfig, Nullable<Color>)

Initializes a new instance of the ButtonAnimation class.

Declaration

public ButtonAnimation(IBorderStyle border, ITextConfig textConfig, Color? tint)

Parameters

Type	Name	Description
IBorderStyle	border	Border.
ITextConfig	textConfig	Text config.
System.Nullable<Color>	tint	Tint.

| Improve this Doc View Source

ButtonAnimation(IImage, Nullable<Color>)

Initializes a new instance of the ButtonAnimation class.

Declaration

public ButtonAnimation(IImage image, Color? tint = default(Color? ))

Parameters

Type	Name	Description
IImage	image	Image.
System.Nullable<Color>	tint	Tint.

Properties

| Improve this Doc View Source

Animation

Gets or sets the animation.

Declaration

public IAnimation Animation { get; }

Property Value

Type	Description
IAnimation	The animation.

| Improve this Doc View Source

Border

Gets or sets the border.

Declaration

public IBorderStyle Border { get; }

Property Value

Type	Description
IBorderStyle	The border.

| Improve this Doc View Source

Image

Gets or sets the image.

Declaration

public IImage Image { get; }

Property Value

Type	Description
IImage

| Improve this Doc View Source

TextConfig

Gets or sets the text rendering configuration.

Declaration

public ITextConfig TextConfig { get; }

Property Value

Type	Description
ITextConfig	The text config.

| Improve this Doc View Source

Tint

Gets or sets the tint (background color).

Declaration

public Color? Tint { get; }

Property Value

Type	Description
System.Nullable<Color>	The tint.

Methods

| Improve this Doc View Source

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()