org.apache.batik.anim.values

Class AnimatablePaintValue

public class AnimatablePaintValue extends AnimatableColorValue

An SVG paint value in the animation system.

Field Summary
protected int	paintType The type of paint.
static int	PAINT_COLOR
static int	PAINT_CURRENT_COLOR
static int	PAINT_INHERIT
static int	PAINT_NONE
static int	PAINT_URI
static int	PAINT_URI_COLOR
static int	PAINT_URI_CURRENT_COLOR
static int	PAINT_URI_NONE
protected String	uri The URI of the referenced paint server.

Constructor Summary
protected	AnimatablePaintValue(AnimationTarget target) Creates a new, uninitialized AnimatablePaintValue.
protected	AnimatablePaintValue(AnimationTarget target, float r, float g, float b) Creates a new AnimatablePaintValue.

Method Summary
boolean	canPace() Returns whether two values of this type can have their distance computed, as needed by paced animation.
static AnimatablePaintValue	createColorPaintValue(AnimationTarget target, float r, float g, float b) Creates a new AnimatablePaintValue for a color value.
static AnimatablePaintValue	createCurrentColorPaintValue(AnimationTarget target) Creates a new AnimatablePaintValue for a 'currentColor' value.
static AnimatablePaintValue	createInheritPaintValue(AnimationTarget target) Creates a new AnimatablePaintValue for a 'inherit' value.
static AnimatablePaintValue	createNonePaintValue(AnimationTarget target) Creates a new AnimatablePaintValue for a 'none' value.
static AnimatablePaintValue	createURIColorPaintValue(AnimationTarget target, String uri, float r, float g, float b) Creates a new AnimatablePaintValue for a URI reference with a color fallback.
static AnimatablePaintValue	createURICurrentColorPaintValue(AnimationTarget target, String uri) Creates a new AnimatablePaintValue for a URI reference with a 'currentColor' fallback.
static AnimatablePaintValue	createURINonePaintValue(AnimationTarget target, String uri) Creates a new AnimatablePaintValue for a URI reference with a 'none' fallback.
static AnimatablePaintValue	createURIPaintValue(AnimationTarget target, String uri) Creates a new AnimatablePaintValue for a URI reference.
float	distanceTo(AnimatableValue other) Returns the absolute distance between this value and the specified other value.
String	getCssText() Returns the CSS text representation of the value.
int	getPaintType() Returns the type of paint this value represents.
String	getURI() Returns the paint server URI.
AnimatableValue	getZeroValue() Returns a zero value of this AnimatableValue's type.
AnimatableValue	interpolate(AnimatableValue result, AnimatableValue to, float interpolation, AnimatableValue accumulation, int multiplier) Performs interpolation to the given value.

Field Detail

paintType

protected int paintType

The type of paint.

PAINT_COLOR

public static final int PAINT_COLOR

PAINT_CURRENT_COLOR

public static final int PAINT_CURRENT_COLOR

PAINT_INHERIT

public static final int PAINT_INHERIT

PAINT_NONE

public static final int PAINT_NONE

PAINT_URI

public static final int PAINT_URI

PAINT_URI_COLOR

public static final int PAINT_URI_COLOR

PAINT_URI_CURRENT_COLOR

public static final int PAINT_URI_CURRENT_COLOR

PAINT_URI_NONE

public static final int PAINT_URI_NONE

uri

protected String uri

The URI of the referenced paint server.

Constructor Detail

AnimatablePaintValue

protected AnimatablePaintValue(AnimationTarget target)

Creates a new, uninitialized AnimatablePaintValue.

AnimatablePaintValue

protected AnimatablePaintValue(AnimationTarget target, float r, float g, float b)

Creates a new AnimatablePaintValue.

Method Detail

canPace

public boolean canPace()

Returns whether two values of this type can have their distance computed, as needed by paced animation.

createColorPaintValue

public static AnimatablePaintValue createColorPaintValue(AnimationTarget target, float r, float g, float b)

Creates a new AnimatablePaintValue for a color value.

createCurrentColorPaintValue

public static AnimatablePaintValue createCurrentColorPaintValue(AnimationTarget target)

Creates a new AnimatablePaintValue for a 'currentColor' value.

createInheritPaintValue

public static AnimatablePaintValue createInheritPaintValue(AnimationTarget target)

Creates a new AnimatablePaintValue for a 'inherit' value.

createNonePaintValue

public static AnimatablePaintValue createNonePaintValue(AnimationTarget target)

Creates a new AnimatablePaintValue for a 'none' value.

createURIColorPaintValue

public static AnimatablePaintValue createURIColorPaintValue(AnimationTarget target, String uri, float r, float g, float b)

Creates a new AnimatablePaintValue for a URI reference with a color fallback.

createURICurrentColorPaintValue

public static AnimatablePaintValue createURICurrentColorPaintValue(AnimationTarget target, String uri)

Creates a new AnimatablePaintValue for a URI reference with a 'currentColor' fallback.

createURINonePaintValue

public static AnimatablePaintValue createURINonePaintValue(AnimationTarget target, String uri)

Creates a new AnimatablePaintValue for a URI reference with a 'none' fallback.

createURIPaintValue

public static AnimatablePaintValue createURIPaintValue(AnimationTarget target, String uri)

Creates a new AnimatablePaintValue for a URI reference.

distanceTo

public float distanceTo(AnimatableValue other)

Returns the absolute distance between this value and the specified other value.

getCssText

public String getCssText()

Returns the CSS text representation of the value.

getPaintType

public int getPaintType()

Returns the type of paint this value represents.

getURI

public String getURI()

Returns the paint server URI.

getZeroValue

public AnimatableValue getZeroValue()

Returns a zero value of this AnimatableValue's type.

interpolate

public AnimatableValue interpolate(AnimatableValue result, AnimatableValue to, float interpolation, AnimatableValue accumulation, int multiplier)

Performs interpolation to the given value.

Copyright B) 2008 Apache Software Foundation. All Rights Reserved.