DisplacementMap

java.lang.Object
- javafx.scene.effect.Effect
- - javafx.scene.effect.DisplacementMap

```
public class DisplacementMap
extends Effect
```
An effect that shifts each pixel by a distance specified by the first two bands of of the specified FloatMap. For each pixel in the output, the corresponding data from the mapData is retrieved, scaled and offset by the scale and offset attributes, scaled again by the size of the source input image and used as an offset from the destination pixel to retrieve the pixel data from the source input.
```
     dst[x,y] = src[(x,y) + (offset+scale*map[x,y])*(srcw,srch)]
 
```
A value of (0.0, 0.0) would specify no offset for the pixel data whereas a value of (0.5, 0.5) would specify an offset of half of the source image size.
Note that the mapping is the offset from a destination pixel to the source pixel location from which it is sampled which means that filling the map with all values of 0.5 would displace the image by half of its size towards the upper left since each destination pixel would contain the data that comes from the source pixel below and to the right of it.

Also note that this effect does not adjust the coordinates of input events or any methods that measure containment on a Node. The results of mouse picking and the containment methods are undefined when a Node has a DisplacementMap effect in place.

Example:
```
 int width = 220;
 int height = 100;

 FloatMap floatMap = new FloatMap();
 floatMap.setWidth(width);
 floatMap.setHeight(height);

 for (int i = 0; i < width; i++) {
     double v = (Math.sin(i / 20.0 * Math.PI) - 0.5) / 40.0;
     for (int j = 0; j < height; j++) {
         floatMap.setSamples(i, j, 0.0f, (float) v);
     }
 }

 DisplacementMap displacementMap = new DisplacementMap();
 displacementMap.setMapData(floatMap);

 Text text = new Text();
 text.setX(40.0);
 text.setY(80.0);
 text.setText("Wavy Text");
 text.setFill(Color.web("0x3b596d"));
 text.setFont(Font.font(null, FontWeight.BOLD, 50));
 text.setEffect(displacementMap);

 
```
The code above produces the following:
Since:

JavaFX 2.0

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`<any>`	`input` The input for this `Effect`.
`<any>`	`mapData` The map data for this `Effect`.
`DoubleProperty`	`offsetX` The offset by which all x coordinate offset values in the `FloatMap` are displaced after they are scaled.
`DoubleProperty`	`offsetY` The offset by which all y coordinate offset values in the `FloatMap` are displaced after they are scaled.
`DoubleProperty`	`scaleX` The scale factor by which all x coordinate offset values in the `FloatMap` are multiplied.
`DoubleProperty`	`scaleY` The scale factor by which all y coordinate offset values in the `FloatMap` are multiplied.
`BooleanProperty`	`wrap` Defines whether values taken from outside the edges of the map "wrap around" or not.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private class DisplacementMap.MapDataChangeListener
- Nested classes/interfaces inherited from class javafx.scene.effect.Effect
  Effect.EffectInputChangeListener, Effect.EffectInputProperty

Nested Classes
Modifier and Type	Class and Description
`private class`	`DisplacementMap.MapDataChangeListener`

Field Summary

Fields
Modifier and Type	Field and Description
`private FloatMap`	`defaultMap`
`private <any>`	`input` The input for this `Effect`.
`private <any>`	`mapData` The map data for this `Effect`.
`private DisplacementMap.MapDataChangeListener`	`mapDataChangeListener`
`private DoubleProperty`	`offsetX` The offset by which all x coordinate offset values in the `FloatMap` are displaced after they are scaled.
`private DoubleProperty`	`offsetY` The offset by which all y coordinate offset values in the `FloatMap` are displaced after they are scaled.
`private DoubleProperty`	`scaleX` The scale factor by which all x coordinate offset values in the `FloatMap` are multiplied.
`private DoubleProperty`	`scaleY` The scale factor by which all y coordinate offset values in the `FloatMap` are multiplied.
`private BooleanProperty`	`wrap` Defines whether values taken from outside the edges of the map "wrap around" or not.

Constructor Summary

Constructors
Constructor and Description
`DisplacementMap()` Creates a new instance of DisplacementMap with default parameters.
`DisplacementMap(FloatMap mapData)` Creates a new instance of DisplacementMap with the specified mapData.
`DisplacementMap(FloatMap mapData, double offsetX, double offsetY, double scaleX, double scaleY)` Creates a new instance of DisplacementMap with the specified mapData, offsetX, offsetY, scaleX, and scaleY.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) boolean`	`checkChainContains(Effect e)`
`(package private) Effect`	`copy()`
`(package private) com.sun.scenario.effect.DisplacementMap`	`createPeer()`
`(package private) BaseBounds`	`getBounds(BaseBounds bounds, BaseTransform tx, Node node, BoundsAccessor boundsAccessor)` Returns bounds of given node with applied effect.
`Effect`	`getInput()` Gets the value of the property input.
`FloatMap`	`getMapData()` Gets the value of the property mapData.
`double`	`getOffsetX()` Gets the value of the property offsetX.
`double`	`getOffsetY()` Gets the value of the property offsetY.
`double`	`getScaleX()` Gets the value of the property scaleX.
`double`	`getScaleY()` Gets the value of the property scaleY.
`<any>`	`inputProperty()` The input for this `Effect`.
`boolean`	`isWrap()` Gets the value of the property wrap.
`<any>`	`mapDataProperty()` The map data for this `Effect`.
`DoubleProperty`	`offsetXProperty()` The offset by which all x coordinate offset values in the `FloatMap` are displaced after they are scaled.
`DoubleProperty`	`offsetYProperty()` The offset by which all y coordinate offset values in the `FloatMap` are displaced after they are scaled.
`DoubleProperty`	`scaleXProperty()` The scale factor by which all x coordinate offset values in the `FloatMap` are multiplied.
`DoubleProperty`	`scaleYProperty()` The scale factor by which all y coordinate offset values in the `FloatMap` are multiplied.
`void`	`setInput(Effect value)` Sets the value of the property input.
`void`	`setMapData(FloatMap value)` Sets the value of the property mapData.
`void`	`setOffsetX(double value)` Sets the value of the property offsetX.
`void`	`setOffsetY(double value)` Sets the value of the property offsetY.
`void`	`setScaleX(double value)` Sets the value of the property scaleX.
`void`	`setScaleY(double value)` Sets the value of the property scaleY.
`void`	`setWrap(boolean value)` Sets the value of the property wrap.
`(package private) void`	`update()`
`BooleanProperty`	`wrapProperty()` Defines whether values taken from outside the edges of the map "wrap around" or not.

Methods inherited from class javafx.scene.effect.Effect
containsCycles, effectBoundsChanged, getInputBounds, getKernelSize, getPeer, getShadowBounds, markDirty, sync, transformBounds

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - input
```
public final <any> inputProperty
```
    The input for this Effect. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.
    
    See Also:
    
    getInput(), setInput(Effect)
  - mapData
```
public final <any> mapDataProperty
```
    The map data for this Effect.
    
    See Also:
    
    getMapData(), setMapData(FloatMap)
  - scaleX
```
public final DoubleProperty scaleXProperty
```
    The scale factor by which all x coordinate offset values in the FloatMap are multiplied.
```
       Min: n/a
       Max: n/a
   Default: 1.0
  Identity: 1.0
 
```
    See Also:
    
    getScaleX(), setScaleX(double)
  - scaleY
```
public final DoubleProperty scaleYProperty
```
    The scale factor by which all y coordinate offset values in the FloatMap are multiplied.
```
       Min: n/a
       Max: n/a
   Default: 1.0
  Identity: 1.0
 
```
    See Also:
    
    getScaleY(), setScaleY(double)
  - offsetX
```
public final DoubleProperty offsetXProperty
```
    The offset by which all x coordinate offset values in the FloatMap are displaced after they are scaled.
```
       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0
 
```
    See Also:
    
    getOffsetX(), setOffsetX(double)
  - offsetY
```
public final DoubleProperty offsetYProperty
```
    The offset by which all y coordinate offset values in the FloatMap are displaced after they are scaled.
```
       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0
 
```
    See Also:
    
    getOffsetY(), setOffsetY(double)
  - wrap
```
public final BooleanProperty wrapProperty
```
    Defines whether values taken from outside the edges of the map "wrap around" or not.
```
       Min:  n/a
       Max:  n/a
   Default: false
  Identity:  n/a
 
```
    See Also:
    
    isWrap(), setWrap(boolean)
- Field Detail
  - input
```
private <any> input
```
    The input for this Effect. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.
  - defaultMap
```
private final FloatMap defaultMap
```
  - mapData
```
private <any> mapData
```
    The map data for this Effect.
  - mapDataChangeListener
```
private final DisplacementMap.MapDataChangeListener mapDataChangeListener
```
  - scaleX
```
private DoubleProperty scaleX
```
    The scale factor by which all x coordinate offset values in the FloatMap are multiplied.
```
       Min: n/a
       Max: n/a
   Default: 1.0
  Identity: 1.0
 
```
  - scaleY
```
private DoubleProperty scaleY
```
    The scale factor by which all y coordinate offset values in the FloatMap are multiplied.
```
       Min: n/a
       Max: n/a
   Default: 1.0
  Identity: 1.0
 
```
  - offsetX
```
private DoubleProperty offsetX
```
    The offset by which all x coordinate offset values in the FloatMap are displaced after they are scaled.
```
       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0
 
```
  - offsetY
```
private DoubleProperty offsetY
```
    The offset by which all y coordinate offset values in the FloatMap are displaced after they are scaled.
```
       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0
 
```
  - wrap
```
private BooleanProperty wrap
```
    Defines whether values taken from outside the edges of the map "wrap around" or not.
```
       Min:  n/a
       Max:  n/a
   Default: false
  Identity:  n/a
 
```
- Constructor Detail
  - DisplacementMap
```
public DisplacementMap()
```
    Creates a new instance of DisplacementMap with default parameters.
  - DisplacementMap
```
public DisplacementMap(FloatMap mapData)
```
    Creates a new instance of DisplacementMap with the specified mapData.
    
    Parameters:
    
    mapData - the map data for this displacement map effect
    
    Since:
    
    JavaFX 2.1
  - DisplacementMap
```
public DisplacementMap(FloatMap mapData,
                       double offsetX,
                       double offsetY,
                       double scaleX,
                       double scaleY)
```
    Creates a new instance of DisplacementMap with the specified mapData, offsetX, offsetY, scaleX, and scaleY.
    
    Parameters:
    
    mapData - the map data for this displacement map effect
    
    offsetX - the offset by which all x coordinate offset values in the FloatMap are displaced after they are scaled
    
    offsetY - the offset by which all y coordinate offset values in the FloatMap are displaced after they are scaled
    
    scaleX - the scale factor by which all x coordinate offset values in the FloatMap are multiplied
    
    scaleY - the scale factor by which all y coordinate offset values in the FloatMap are multiplied
    
    Since:
    
    JavaFX 2.1
- Method Detail
  - createPeer
```
com.sun.scenario.effect.DisplacementMap createPeer()
```
    Specified by:
    
    createPeer in class Effect
  - setInput
```
public final void setInput(Effect value)
```
    Sets the value of the property input.
  - getInput
```
public final Effect getInput()
```
    Gets the value of the property input.
  - inputProperty
```
public final <any> inputProperty()
```
    The input for this Effect. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.
    
    See Also:
    
    getInput(), setInput(Effect)
  - checkChainContains
```
boolean checkChainContains(Effect e)
```
    Specified by:
    
    checkChainContains in class Effect
  - setMapData
```
public final void setMapData(FloatMap value)
```
    Sets the value of the property mapData.
  - getMapData
```
public final FloatMap getMapData()
```
    Gets the value of the property mapData.
  - mapDataProperty
```
public final <any> mapDataProperty()
```
    The map data for this Effect.
    
    See Also:
    
    getMapData(), setMapData(FloatMap)
  - setScaleX
```
public final void setScaleX(double value)
```
    Sets the value of the property scaleX.
  - getScaleX
```
public final double getScaleX()
```
    Gets the value of the property scaleX.
  - scaleXProperty
```
public final DoubleProperty scaleXProperty()
```
    The scale factor by which all x coordinate offset values in the FloatMap are multiplied.
```
       Min: n/a
       Max: n/a
   Default: 1.0
  Identity: 1.0
 
```
    See Also:
    
    getScaleX(), setScaleX(double)
  - setScaleY
```
public final void setScaleY(double value)
```
    Sets the value of the property scaleY.
  - getScaleY
```
public final double getScaleY()
```
    Gets the value of the property scaleY.
  - scaleYProperty
```
public final DoubleProperty scaleYProperty()
```
    The scale factor by which all y coordinate offset values in the FloatMap are multiplied.
```
       Min: n/a
       Max: n/a
   Default: 1.0
  Identity: 1.0
 
```
    See Also:
    
    getScaleY(), setScaleY(double)
  - setOffsetX
```
public final void setOffsetX(double value)
```
    Sets the value of the property offsetX.
  - getOffsetX
```
public final double getOffsetX()
```
    Gets the value of the property offsetX.
  - offsetXProperty
```
public final DoubleProperty offsetXProperty()
```
    The offset by which all x coordinate offset values in the FloatMap are displaced after they are scaled.
```
       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0
 
```
    See Also:
    
    getOffsetX(), setOffsetX(double)
  - setOffsetY
```
public final void setOffsetY(double value)
```
    Sets the value of the property offsetY.
  - getOffsetY
```
public final double getOffsetY()
```
    Gets the value of the property offsetY.
  - offsetYProperty
```
public final DoubleProperty offsetYProperty()
```
    The offset by which all y coordinate offset values in the FloatMap are displaced after they are scaled.
```
       Min: n/a
       Max: n/a
   Default: 0.0
  Identity: 0.0
 
```
    See Also:
    
    getOffsetY(), setOffsetY(double)
  - setWrap
```
public final void setWrap(boolean value)
```
    Sets the value of the property wrap.
  - isWrap
```
public final boolean isWrap()
```
    Gets the value of the property wrap.
  - wrapProperty
```
public final BooleanProperty wrapProperty()
```
    Defines whether values taken from outside the edges of the map "wrap around" or not.
```
       Min:  n/a
       Max:  n/a
   Default: false
  Identity:  n/a
 
```
    See Also:
    
    isWrap(), setWrap(boolean)
  - update
```
void update()
```
    Specified by:
    
    update in class Effect
  - getBounds
```
BaseBounds getBounds(BaseBounds bounds,
                     BaseTransform tx,
                     Node node,
                     BoundsAccessor boundsAccessor)
```
    Description copied from class: Effect
    
    Returns bounds of given node with applied effect. We *never* pass null in as a bounds. This method will NOT take a null bounds object. The returned value may be the same bounds object passed in, or it may be a new object.
    
    Specified by:
    
    getBounds in class Effect
  - copy
```
Effect copy()
```
    Specified by:
    
    copy in class Effect

Class DisplacementMap

Property Summary

Nested Class Summary

Nested classes/interfaces inherited from class javafx.scene.effect.Effect

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javafx.scene.effect.Effect

Methods inherited from class java.lang.Object

Property Detail

input

mapData

scaleX

scaleY

offsetX

offsetY

wrap

Field Detail

input

defaultMap

mapData

mapDataChangeListener

scaleX

scaleY

offsetX

offsetY

wrap

Constructor Detail

DisplacementMap

DisplacementMap

DisplacementMap

Method Detail

createPeer

setInput

getInput

inputProperty

checkChainContains

setMapData

getMapData

mapDataProperty

setScaleX

getScaleX

scaleXProperty

setScaleY

getScaleY

scaleYProperty

setOffsetX

getOffsetX

offsetXProperty

setOffsetY

getOffsetY

offsetYProperty

setWrap

isWrap

wrapProperty

update

getBounds

copy