跳到主要内容

Animated.ValueXY

用于驱动 2D 动画的 2D 值,例如平移手势。API 几乎与普通的 Animated.Value 相同,但进行了多路复用。底层包含两个常规的 Animated.Value

示例


参考

方法

setValue()

tsx
setValue(value: {x: number; y: number});

直接设置值。这将停止在该值上运行的任何动画,并更新所有绑定的属性。

参数

名称类型必需描述
value{x: number; y: number}

setOffset()

tsx
setOffset(offset: {x: number; y: number});

设置一个偏移量,该偏移量应用于通过 setValue、动画或 Animated.event 设置的任何值之上。对于补偿诸如平移手势的开始之类的事情很有用。

参数

名称类型必需描述
offset{x: number; y: number}偏移值

flattenOffset()

tsx
flattenOffset();

将偏移值合并到基础值中,并将偏移量重置为零。该值的最终输出不变。


extractOffset()

tsx
extractOffset();

将偏移值设置为基础值,并将基础值重置为零。该值的最终输出不变。


addListener()

tsx
addListener(callback: (value: {x: number; y: number}) => void);

向值添加一个异步监听器,以便您可以观察来自动画的更新。这很有用,因为无法同步读取该值,因为它可能是由原生驱动的。

返回一个字符串,作为监听器的标识符。

参数

名称类型必需描述
callbackfunction回调函数,它将接收一个对象,该对象的 value 键设置为新值。

removeListener()

tsx
removeListener(id: string);

注销监听器。id 参数应与先前由 addListener() 返回的标识符匹配。

参数

名称类型必需描述
idstring要删除的监听器的 ID。

removeAllListeners()

tsx
removeAllListeners();

删除所有已注册的监听器。


stopAnimation()

tsx
stopAnimation(callback?: (value: {x: number; y: number}) => void);

停止任何正在运行的动画或跟踪。callback 在停止动画后使用最终值调用,这对于更新状态以匹配动画位置与布局很有用。

参数

名称类型必需描述
callbackfunction一个将接收最终值的函数。

resetAnimation()

tsx
resetAnimation(callback?: (value: {x: number; y: number}) => void);

停止任何动画并将值重置为其原始值。

参数

名称类型必需描述
callbackfunction一个将接收原始值的函数。

getLayout()

tsx
getLayout(): {left: Animated.Value, top: Animated.Value};

{x, y} 转换为 {left, top} 以用于样式,例如:

tsx
style={this.state.anim.getLayout()}

getTranslateTransform()

tsx
getTranslateTransform(): [
{translateX: Animated.Value},
{translateY: Animated.Value},
];

{x, y} 转换为可用的 translation 变换,例如:

tsx
style={{
transform: this.state.anim.getTranslateTransform()
}}