Animar movimentos usando a física de molas

Testar o Compose

O Jetpack Compose é o kit de ferramentas de interface recomendado para Android. Aprenda a usar animações no Compose.

AnimationSpec do Spring →

O movimento baseado em física é impulsionado pela força. A força elástica é uma dessas forças que orienta a interatividade e o movimento. Uma força elástica tem as seguintes propriedades: amortecimento e rigidez. Em uma animação baseada em mola, o valor e a velocidade são calculados com base na força elástica aplicada em cada frame.

Se você quiser que as animações do seu app desacelerem em apenas uma direção, use uma animação de rolagem baseada em atrito.

Ciclo de vida de uma animação de mola

Em uma animação baseada em mola, a classe SpringForce permite personalizar a rigidez da mola, a proporção de amortecimento e a posição final. Assim que a animação começa, a força elástica atualiza o valor da animação e a velocidade em cada frame. A animação continua até que a força elástica atinja um equilíbrio.

Por exemplo, se você arrastar um ícone de app pela tela e depois soltá-lo levantando o dedo, o ícone voltará ao lugar original por uma força invisível, mas familiar.

A Figura 1 demonstra um efeito de mola semelhante. O sinal de adição (+) no meio do círculo indica a força aplicada por um gesto de toque.

Criar uma animação de mola

As etapas gerais para criar uma animação de mola para seu aplicativo são as seguintes:

• Adicionar a Biblioteca de Suporte É preciso adicionar a Biblioteca de Suporte ao projeto para usar as classes de animação de mola.
• Criar uma animação de mola: a principal etapa é criar uma instância da classe SpringAnimation e definir os parâmetros de comportamento de movimento.
• Registrar listeners(opcional): registre listeners para observar mudanças no ciclo de vida e atualizações do valor da animação.

  Observação:registre o listener de atualização somente se você precisar de uma atualização por frame sobre as mudanças de valor da animação. Um listener de atualização impede que a animação seja executada em uma linha de execução separada.

• Remover listeners(opcional): remova os listeners que não estão mais em uso.
• Definir um valor inicial(opcional): personalize o valor inicial da animação.
• Definir um intervalo de valores(opcional): defina o intervalo de valores de animação para restringir os valores nos intervalos mínimo e máximo.
• Definir a velocidade inicial(opcional): defina a velocidade inicial da animação.
• Definir as propriedades da mola(opcional): defina a proporção de amortecimento e a rigidez na mola.
• Criar uma mola personalizada(opcional): crie uma mola personalizada caso você não pretenda usar a mola padrão ou queira usar uma mola comum em toda a animação.
• Iniciar animação: inicie a animação de mola.
• Cancelar animação(opcional): cancele a animação caso o usuário saia do app repentinamente ou a visualização se torne invisível.

As seções a seguir discutem em detalhes as etapas gerais da criação de uma animação de mola.

Adicionar a Biblioteca de Suporte

Para usar a Biblioteca de Suporte baseada em física, adicione-a ao seu projeto da seguinte maneira:

1. Abra o arquivo build.gradle relativo ao módulo do seu app.

2. Adicione a Biblioteca de Suporte à seção dependencies.

   Groovy

           dependencies {
               def dynamicanimation_version = '1.0.0'
               implementation "androidx.dynamicanimation:dynamicanimation:$dynamicanimation_version"
           }
           

   Kotlin

           dependencies {
               val dynamicanimation_version = "1.0.0"
               implementation("androidx.dynamicanimation:dynamicanimation:$dynamicanimation_version")
           }
           

   Para visualizar as versões atuais dessa biblioteca, consulte as informações sobre DynamicAnimation na página de versões.

Criar uma animação de mola

A classe SpringAnimation permite criar uma animação de mola para um objeto. Para criar uma animação de mola, você precisa criar uma instância da classe SpringAnimation e fornecer um objeto, uma propriedade de objeto a ser animada e uma posição final opcional em que a animação deve ficar.

Observação:no momento da criação de uma animação de mola, a posição final dela é opcional. No entanto, ela precisa ser definida antes do início da animação.

val springAnim = findViewById<View>(R.id.imageView).let { img ->
    // Setting up a spring animation to animate the view’s translationY property with the final
    // spring position at 0.
    SpringAnimation(img, DynamicAnimation.TRANSLATION_Y, 0f)
}

final View img = findViewById(R.id.imageView);
// Setting up a spring animation to animate the view’s translationY property with the final
// spring position at 0.
final SpringAnimation springAnim = new SpringAnimation(img, DynamicAnimation.TRANSLATION_Y, 0);

A animação baseada em mola pode animar visualizações na tela mudando as propriedades reais nos objetos de visualização. As visualizações a seguir estão disponíveis no sistema:

• ALPHA: representa a transparência Alfa na visualização. O valor é 1 (opaco) por padrão, sendo que o valor 0 representa transparência total (não visível).
• TRANSLATION_X, TRANSLATION_Y e TRANSLATION_Z: essas propriedades controlam onde a visualização está localizada como um delta a partir da coordenada esquerda, coordenada superior e elevação, que são definidas pelo contêiner de layout.
  • TRANSLATION_X descreve a coordenada esquerda.
  • TRANSLATION_Y descreve a coordenada superior.
  • TRANSLATION_Z descreve a profundidade da visualização em relação à elevação.
• ROTATION, ROTATION_X e ROTATION_Y: essas propriedades controlam a rotação em 2D (propriedade rotation) e em 3D ao redor do ponto de rotação.
• SCROLL_X e SCROLL_Y: essas propriedades indicam o deslocamento de rolagem da origem esquerda e da borda superior em pixels. Ele também indica a posição em termos de quanto a página é rolada.
• SCALE_X e SCALE_Y: essas propriedades controlam o escalonamento 2D de uma visualização ao redor do ponto de rotação.
• X, Y e Z: são propriedades utilitárias básicas para descrever o local final da visualização no contêiner.
  • X é uma soma do valor esquerdo e TRANSLATION_X.
  • Y é uma soma do valor principal e TRANSLATION_Y.
  • Z é uma soma do valor de elevação e TRANSLATION_Z.

Registrar listeners

A classe DynamicAnimation fornece dois listeners: OnAnimationUpdateListener e OnAnimationEndListener. Esses listeners ouvem as atualizações na animação, como quando há uma mudança no valor da animação e quando ela termina.

OnAnimationUpdateListener

Quando você quiser animar várias visualizações para criar uma animação encadeada, configure OnAnimationUpdateListener para receber um callback sempre que houver uma mudança na propriedade da visualização atual. O callback notifica a outra visualização para atualizar a posição da mola com base na mudança feita na propriedade da visualização atual. Para registrar o listener, siga estas etapas:

1. Chame o método addUpdateListener() e anexe o listener à animação.

   Observação:é necessário registrar o listener de atualização antes que a animação comece. No entanto, registre o listener de atualização somente se precisar de uma atualização por frame sobre as mudanças de valor da animação. Um listener de atualização impede que a animação seja executada em uma linha de execução separada.

2. Modifique o método onAnimationUpdate() para notificar o autor da chamada sobre a mudança no objeto atual. O exemplo de código a seguir ilustra o uso geral de OnAnimationUpdateListener.

// Setting up a spring animation to animate the view1 and view2 translationX and translationY properties
val (anim1X, anim1Y) = findViewById<View>(R.id.view1).let { view1 ->
    SpringAnimation(view1, DynamicAnimation.TRANSLATION_X) to
            SpringAnimation(view1, DynamicAnimation.TRANSLATION_Y)
}
val (anim2X, anim2Y) = findViewById<View>(R.id.view2).let { view2 ->
    SpringAnimation(view2, DynamicAnimation.TRANSLATION_X) to
            SpringAnimation(view2, DynamicAnimation.TRANSLATION_Y)
}

// Registering the update listener
anim1X.addUpdateListener { _, value, _ ->
    // Overriding the method to notify view2 about the change in the view1’s property.
    anim2X.animateToFinalPosition(value)
}

anim1Y.addUpdateListener { _, value, _ -> anim2Y.animateToFinalPosition(value) }

// Creating two views to demonstrate the registration of the update listener.
final View view1 = findViewById(R.id.view1);
final View view2 = findViewById(R.id.view2);

// Setting up a spring animation to animate the view1 and view2 translationX and translationY properties
final SpringAnimation anim1X = new SpringAnimation(view1,
        DynamicAnimation.TRANSLATION_X);
final SpringAnimation anim1Y = new SpringAnimation(view1,
    DynamicAnimation.TRANSLATION_Y);
final SpringAnimation anim2X = new SpringAnimation(view2,
        DynamicAnimation.TRANSLATION_X);
final SpringAnimation anim2Y = new SpringAnimation(view2,
        DynamicAnimation.TRANSLATION_Y);

// Registering the update listener
anim1X.addUpdateListener(new DynamicAnimation.OnAnimationUpdateListener() {

// Overriding the method to notify view2 about the change in the view1’s property.
    @Override
    public void onAnimationUpdate(DynamicAnimation dynamicAnimation, float value,
                                  float velocity) {
        anim2X.animateToFinalPosition(value);
    }
});

anim1Y.addUpdateListener(new DynamicAnimation.OnAnimationUpdateListener() {

  @Override
    public void onAnimationUpdate(DynamicAnimation dynamicAnimation, float value,
                                  float velocity) {
        anim2Y.animateToFinalPosition(value);
    }
});

OnAnimationEndListener

OnAnimationEndListener notifica o final de uma animação. É possível configurar o listener para receber um callback sempre que a animação atingir o equilíbrio ou for cancelada. Para registrar o listener, siga estas etapas:

1. Chame o método addEndListener() e anexe o listener à animação.
2. Modifique o método onAnimationEnd() para receber uma notificação sempre que uma animação atingir o equilíbrio ou for cancelada.

Remover listeners

Para deixar de receber callbacks de atualização e de fim de animação, chame os métodos removeUpdateListener() e removeEndListener(), respectivamente.

Definir o valor inicial da animação

Para definir o valor inicial da animação, chame o método setStartValue() e transmita o valor inicial da animação. Se você não definir o valor inicial, a animação usará o valor atual da propriedade do objeto como o valor inicial.

Definir intervalo de valores de animação

Você pode definir os valores mínimo e máximo de animação quando quiser restringir o valor da propriedade a um determinado intervalo. Isso também ajuda a controlar o intervalo caso você anime propriedades que tenham um intervalo intrínseco, como Alfa (de 0 a 1).

• Para definir o valor mínimo, chame o método setMinValue() e transmita o valor mínimo da propriedade.
• Para definir o valor máximo, chame o método setMaxValue() e transmita o valor máximo da propriedade.

Ambos os métodos retornam a animação para a qual o valor está sendo definido.

Observação:se você definiu o valor inicial e um intervalo de valores de animação, verifique se o valor inicial está dentro do intervalo mínimo e máximo.

Definir a velocidade inicial

A velocidade inicial define a velocidade com que a propriedade muda no início da animação. A velocidade inicial padrão é definida como zero pixel por segundo. É possível definir a velocidade com a velocidade dos gestos de toque ou usando um valor fixo como a velocidade inicial. Se você quiser fornecer um valor fixo, recomendamos defini-lo em dp por segundo e convertê-lo em pixels por segundo. A definição do valor em dp por segundo permite que a velocidade seja independente da densidade e dos formatos. Para mais informações sobre como converter o valor em pixels por segundo, consulte a seção Converter dp por segundo em pixels por segundo.

Para definir a velocidade, chame o método setStartVelocity() e transmita a velocidade em pixels por segundo. O método retorna o objeto de força elástica em que a velocidade está definida.

Observação:use os métodos de classe GestureDetector.OnGestureListener ou VelocityTracker para recuperar e calcular a velocidade dos gestos de toque.

findViewById<View>(R.id.imageView).also { img ->
    SpringAnimation(img, DynamicAnimation.TRANSLATION_Y).apply {
        …
        // Compute velocity in the unit pixel/second
        vt.computeCurrentVelocity(1000)
        val velocity = vt.yVelocity
        setStartVelocity(velocity)
    }
}

final View img = findViewById(R.id.imageView);
final SpringAnimation anim = new SpringAnimation(img, DynamicAnimation.TRANSLATION_Y);
…
// Compute velocity in the unit pixel/second
vt.computeCurrentVelocity(1000);
float velocity = vt.getYVelocity();
anim.setStartVelocity(velocity);

Converter dp por segundo em pixels por segundo

A velocidade de uma mola precisa ser definida em pixels por segundo. Se você optar por informar um valor fixo como o início da velocidade, defina o valor em dp por segundo e, em seguida, converta-o em pixels por segundo. Para conversão, use o método applyDimension() da classe TypedValue. Consulte o exemplo de código a seguir:

val pixelPerSecond: Float =
    TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_DIP, dpPerSecond, resources.displayMetrics)

float pixelPerSecond = TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_DIP, dpPerSecond, getResources().getDisplayMetrics());

Definir propriedades da mola

A classe SpringForce define os métodos getter e setter para cada uma das propriedades da mola, como a proporção de amortecimento e a rigidez. Para definir as propriedades da mola, é importante recuperar o objeto de força elástica ou criar uma força elástica personalizada em que você possa definir as propriedades. Para mais informações sobre como criar uma força elástica personalizada, consulte a seção Como criar uma força elástica personalizada.

Dica: ao usar os métodos setter, você pode criar uma cadeia de métodos, já que todos os métodos setter retornam o objeto de força elástica.

Proporção de amortecimento

A proporção de amortecimento descreve uma redução gradual na oscilação da mola. Ao usar a proporção de amortecimento, é possível definir a velocidade com que as oscilações diminuem de uma oscilação para a próxima. Há quatro maneiras diferentes de amortecer uma mola:

• O amortecimento excessivo ocorre quando a proporção é maior que um. Permite que o objeto retorne suavemente à posição de repouso.
• O amortecimento crítico ocorre quando a proporção é igual a um. Ele permite que o objeto retorne à posição de repouso no menor tempo possível.
• O amortecimento insuficiente ocorre quando a proporção é inferior a um. Ele permite que o objeto ultrapasse várias vezes, passando pela posição de repouso e, em seguida, alcançando gradualmente a posição de repouso.
• O não amortecimento ocorre quando a proporção é igual a zero. Ele permite que o objeto oscile para sempre.

Para adicionar a proporção de amortecimento à mola, siga estas etapas:

1. Chame o método getSpring() para recuperar a mola e adicionar a proporção de amortecimento.
2. Chame o método setDampingRatio() e transmita a proporção de amortecimento que você quer adicionar à mola. O método retorna o objeto de força elástica em que a proporção de amortecimento está definida.

   Observação:a proporção de amortecimento precisa ser um número não negativo. Se você definir a proporção de amortecimento como zero, a mola nunca atingirá a posição de repouso. Em outras palavras, ele oscilará para sempre.

As seguintes constantes de proporção de amortecimento estão disponíveis no sistema:

• DAMPING_RATIO_HIGH_BOUNCY
• DAMPING_RATIO_MEDIUM_BOUNCY
• DAMPING_RATIO_LOW_BOUNCY
• DAMPING_RATIO_NO_BOUNCY

Figura 2: oscilação alta

Figura 3: oscilação médio

Figura 4: oscilação baixa

Figura 5: sem oscilação

A proporção de amortecimento padrão é definida como DAMPING_RATIO_MEDIUM_BOUNCY.

findViewById<View>(R.id.imageView).also { img ->
    SpringAnimation(img, DynamicAnimation.TRANSLATION_Y).apply {
        …
        // Setting the damping ratio to create a low bouncing effect.
        spring.dampingRatio = SpringForce.DAMPING_RATIO_LOW_BOUNCY
        …
    }
}

final View img = findViewById(R.id.imageView);
final SpringAnimation anim = new SpringAnimation(img, DynamicAnimation.TRANSLATION_Y);
…
// Setting the damping ratio to create a low bouncing effect.
anim.getSpring().setDampingRatio(SpringForce.DAMPING_RATIO_LOW_BOUNCY);
…

a rigidez

A rigidez define a constante da mola, que mede a força da mola. Uma mola rígida aplica mais força ao objeto anexado quando ela não está na posição de repouso. Para adicionar rigidez à mola, siga estas etapas:

1. Chame o método getSpring() para recuperar a mola e adicionar rigidez.
2. Chame o método setStiffness() e transmita o valor de rigidez que você quer adicionar à mola. O método retorna o objeto de força elástica em que a rigidez está definida.

   Observação:a rigidez precisa ser um número positivo.

As seguintes constantes de rigidez estão disponíveis no sistema:

• STIFFNESS_HIGH
• STIFFNESS_MEDIUM
• STIFFNESS_LOW
• STIFFNESS_VERY_LOW

Figura 6: rigidez alta

Figura 7: rigidez média

Figura 8: rigidez baixa

Figura 9: rigidez muito baixa

A rigidez padrão é definida como STIFFNESS_MEDIUM.

findViewById<View>(R.id.imageView).also { img ->
    SpringAnimation(img, DynamicAnimation.TRANSLATION_Y).apply {
        …
        // Setting the spring with a low stiffness.
        spring.stiffness = SpringForce.STIFFNESS_LOW
        …
    }
}

final View img = findViewById(R.id.imageView);
final SpringAnimation anim = new SpringAnimation(img, DynamicAnimation.TRANSLATION_Y);
…
// Setting the spring with a low stiffness.
anim.getSpring().setStiffness(SpringForce.STIFFNESS_LOW);
…

Criar uma força elástica personalizada

Você pode criar uma força elástica personalizada como alternativa ao uso da força elástica padrão. A força elástica personalizada permite compartilhar a mesma instância de força elástica em várias animações. Depois de criar a força elástica, é possível definir propriedades como a proporção de amortecimento e a rigidez.

1. Crie um objeto SpringForce.

   SpringForce force = new SpringForce();

2. Atribua as propriedades chamando os respectivos métodos. Também é possível criar uma cadeia de métodos.

   force.setDampingRatio(DAMPING_RATIO_LOW_BOUNCY).setStiffness(STIFFNESS_LOW);

3. Chame o método setSpring() para definir a mola da animação.

   setSpring(force);

Iniciar animação

Há duas maneiras de iniciar uma animação de mola: chamando start() ou o método animateToFinalPosition(). Os dois métodos precisam ser chamados na linha de execução principal.

animateToFinalPosition() executa duas tarefas:

• Definir a posição final da mola.
• Iniciar a animação, se ela não tiver sido iniciada.

Como o método atualiza a posição final da mola e inicia a animação, se necessário, você pode chamar esse método a qualquer momento para mudar o curso de uma animação. Por exemplo, em uma animação de mola encadeada, a animação de uma visualização depende de outra. Para esse tipo de animação, é mais conveniente usar o método animateToFinalPosition(). Ao usar esse método em uma animação de mola encadeada, você não precisa se preocupar se a animação que você quer atualizar em seguida está em execução.

A Figura 10 ilustra uma animação de mola encadeada, em que a animação de uma visualização depende de outra.

Para usar o método animateToFinalPosition(), chame o método animateToFinalPosition() e transmita a posição de repouso da mola. Você também pode definir a posição de repouso da mola chamando o método setFinalPosition().

O método start() não define o valor da propriedade como o valor inicial imediatamente. O valor da propriedade muda a cada pulso da animação, o que acontece antes da passagem do desenho. Como resultado, as alterações são refletidas no frame seguinte, como se os valores fossem definidos imediatamente.

findViewById<View>(R.id.imageView).also { img ->
    SpringAnimation(img, DynamicAnimation.TRANSLATION_Y).apply {
        …
        // Starting the animation
        start()
        …
    }
}

final View img = findViewById(R.id.imageView);
final SpringAnimation anim = new SpringAnimation(img, DynamicAnimation.TRANSLATION_Y);
…
// Starting the animation
anim.start();
…

Cancelar animação

Você pode cancelar ou pular para o final da animação. Uma situação ideal em que é necessário cancelar ou pular para o final da alteração é quando uma interação do usuário exige que a animação seja encerrada imediatamente. Isso ocorre principalmente quando o usuário sai de um app de forma abrupta ou a visualização se torna invisível.

Há dois métodos que você pode usar para encerrar a animação. O método cancel() encerra a animação no valor em que está. O método skipToEnd() pula a animação para o valor final e a encerra.

Antes de encerrar a animação, é importante verificar primeiro o estado da mola. Se o estado não for amortecido, a animação nunca alcançará a posição de repouso. Para verificar o estado da mola, chame o método canSkipToEnd(). Se a mola for amortecida, o método retornará true. Caso contrário, false.

Depois de saber o estado da mola, você pode encerrar uma animação usando o método skipToEnd() ou cancel(). O método cancel() precisa ser chamado apenas na linha de execução principal.

Observação:em geral, o método skipToEnd() causa um salto visual.