DgsAlphaTo: Difference between revisions

Latest revision as of 17:05, 2 March 2023

This function allow us to add animation to dgs elements.

Change alpha of dgs elements with animation effect.

Syntax

number/table dgsAlphaTo ( element/table dgsElement, float targetAlpha, string easing = "Linear", float duration [, int delay = 0 ] )

Required Arguments

dgsElement: The DGS element or a list of DGS elements to set animation to.
targetAlpha: Target alpha of dgs element.
easing: The easing function to use for the interpolation (For More Detail :Easing), or your own easing function created by dgsAddEasingFunction.
duration: An integer of the time(ms) to finish the animation.

Optional Arguments

delay: The delay time before the animation start, can decrease the using of timer.

Returns

Returns an integer/table indicates the animation ID or a list of animation IDs if succeed, false otherwise.

Example

DGS = exports.dgs

parent = DGS:dgsCreateWindow(200,100,400,400,"DGS Parent Window",false)	--Create a window
DGS:dgsSetAlpha(parent,0)
DGS:dgsAlphaTo(parent,1,"OutQuad",2000)  --set alpha with animation effect.

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

dgsCreateBrowser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

dgsCreateCanvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips

@@ Line 6: / Line 6: @@
 ==Syntax==
 <syntaxhighlight lang="lua">
-bool dgsAlphaTo ( element dgsElement, float targetAlpha, bool movetype, string easing = "Linear", float torv [, table settings ])
+number/table dgsAlphaTo ( element/table dgsElement, float targetAlpha, string easing = "Linear", float duration [, int delay = 0 ] )
 </syntaxhighlight>
 ===Required Arguments===
-*'''dgsElement:''' The DGS element to set animation to.
+*'''dgsElement:''' The DGS element or a list of DGS elements to set animation to.
 *'''targetAlpha:''' Target alpha of dgs element.
-*'''movetype:''' A bool that indicates whether the move type is based on Time or Speed.( For stable and easy, we always pass '''false''' to this argument)
+*'''easing:''' The easing function to use for the interpolation (For More Detail :[[Easing]]), or your own easing function created by [[dgsAddEasingFunction]].
-*'''easing:''' The easing function to use for the interpolation (For More Detail :[[Easing]]), or your own easing function created by [[addEasingFunction]].
+*'''duration:''' An integer of the time(ms) to finish the animation.
-*'''torv:''' This is depends on '''movetype'''. If '''movetype''' sets to false, the torv will be the time(ms) to finish the animation, or it will be a static velocity to finish the animation.
-*'''settings:''' A table will be passed to your own easing function.
+===Optional Arguments===
+*'''delay:''' The delay time before the animation start, can decrease the using of timer.
 ===Returns===
-Returns true if succeed, ''false'' otherwise.
+Returns an ''integer''/''table'' indicates the animation ID or a list of animation IDs if succeed, ''false'' otherwise.
 ==Example==
@@ Line 24: / Line 25: @@
 DGS = exports.dgs
-parent = DGS:dgsDxCreateWindow(200,100,400,400,"DGS Parent Window",false)	--Create a window
+parent = DGS:dgsCreateWindow(200,100,400,400,"DGS Parent Window",false)	--Create a window
-DGS:dgsDxGUISetAlpha(parent,0)
+DGS:dgsSetAlpha(parent,0)
-DGS:dgsAlphaTo(parent,1,false,"OutQuad",2000)  --set alpha with animation effect.
+DGS:dgsAlphaTo(parent,1,"OutQuad",2000)  --set alpha with animation effect.
 </syntaxhighlight>
 ==See Also==
 {{DGSFUNCTIONS}}