Difference between revisions of "LGUI2:LS1:lgui2animation"
Jump to navigation
Jump to search
(Created page with "{{ObjectType-Vitals|lgui2animation|LavishGUI 2|none|Same as '''Name'''|none|no|void *}} A lgui2animation object provides access to Animation properties...") |
|||
Line 1: | Line 1: | ||
{{ObjectType-Vitals|lgui2animation|[[LavishGUI 2]]|none|Same as '''Name'''|none|no|void *}} | {{ObjectType-Vitals|lgui2animation|[[LavishGUI 2]]|none|Same as '''Name'''|none|no|void *}} | ||
A lgui2animation object provides access to [[LGUI2:Animation|Animation]] properties | A lgui2animation object provides access to [[LGUI2:Animation|Animation]] properties | ||
+ | |||
== Members == | == Members == | ||
Line 14: | Line 15: | ||
* [[ObjectType:uint|uint]] '''StartTimestamp''': The Animation's Start time (milliseconds) | * [[ObjectType:uint|uint]] '''StartTimestamp''': The Animation's Start time (milliseconds) | ||
* [[ObjectType:uint|uint]] '''LastFrameTimestamp''': The Animation's last frame (milliseconds) | * [[ObjectType:uint|uint]] '''LastFrameTimestamp''': The Animation's last frame (milliseconds) | ||
+ | * [[ObjectType:float|float]] '''Duration''': Specified duration (total expected length of time) of the Animation, in seconds | ||
+ | * [[ObjectType:uint|uint]] '''DurationMS''': Specified duration (total expected length of time) of the Animation, in milliseconds | ||
+ | * [[ObjectType:bool|bool]] '''IsInstant''': TRUE if the Animation has no duration and is defined as instant. If the Animation has no duration and IsInstant is FALSE, the Animation has no defined duration and may run indefinitely (or until Stopped). | ||
+ | |||
== Methods == | == Methods == | ||
Line 19: | Line 24: | ||
* '''Stop''': Stop the Animation | * '''Stop''': Stop the Animation | ||
* '''Toggle''': Start/Stop the Animation | * '''Toggle''': Start/Stop the Animation | ||
+ | |||
== Examples == | == Examples == |
Revision as of 01:37, 17 November 2018
lgui2animation | |
Defined By | LavishGUI 2 |
Inherits | none |
Reduces To | Same as Name |
Variable Object Type | none |
Uses Sub-Types | no |
C/C++ Type | void * |
A lgui2animation object provides access to Animation properties
Members
- unistring Name: The name of the Animation
- lgui2element Element: The Element being animated
- lgui2animationtype Type: The Animation Type doing the animating
- jsonobject Parameters: Parameters used to create the Animation. Any changes/additions to this object are kept for the lifetime of the Animation.
- bool IsRunning: TRUE if the Animation is running
- float RunningTime: Running time (elapsed time) of the Animation, in seconds
- uint RunningTimeMS: Running time (elapsed time) of the Animation, in milliseconds
- float FrameElapsedTime: Elapsed time since the last Animatioon frame, in seconds
- uint FrameElapsedTimeMS: Elapsed time since the last Animatioon frame, in milliseconds
- uint StartTimestamp: The Animation's Start time (milliseconds)
- uint LastFrameTimestamp: The Animation's last frame (milliseconds)
- float Duration: Specified duration (total expected length of time) of the Animation, in seconds
- uint DurationMS: Specified duration (total expected length of time) of the Animation, in milliseconds
- bool IsInstant: TRUE if the Animation has no duration and is defined as instant. If the Animation has no duration and IsInstant is FALSE, the Animation has no defined duration and may run indefinitely (or until Stopped).
Methods
- Start: Start the Animation
- Stop: Stop the Animation
- Toggle: Start/Stop the Animation
Examples
LavishGUI 2 Element Types
- Base Element Types: Element - Content Container - Headered Content Container - Item List
- Layout: anchor - border - dockpanel - dragger - expander - hud - map - page - pagecontrol -panel - popup - radialpanel - screen - scrollviewer - stackpanel - tab - tabcontrol - table - treepanel - window - wrappanel
- Display: canvas - imagebox - progressbar - radialgauge - textblock
- Interaction: button - checkbox - combobox - contextmenu - dragin - filepicker - itemview - knob - listbox - mapitemview - objectview - propertyview - scrollbar - sensitivebutton - slider - textbox
LavishGUI 2 LavishScript Object Types
- Core API (see Using LavishGUI 2 from LavishScript)
- lgui2 - lgui2animateargs - lgui2animationtype - lgui2elementref - lgui2eventargs - lgui2eventhandler - lgui2elementtype - lgui2itemviewgeneratorargs - lgui2inputbinding - lgui2layer - lgui2skin - lgui2trigger
- Enums
- elgui2animationframestate - elgui2dpad - elgui2edge - elgui2fontflags - elgui2horizontalalignment - elgui2imageorientation - elgui2progresstext - elgui2scrollbar - elgui2sizetocontent - elgui2verticalignment - elgui2visibility
- Element Components
- lgui2animation - lgui2brush - lgui2fontstyle - lgui2margins - lgui2item - lgui2property - lgui2radialitem - lgui2radialgaugeneedle
- Element Base Types
- lgui2element - lgui2bordered - lgui2contentbase - lgui2headeredcontentbase - lgui2itemlist
- Elements
- Layout: lgui2anchor - lgui2border - lgui2dockpanel - lgui2dragger - lgui2expander - lgui2hud - lgui2map - lgui2page - lgui2pagecontrol - lgui2panel - lgui2popup - lgui2radialpanel - lgui2screen - lgui2scrollviewer - lgui2stackpanel - lgui2tab - lgui2tabcontrol - lgui2table - lgui2treepanel - lgui2window - lgui2wrappanel
- Display: lgui2canvas - lgui2imagebox - lgui2progressbar - lgui2radialgauge - lgui2textblock
- Interaction: lgui2button - lgui2checkbox - lgui2combobox - lgui2contextmenu - lgui2dragin - lgui2filepicker - lgui2itemview - lgui2knob - lgui2listbox - lgui2mapitemview - lgui2objectview - lgui2propertyview - lgui2scrollbar - lgui2sensitivebutton - lgui2slider - lgui2textbox