DisplacementMap (Java FX 2.0)

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.
```
import javafx.scene.*;
import javafx.scene.text.*;
import javafx.scene.shape.*;
import javafx.scene.paint.*;
import javafx.scene.effect.*;

int w = 220;
int h = 100;
FloatMap map = new FloatMap();
map.setWidth(w);
map.setHeight(h);

for (int i = 0; i < w; i++) {
    double v = (Math.sin(i/50.0*Math.PI)-0.5)/40.0;
    for (int j = 0; j < h; j++) {
        map.setSamples(i, j, 0.0f,(float) v);
    }
}

Group g = new Group();
DisplacementMap dm = new DisplacementMap();
dm.setMapData(map);

g.setEffect(dm);
g.setCache(true);

Rectangle r = new Rectangle();
r.setX(20.0);
r.setY(20.0);
r.setWidth(w);
r.setHeight(h);
r.setFill(Color.BLUE);

g.getChildren().add(r);

Text t = new Text();
t.setX(40.0);
t.setY(80.0);
t.setText("Wavy Text");
t.setFill(Color.YELLOW);
t.setFont(Font.font(null, FontWeight.BOLD, 36));

g.getChildren().add(t);
```

Property Summary

Properties
Type	Property and Description
`ObjectProperty<Effect>`	`input` The input for this `Effect`.
`ObjectProperty<FloatMap>`	`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.

Constructor Summary

Constructors
Constructor and Description

DisplacementMap()
Creates a new instance of DisplacementMap with default parameters.

Constructors
Constructor and Description
`DisplacementMap()` Creates a new instance of DisplacementMap with default parameters.

Method Summary

Methods
Modifier and Type	Method and Description
`Effect`	`getInput()` The input for this `Effect`.
`FloatMap`	`getMapData()` The map data for this `Effect`.
`double`	`getOffsetX()` The offset by which all x coordinate offset values in the `FloatMap` are displaced after they are scaled.
`double`	`getOffsetY()` The offset by which all y coordinate offset values in the `FloatMap` are displaced after they are scaled.
`double`	`getScaleX()` The scale factor by which all x coordinate offset values in the `FloatMap` are multiplied.
`double`	`getScaleY()` The scale factor by which all y coordinate offset values in the `FloatMap` are multiplied.
`ObjectProperty<Effect>`	`inputProperty()` The input for this `Effect`.
`boolean`	`isWrap()` Defines whether values taken from outside the edges of the map "wrap around" or not.
`ObjectProperty<FloatMap>`	`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)` The input for this `Effect`.
`void`	`setMapData(FloatMap value)` The map data for this `Effect`.
`void`	`setOffsetX(double value)` The offset by which all x coordinate offset values in the `FloatMap` are displaced after they are scaled.
`void`	`setOffsetY(double value)` The offset by which all y coordinate offset values in the `FloatMap` are displaced after they are scaled.
`void`	`setScaleX(double value)` The scale factor by which all x coordinate offset values in the `FloatMap` are multiplied.
`void`	`setScaleY(double value)` The scale factor by which all y coordinate offset values in the `FloatMap` are multiplied.
`void`	`setWrap(boolean value)` Defines whether values taken from outside the edges of the map "wrap around" or not.
`BooleanProperty`	`wrapProperty()` Defines whether values taken from outside the edges of the map "wrap around" or not.

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

- Property Detail
  - 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.
    
    See Also:
    getInput(), setInput(Effect)
  - mapData
    
    The map data for this Effect.
    
    See Also:
    getMapData(), setMapData(FloatMap)
  - 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
 
```
    See Also:
    getScaleX(), setScaleX(double)
  - 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
 
```
    See Also:
    getScaleY(), setScaleY(double)
  - 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
 
```
    See Also:
    getOffsetX(), setOffsetX(double)
  - 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
 
```
    See Also:
    getOffsetY(), setOffsetY(double)
  - 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
 
```
    See Also:
    isWrap(), setWrap(boolean)
- Constructor Detail
  - DisplacementMap
```
public DisplacementMap()
```
    Creates a new instance of DisplacementMap with default parameters.
- Method Detail
  - setInput
```
public final void setInput(Effect value)
```
    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.
  - getInput
```
public final Effect getInput()
```
    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.
  - inputProperty
```
public final ObjectProperty<Effect> 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)
  - setMapData
```
public final void setMapData(FloatMap value)
```
    The map data for this Effect.
  - getMapData
```
public final FloatMap getMapData()
```
    The map data for this Effect.
  - mapDataProperty
```
public final ObjectProperty<FloatMap> mapDataProperty()
```
    The map data for this Effect.
    
    See Also:
    getMapData(), setMapData(FloatMap)
  - setScaleX
```
public final void setScaleX(double value)
```
    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
 
```
  - getScaleX
```
public final double getScaleX()
```
    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
 
```
  - 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)
```
    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
 
```
  - getScaleY
```
public final double getScaleY()
```
    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
 
```
  - 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)
```
    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
 
```
  - getOffsetX
```
public final double getOffsetX()
```
    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
 
```
  - 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)
```
    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
 
```
  - getOffsetY
```
public final double getOffsetY()
```
    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
 
```
  - 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)
```
    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
 
```
  - isWrap
```
public final boolean isWrap()
```
    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
 
```
  - 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)

Class DisplacementMap

Property Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

input

mapData

scaleX

scaleY

offsetX

offsetY

wrap

Constructor Detail

DisplacementMap

Method Detail

setInput

getInput

inputProperty

setMapData

getMapData

mapDataProperty

setScaleX

getScaleX

scaleXProperty

setScaleY

getScaleY

scaleYProperty

setOffsetX

getOffsetX

offsetXProperty

setOffsetY

getOffsetY

offsetYProperty

setWrap

isWrap

wrapProperty