Class AnimatedVectorImageView

Definition

Namespace:
Tizen.NUI.BaseComponents
Assembly:
Tizen.NUI.dll

AnimatedVectorImageView is a class for displaying a vector resource.

public class AnimatedVectorImageView : LottieAnimationView, IDynamicResourceHandler, INameScope, System.IDisposable, IResourcesProvider
Inheritance
object
BindableObject
Element
BaseHandle
Animatable
Container
View
ImageView
LottieAnimationView
AnimatedVectorImageView
Implements
IDynamicResourceHandler
INameScope
System.IDisposable
IResourcesProvider

Constructors

View Source

AnimatedVectorImageView()

Construct VectorAnimationView.

Declaration
public AnimatedVectorImageView()
View Source

AnimatedVectorImageView(float)

Construct VectorAnimationView.

Declaration
public AnimatedVectorImageView(float scale)
Parameters
Type Name Description
float scale

Set scaling factor for Vector Animation, while creating.

Fields

View Source

CurrentFrameProperty

CurrentFrameProperty

Declaration
public static readonly BindableProperty CurrentFrameProperty
Field Value
Type Description
BindableProperty
View Source

RepeatCountProperty

RepeatCountProperty

Declaration
public static readonly BindableProperty RepeatCountProperty
Field Value
Type Description
BindableProperty
View Source

RepeatModeProperty

RepeatModeProperty

Declaration
public static readonly BindableProperty RepeatModeProperty
Field Value
Type Description
BindableProperty
View Source

ResourceUrlProperty

ResourceUrlProperty

Declaration
public static readonly BindableProperty ResourceUrlProperty
Field Value
Type Description
BindableProperty
View Source

ResourceURLProperty

ResourceURLProperty

Declaration
public static readonly BindableProperty ResourceURLProperty
Field Value
Type Description
BindableProperty

Properties

View Source

AnimationState

Get state of animation.

Declaration
public AnimatedVectorImageView.AnimationStates AnimationState { get; }
Property Value
Type Description
AnimatedVectorImageView.AnimationStates
View Source

CurrentFrame

CurrentFrame of animation.

Declaration
public int CurrentFrame { get; set; }
Property Value
Type Description
int

Returns user set value for the current frame. Cannot provide actual playing current frame.
View Source

RepeatCount

RepeatCount of animation. The repeat count is 0 by default. If the RepeatCount is 0, the animation is never repeated. If the RepeatCount is greater than 0, the repeat mode will be taken into account. If RepeatCount is -1, animation is infinite loops.

Declaration
public int RepeatCount { get; set; }
Property Value
Type Description
int
View Source

RepeatMode

RepeatMode of animation.

Declaration
public AnimatedVectorImageView.RepeatModes RepeatMode { get; set; }
Property Value
Type Description
AnimatedVectorImageView.RepeatModes
View Source

ResourceUrl

Set Resource URL

Declaration
public string ResourceUrl { get; set; }
Property Value
Type Description
string
View Source

ResourceURL

Set Resource URL

Declaration
public string ResourceURL { get; set; }
Property Value
Type Description
string
View Source

TotalFrame

TotalFrame of animation. If resouce is still not be loaded, or invalid resource, the value is 0.

Declaration
public int TotalFrame { get; }
Property Value
Type Description
int

Methods

View Source

Dispose(DisposeTypes)

You can override it to clean-up your own resources

Declaration
protected override void Dispose(DisposeTypes type)
Parameters
Type Name Description
DisposeTypes type

DisposeTypes
Overrides
View Source

Pause()

Pause Animation.

Declaration
public void Pause()
View Source

Play()

Play Animation.

Declaration
public void Play()
View Source

SetMinAndMaxFrame(int, int)

Set minimum frame and maximum frame

Declaration
public void SetMinAndMaxFrame(int minFrame, int maxFrame)
Parameters
Type Name Description
int minFrame

minimum frame.
int maxFrame

maximum frame.
View Source

SetMinAndMaxFrameByMarker(string, string)

Set minimum frame and maximum frame by marker. Animation will play between the start frame and the end frame of the marker if one marker is specified. Or animation will play between the start frame of the first marker and the end frame of the second marker if two markers are specified.

Declaration
public void SetMinAndMaxFrameByMarker(string marker1, string marker2 = null)
Parameters
Type Name Description
string marker1

First marker
string marker2

Second marker
Remarks

If we use invaliad markers, or we load image asynchronous and load is not finished yet, CurrentFrame might not be matched with real value.

View Source

SetMinMaxFrame(int, int)

SetMinMaxFrame(int startFrame, int endFrame)

Declaration
public void SetMinMaxFrame(int minFrame, int maxFrame)
Parameters
Type Name Description
int minFrame
int maxFrame
View Source

SetMinMaxFrameByMarker(string, string)

A marker has its start frame and end frame. Animation will play between the start frame and the end frame of the marker if one marker is specified. Or animation will play between the start frame of the first marker and the end frame of the second marker if two markers are specified.

Declaration
public void SetMinMaxFrameByMarker(string marker1, string marker2 = null)
Parameters
Type Name Description
string marker1

First marker
string marker2

Second marker
View Source

Stop(EndActions)

Stop Animation.

Declaration
public void Stop(AnimatedVectorImageView.EndActions endAction = default)
Parameters
Type Name Description
AnimatedVectorImageView.EndActions endAction

Defines, what should be behaviour after cancel operation End action is Cancel, Animation Stops at the Current Frame. End action is Discard, Animation Stops at the Min Frame End action is StopFinal, Animation Stops at the Max Frame

Implements

System.IDisposable

Extension Methods