Class GuiSvgAnimation

java.lang.Object

com.render.api.gui.GuiSvgAnimation

public final class GuiSvgAnimation
extends Object

Immutable sampled animation for a retained SVG attribute.

Animations use the owning retained view's animation clock. Sampling is quantized to a bounded rate so a value changes only when a new raster frame is due; unchanged samples do not increment the SVG document generation.

Method Summary

Modifier and Type	Method	Description
GuiSvgAnimation	alternating()	Returns a copy that reverses direction on every odd iteration.
static GuiSvgAnimation	color(RenderColor from, RenderColor to, double durationSeconds)	Creates an sRGB color animation serialized as an SVG hexadecimal color.
static GuiSvgAnimation	discrete(double durationSeconds, String... values)	Creates a discrete animation that advances through the supplied values.
static GuiSvgAnimation	number(float from, float to, double durationSeconds)	Creates a numeric SVG attribute animation.
GuiSvgAnimation	repeating()	Returns a copy that repeats indefinitely.
GuiSvgAnimation	withDelay(double seconds)	Returns a copy with an initial delay.
GuiSvgAnimation	withEasing(GuiEasing value)	Returns a copy with a different easing function.
GuiSvgAnimation	withIterations(double count)	Returns a copy with a finite iteration count.
GuiSvgAnimation	withSampleRate(float value)	Returns a copy with a raster-sampling rate in frames per second.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

number

public static GuiSvgAnimation number(float from,
 float to,
 double durationSeconds)

Creates a numeric SVG attribute animation.

color

public static GuiSvgAnimation color(RenderColor from,
 RenderColor to,
 double durationSeconds)

Creates an sRGB color animation serialized as an SVG hexadecimal color.

discrete

public static GuiSvgAnimation discrete(double durationSeconds,
 String... values)

Creates a discrete animation that advances through the supplied values.

withDelay

public GuiSvgAnimation withDelay(double seconds)

Returns a copy with an initial delay.

withIterations

public GuiSvgAnimation withIterations(double count)

Returns a copy with a finite iteration count.

repeating

public GuiSvgAnimation repeating()

Returns a copy that repeats indefinitely.

alternating

public GuiSvgAnimation alternating()

Returns a copy that reverses direction on every odd iteration.

withEasing

public GuiSvgAnimation withEasing(GuiEasing value)

Returns a copy with a different easing function.

withSampleRate

public GuiSvgAnimation withSampleRate(float value)

Returns a copy with a raster-sampling rate in frames per second.

The rate is bounded to 120 samples per second.