APIdia Launch Partner
Top Description Fields Constructors Methods
javafx.scene.effect

public Class FloatMap

extends Object
Class Inheritance
Imports
javafx.beans.property.BooleanProperty, .IntegerProperty, .IntegerPropertyBase, .SimpleBooleanProperty, com.sun.javafx.util.Utils

A buffer that contains floating point data, intended for use as a parameter to effects such as DisplacementMap.
Since
JavaFX 2.0

Field Summary

Modifier and TypeField and Description
private float[]
private BooleanProperty
private IntegerProperty
height

The height of the map, in pixels.

private FloatMap
private boolean
private IntegerProperty
width

The width of the map, in pixels.

Constructor Summary

AccessConstructor and Description
public
FloatMap()

Creates a new instance of FloatMap with default parameters.

public
FloatMap(int
the width of the map, in pixels
width
,
int
the height of the map, in pixels
height
)

Creates a new instance of FloatMap with the specified width and height.

Method Summary

Modifier and TypeMethod and Description
private void
pack-priv FloatMap
copy()

pack-priv final BooleanProperty
public final int
pack-priv FloatMap
public final int
public final IntegerProperty
pack-priv boolean
private void
private void
setEffectDirty(boolean value)

public final void
setHeight(int value)

public void
setSample(int
the x location
x
,
int
the y location
y
,
int
the band to set (must be 0, 1, 2, or 3)
band
,
float
the sample value to set
s
)

Sets the sample for a specific band at the given (x,y) location.

public void
setSamples(int
the x location
x
,
int
the y location
y
,
float
the sample value to set for the first band
s0
)

Sets the sample for the first band at the given (x,y) location.

public void
setSamples(int
the x location
x
,
int
the y location
y
,
float
the sample value to set for the first band
s0
,
float
the sample value to set for the second band
s1
)

Sets the sample for the first two bands at the given (x,y) location.

public void
setSamples(int
the x location
x
,
int
the y location
y
,
float
the sample value to set for the first band
s0
,
float
the sample value to set for the second band
s1
,
float
the sample value to set for the third band
s2
)

Sets the sample for the first three bands at the given (x,y) location.

public void
setSamples(int
the x location
x
,
int
the y location
y
,
float
the sample value to set for the first band
s0
,
float
the sample value to set for the second band
s1
,
float
the sample value to set for the third band
s2
,
float
the sample value to set for the fourth band
s3
)

Sets the sample for each of the four bands at the given (x,y) location.

public final void
setWidth(int value)

pack-priv void
sync()

private void
private void
public final IntegerProperty
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

bufback to summary
private float[] buf
effectDirtyback to summary
private BooleanProperty effectDirty
heightback to summary
private IntegerProperty height

The height of the map, in pixels.

      Min:    1
      Max: 4096
  Default:    1
 Identity:  n/a
Default Value
1
mapback to summary
private FloatMap map
mapBufferDirtyback to summary
private boolean mapBufferDirty
widthback to summary
private IntegerProperty width

The width of the map, in pixels.

      Min:    1
      Max: 4096
  Default:    1
 Identity:  n/a
Default Value
1

Constructor Detail

FloatMapback to summary
public FloatMap()

Creates a new instance of FloatMap with default parameters.

FloatMapback to summary
public FloatMap(int width, int height)

Creates a new instance of FloatMap with the specified width and height.

Parameters
width:int

the width of the map, in pixels

height:int

the height of the map, in pixels

Since
JavaFX 2.1

Method Detail

clearDirtyback to summary
private void clearDirty()
copyback to summary
pack-priv FloatMap copy()
effectDirtyPropertyback to summary
pack-priv final BooleanProperty effectDirtyProperty()
getHeightback to summary
public final int getHeight()
getImplback to summary
pack-priv FloatMap getImpl()
getWidthback to summary
public final int getWidth()
heightPropertyback to summary
public final IntegerProperty heightProperty()
isEffectDirtyback to summary
pack-priv boolean isEffectDirty()
markDirtyback to summary
private void markDirty()
setEffectDirtyback to summary
private void setEffectDirty(boolean value)
setHeightback to summary
public final void setHeight(int value)
setSampleback to summary
public void setSample(int x, int y, int band, float s)

Sets the sample for a specific band at the given (x,y) location.

Parameters
x:int

the x location

y:int

the y location

band:int

the band to set (must be 0, 1, 2, or 3)

s:float

the sample value to set

setSamplesback to summary
public void setSamples(int x, int y, float s0)

Sets the sample for the first band at the given (x,y) location.

Parameters
x:int

the x location

y:int

the y location

s0:float

the sample value to set for the first band

setSamplesback to summary
public void setSamples(int x, int y, float s0, float s1)

Sets the sample for the first two bands at the given (x,y) location.

Parameters
x:int

the x location

y:int

the y location

s0:float

the sample value to set for the first band

s1:float

the sample value to set for the second band

setSamplesback to summary
public void setSamples(int x, int y, float s0, float s1, float s2)

Sets the sample for the first three bands at the given (x,y) location.

Parameters
x:int

the x location

y:int

the y location

s0:float

the sample value to set for the first band

s1:float

the sample value to set for the second band

s2:float

the sample value to set for the third band

setSamplesback to summary
public void setSamples(int x, int y, float s0, float s1, float s2, float s3)

Sets the sample for each of the four bands at the given (x,y) location.

Parameters
x:int

the x location

y:int

the y location

s0:float

the sample value to set for the first band

s1:float

the sample value to set for the second band

s2:float

the sample value to set for the third band

s3:float

the sample value to set for the fourth band

setWidthback to summary
public final void setWidth(int value)
syncback to summary
pack-priv void sync()
updateback to summary
private void update()
updateBufferback to summary
private void updateBuffer()
widthPropertyback to summary
public final IntegerProperty widthProperty()