Class CoverageCanvas

Object

Observable

Canvas

PlanarCanvas

MapCanvas

MapCanvasAWT

CoverageCanvas

All Implemented Interfaces:

Localized

@DefaultProperty("coverage")
public class CoverageCanvas
extends MapCanvasAWT

A canvas for Rendered­Image provided by a Grid­Coverage or a Grid­Coverage­Resource. In the latter case where the source of data is specified by resource­Property, the grid coverage instance (given by coverage­Property) will change automatically according the zoom level.

Since:

1.1

See Also:

• Coverage­Explorer

Nested Class Summary

Nested classes/interfaces inherited from class MapCanvasAWT

Map­Canvas­AWT.Renderer

Modifier and Type	Class	Description
protected static class	Map­Canvas­AWT.Renderer	A snapshot of Map­Canvas­AWT state to paint as an image.

Nested classes/interfaces inherited from class MapCanvas

Map­Canvas.Static­Graphics

Modifier and Type	Class	Description
static class	Map­Canvas.Static­Graphics	JavaFX nodes rendered using a snapshot of the objective to display transform.

Property Summary

Properties inherited from class MapCanvas

error, positional­Accuracy, rendering

Type	Property	Description
final Read­Only­Object­Property<Throwable>	error	Returns a property giving the exception or error that occurred during last rendering operation.
final Read­Only­Object­Property<Length>	positional­Accuracy	Returns a property which gives an estimation of positional accuracy, typically in metres.
final Read­Only­Boolean­Property	rendering	Returns a property telling whether a rendering is in progress.

Field Summary

Fields

Modifier and Type	Field	Description
final Object­Property<Grid­Coverage>	coverage­Property	The data shown in this canvas.
final Object­Property<Interpolation>	interpolation­Property	The interpolation method to use for resampling the image.
final Object­Property<Grid­Coverage­Resource>	resource­Property	The source of coverage data shown in this canvas.
final Object­Property<Grid­Extent>	slice­Extent­Property	A subspace of the grid coverage extent where all dimensions except two have a size of 1 cell.

Fields inherited from class MapCanvasAWT

image, image­Margin

Modifier and Type	Field	Description
protected final Image­View	image	The node where the rendered map will be shown.
final Object­Property<Insets>	image­Margin	Number of additional pixels to paint on each sides of the image, outside the viewing area.

Fields inherited from class MapCanvas

fixed­Pane, floating­Pane

Modifier and Type	Field	Description
protected final Stack­Pane	fixed­Pane	The pane showing the map and other JavaFX nodes to keep at fixed position regardless pans, zooms or rotations applied on the map.
protected final Pane	floating­Pane	The pane showing the map and any other JavaFX nodes to scale and translate together with the map.

Fields inherited from class PlanarCanvas

BIDIMENSIONAL, objective­To­Display

Modifier and Type	Field	Description
protected static final int	BIDIMENSIONAL	The 2 constant for identifying code specific to bi-dimensional case.
protected final Affine­Transform	objective­To­Display	The conversion from objective CRS to the display coordinate system as a Java2D affine transform.

Fields inherited from class Canvas

DISPLAY_BOUNDS_PROPERTY, OBJECTIVE_CRS_PROPERTY, OBJECTIVE_TO_DISPLAY_PROPERTY, POINT_OF_INTEREST_PROPERTY

Modifier and Type	Field	Description
static final String	DISPLAY_BOUNDS_PROPERTY	The "displayBounds" property name, used for notifications about changes in bounds of display device.
static final String	OBJECTIVE_CRS_PROPERTY	The "objectiveCRS" property name, used for notifications about changes in objective CRS.
static final String	OBJECTIVE_TO_DISPLAY_PROPERTY	The "objectiveToDisplay" property name, used for notifications about changes in objective to display conversion.
static final String	POINT_OF_INTEREST_PROPERTY	The "pointOfInterest" property name, used for notifications about changes in point of interest.

Constructor Summary

Constructors

Constructor	Description
Coverage­Canvas()	Creates a new two-dimensional canvas for Rendered­Image.

Method Summary

Modifier and Type	Method	Description
protected Map­Canvas­AWT.Renderer	create­Renderer()	Invoked in JavaFX thread for creating a renderer to be executed in a background thread.
Optional<Identifier>	get­Content­Identifier()	Return an identifier derived from the resource identifier.
final Grid­Coverage	get­Coverage()	Returns the source of image for this viewer.
final Interpolation	get­Interpolation()	Gets the interpolation method used during resample operations.
final Grid­Coverage­Resource	get­Resource()	Returns the source of coverages for this viewer, or null if none.
final Grid­Extent	get­Slice­Extent()	Returns a subspace of the grid coverage extent where all dimensions except two have a size of 1 cell.
final void	set­Coverage(Grid­Coverage coverage)	Sets the coverage to show in this viewer.
final void	set­Interpolation(Interpolation interpolation)	Sets the interpolation method to use during resample operations.
final void	set­Resource(Grid­Coverage­Resource resource)	Sets the source of coverages shown in this viewer.
final void	set­Slice­Extent(Grid­Extent slice­Extent)	Sets a subspace of the grid coverage extent where all dimensions except two have a size of 1 cell.
String	to­String()	Returns a string representation for debugging purposes.

Methods inherited from class MapCanvas

clear­Error, error­Occurred, error­Property, get­Objective­Bounds, initialize, positional­Accuracy­Property, rendering­Property, request­Repaint, reset, run­After­Rendering, set­Objective­Bounds, set­Objective­To­Display, set­Positional­Accuracy, transform­Display­Coordinates, transform­Objective­Coordinates, using­Fixed­Transform

Modifier and Type	Method	Description
protected final void	clear­Error()	Clears the error message in the status bar.
protected void	error­Occurred(Throwable ex)	Sets the error property to the given value.
final Read­Only­Object­Property<Throwable>	error­Property()	Returns a property giving the exception or error that occurred during last rendering operation.
Envelope	get­Objective­Bounds()	Returns the data bounds to use for computing the initial "objective to display" transform.
protected void	initialize(Grid­Geometry visible­Area)	Sets the objective bounds and/or the zoom level and objective CRS to use for the initial view of data.
final Read­Only­Object­Property<Length>	positional­Accuracy­Property()	Returns a property which gives an estimation of positional accuracy, typically in metres.
final Read­Only­Boolean­Property	rendering­Property()	Returns a property telling whether a rendering is in progress.
final void	request­Repaint()	Requests the map to be rendered again, possibly with new data.
void	reset()	Resets the map view to its default zoom level and default position with no rotation.
protected boolean	run­After­Rendering(Runnable task)	Registers a task to execute after the background thread finished its current rendering task.
void	set­Objective­Bounds(Envelope visible­Area)	Sets the data bounds to use for computing the initial value of Planar­Canvas.objective­To­Display.
void	set­Objective­To­Display(Linear­Transform new­Value)	Sets the conversion from objective CRS to display coordinate system.
protected void	set­Positional­Accuracy(Quantity<Length> accuracy)	Sets an estimation of the positional accuracy of the pixels or features that are rendered on the map.
void	transform­Display­Coordinates(Affine­Transform after)	Updates the objective to display transform with the given transform in pixel coordinates.
void	transform­Objective­Coordinates(Affine­Transform before)	Updates the objective to display transform with the given transform in objective coordinates.
Map­Canvas.Static­Graphics	using­Fixed­Transform()	Returns a pane where graphics can be added as if the objective to display transform was static.

Methods inherited from class PlanarCanvas

get­Display­Bounds

Modifier and Type	Method	Description
Envelope2D	get­Display­Bounds()	Returns the size and location of the display device.

Methods inherited from class Canvas

get­Display­CRS, get­Geographic­Area, get­Grid­Geometry, get­Locale, get­Objective­CRS, get­Objective­To­Display, get­Point­Of­Interest, get­Spatial­Resolution, set­Display­Bounds, set­Point­Of­Interest

Modifier and Type	Method	Description
final Engineering­CRS	get­Display­CRS()	Returns the Coordinate Reference System of the display device.
Optional<Geographic­Bounding­Box>	get­Geographic­Area()	Returns the geographic bounding box encompassing the area shown on the display device.
Grid­Geometry	get­Grid­Geometry()	Returns canvas properties (CRS, display bounds, conversion) encapsulated in a grid geometry.
Locale	get­Locale()	Returns the locale used for texts or for producing some error messages.
Coordinate­Reference­System	get­Objective­CRS()	Returns the Coordinate Reference System in which all data are transformed before displaying.
Linear­Transform	get­Objective­To­Display()	Returns the (usually affine) conversion from objective CRS to display coordinate system.
Direct­Position	get­Point­Of­Interest(boolean objective)	Returns the coordinates of a point considered representative of the data.
Optional­Double	get­Spatial­Resolution()	Returns an estimation of the resolution (in metres) at the point of interest.
void	set­Display­Bounds(Envelope new­Value)	Sets the size and location of the display device.
void	set­Point­Of­Interest(Direct­Position new­Value)	Sets the coordinates of a representative point inside the data bounding box.

Methods inherited from class Observable

add­Property­Change­Listener, fire­Property­Change, fire­Property­Change, has­Property­Change­Listener, remove­Property­Change­Listener

Modifier and Type	Method	Description
final void	add­Property­Change­Listener(String property­Name, Property­Change­Listener listener)	Registers a listener for the property of the given name.
protected void	fire­Property­Change(Property­Change­Event event)	Notifies all registered listeners that a property changed its value.
protected void	fire­Property­Change(String property­Name, Object old­Value, Object new­Value)	Notifies all registered listeners that a property of the given name changed its value.
protected final boolean	has­Property­Change­Listener(String property­Name)	Returns true if the given property has at least one listener.
final void	remove­Property­Change­Listener(String property­Name, Property­Change­Listener listener)	Unregisters a property listener.

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, wait, wait, wait

Field Details

resourceProperty

public final ObjectProperty<GridCoverageResource> resourceProperty

The source of coverage data shown in this canvas. If this property value is non-null, then coverage­Property value will change at any time (potentially many times) depending on the zoom level or other user interaction. Conversely if a value is set explicitly on coverage­Property, then this resource­Property is cleared.

Since:

1.2

See Also:

• get­Resource()
• set­Resource(Grid­Coverage­Resource)
• Coverage­Explorer.resource­Property

coverageProperty

public final ObjectProperty<GridCoverage> coverageProperty

The data shown in this canvas. This property value may be set implicitly or explicitly:

• If the resource­Property value is non-null, then the value will change automatically at any time (potentially many times) depending on user interaction.
• Conversely if an explicit value is set on this property, then the resource­Property is cleared.

Note that a change in this property value may not modify the canvas content immediately. Instead, a background process will request the tiles and update the canvas content later, when data are ready.

Current implementation is restricted to Grid­Coverage instances, but a future implementation may generalize to org.opengis.coverage.Coverage instances.

See Also:

• get­Coverage()
• set­Coverage(Grid­Coverage)
• Coverage­Explorer.coverage­Property

sliceExtentProperty

public final ObjectProperty<GridExtent> sliceExtentProperty

A subspace of the grid coverage extent where all dimensions except two have a size of 1 cell. The property value may be null if the grid coverage has only two dimensions with a size greater than 1 cell, in which case it is unnecessary to specify a slice.

See Also:

• get­Slice­Extent()
• set­Slice­Extent(Grid­Extent)
• Grid­Coverage.render(Grid­Extent)

interpolationProperty

public final ObjectProperty<Interpolation> interpolationProperty

The interpolation method to use for resampling the image.

See Also:

• get­Interpolation()
• set­Interpolation(Interpolation)

Constructor Details

CoverageCanvas

public CoverageCanvas()

Creates a new two-dimensional canvas for Rendered­Image.

Method Details

getContentIdentifier

public Optional<Identifier> getContentIdentifier()

Return an identifier derived from the resource identifier. This method returns an empty value if no worker has read the resource identifier yet. It may happen randomly depending on thread execution order.

Overrides:

get­Content­Identifier in class Map­Canvas

Returns:

an identifier of the rendered coverage.

Since:

1.7

getResource

public final GridCoverageResource getResource()

Returns the source of coverages for this viewer, or null if none. This method, like all other methods in this class, shall be invoked from the JavaFX thread.

Returns:

the source of coverages shown in this viewer, or null if none.

Since:

1.2

See Also:

• resource­Property

setResource

public final void setResource(GridCoverageResource resource)

Sets the source of coverages shown in this viewer. This method shall be invoked from JavaFX thread and returns immediately. The new data are loaded in a background thread and the coverage­Property value will be updated after an undetermined amount of time.

Parameters:

resource - the source of data to show in this viewer, or null if none.

Since:

1.2

See Also:

• resource­Property

getCoverage

public final GridCoverage getCoverage()

Returns the source of image for this viewer. This method, like all other methods in this class, shall be invoked from the JavaFX thread. Note that this value may change at any time (depending on user interaction) if the resource­Property has a non-null value.

Returns:

the coverage shown in this explorer, or null if none.

See Also:

• coverage­Property

setCoverage

public final void setCoverage(GridCoverage coverage)

Sets the coverage to show in this viewer. This method shall be invoked from JavaFX thread and returns immediately. The new data are loaded in a background thread and will appear after an undetermined amount of time.

Invoking this method sets the resource­Property value to null.

Parameters:

coverage - the data to show in this viewer, or null if none.

See Also:

• coverage­Property

getSliceExtent

public final GridExtent getSliceExtent()

Returns a subspace of the grid coverage extent where all dimensions except two have a size of 1 cell.

Returns:

subspace of the grid coverage extent where all dimensions except two have a size of 1 cell.

See Also:

• slice­Extent­Property
• Grid­Coverage.render(Grid­Extent)

setSliceExtent

public final void setSliceExtent(GridExtent sliceExtent)

Sets a subspace of the grid coverage extent where all dimensions except two have a size of 1 cell. Note that values set on this property may be overwritten at any time by user interactions if this Coverage­Canvas is associated with a Grid­Slice­Selector.

Parameters:

slice­Extent - subspace of the grid coverage extent where all dimensions except two have a size of 1 cell.

See Also:

• slice­Extent­Property
• Grid­Coverage.render(Grid­Extent)

getInterpolation

public final Interpolation getInterpolation()

Gets the interpolation method used during resample operations.

Returns:

the current interpolation method.

See Also:

• interpolation­Property

setInterpolation

public final void setInterpolation(Interpolation interpolation)

Sets the interpolation method to use during resample operations.

Parameters:

interpolation - the new interpolation method.

See Also:

• interpolation­Property

createRenderer

protected MapCanvasAWT.Renderer createRenderer()

Invoked in JavaFX thread for creating a renderer to be executed in a background thread. This method prepares the information needed but does not start the rendering itself. The rendering will be done later by a call to Map­Canvas­AWT.Renderer.paint(Graphics2D).

Specified by:

create­Renderer in class Map­Canvas­AWT

Returns:

rendering process to be executed in background thread, or null if there is nothing to paint.

toString

public String toString()

Returns a string representation for debugging purposes. The string content may change in any future version.

Overrides:

to­String in class Map­Canvas

Returns:

debug string (may change in any future version).