Package uk.ac.starlink.ttools.plot2
Interface SurfaceFactory<P,A>
- All Known Implementing Classes:
CubeSurfaceFactory
,PlaneSurfaceFactory
,SkySurfaceFactory
,TimeSurfaceFactory
public interface SurfaceFactory<P,A>
Generates members of a family of Surface objects.
Surface configuration is provided by two objects of parameterised
types, a Profile (type P) and an Aspect (type A).
The profile provides fixed configuration items, and the aspect
provides items that may change according to different views of the
same surface, in particular as the result of pan/zoom type operations.
This object is self-documenting, in that it can report the
the configuration keys required to specify profile/aspect.
- Since:
- 11 Feb 2013
- Author:
- Mark Taylor
-
Method Summary
Modifier and TypeMethodDescriptioncreateAspect
(P profile, ConfigMap aspectConfig, Range[] ranges) Creates an aspect from configuration information.createNavigator
(ConfigMap navigatorConfig) Creates a navigator from configuration information.createProfile
(ConfigMap config) Creates a profile that can be used when creating a plot surface.createSurface
(Rectangle plotBounds, P profile, A aspect) Returns a new plot surface.getAspectConfig
(Surface surface) Returns a ConfigMap that corresponds to the configuration of the given surface, which must have been created by this factory.ConfigKey<?>[]
Returns the configuration keys that may be used to configure aspect for this surface factory.ConfigKey<?>[]
Returns the configuration keys that may be used to configure a navigator for use with this surface factory.Returns an object that can assess distances between graphic positions on the plot surface.ConfigKey<?>[]
Returns the configuration keys used to configure profile for this surface factory.Range[]
readRanges
(P profile, PlotLayer[] layers, DataStore dataStore) Provides the ranges that may be passed tocreateAspect
.boolean
Indicates whether ranges should be provided to generate an aspect.
-
Method Details
-
createSurface
Returns a new plot surface.- Parameters:
plotBounds
- rectangle to containing actual plot data (not insets)profile
- configuration object defining plot styleaspect
- configuration object defining plot viewpoint- Returns:
- new plot surface
-
getProfileKeys
ConfigKey<?>[] getProfileKeys()Returns the configuration keys used to configure profile for this surface factory. The returned keys are used in the map supplied to thecreateProfile
method.- Returns:
- profile configuration keys
-
createProfile
Creates a profile that can be used when creating a plot surface. The keys that are significant in the supplied config map are those returned bygetProfileKeys
. The return value can be used as input tocreateSurface
and other methods in this class.- Parameters:
config
- map of profile configuration items- Returns:
- factory-specific plot surface profile
-
getAspectKeys
ConfigKey<?>[] getAspectKeys()Returns the configuration keys that may be used to configure aspect for this surface factory. The returned keys are used in the map supplied to theuseRanges
andcreateAspect
methods.- Returns:
- aspect configuration keys
-
useRanges
Indicates whether ranges should be provided to generate an aspect. If true, it is beneficial to pass the result ofreadRanges
tocreateAspect
alongside the arguments of this method. If false, any such ranges will be ignored.- Parameters:
profile
- surface configuration profileaspectConfig
- configuration map that may contain keys fromgetAspectKeys
- Returns:
- true iff calculated ranges will be of use
-
readRanges
Provides the ranges that may be passed tocreateAspect
. There is only any point calling this ifuseRanges
returns true.- Parameters:
profile
- surface configuration profilelayers
- plot layers to be plotteddataStore
- contains actual data- Returns:
- data ranges covered by the given layers filled in from data
-
createAspect
Creates an aspect from configuration information. The ranges argument will be used only ifuseRanges
returns true. It is legal to give the ranges argument as null in any case. In all cases, the returned value must be non-null and usable bycreateSurface
.- Parameters:
profile
- surface configuration profileaspectConfig
- configuration map that may contain keys fromgetAspectKeys
ranges
- range data filled in from layers, or null- Returns:
- new aspect
-
getAspectConfig
Returns a ConfigMap that corresponds to the configuration of the given surface, which must have been created by this factory. The intention is that supplying the returned config items to this object'screateAspect
method with the right profile should come up with approximately the same surface, preferably without reference to any supplied ranges.The returned config items should be optimised for presentation to the user, so that for instance decimal values are reported to a reasonable level of precision. Because of this, and perhaps for other reasons related to implementation, a surface resulting from feeding the returned config back to this factory may not be identical to the supplied surface, so round-tripping is not guaranteed to be exact.
- Parameters:
surface
- plot surface; if it was not created by this factory, behaviour is undefined- Returns:
- config map populated with items that should approximately reproduce the supplied surface
-
getPlotMetric
PlotMetric getPlotMetric()Returns an object that can assess distances between graphic positions on the plot surface. If no such metric exists, null may be returned.- Returns:
- plot metric, or null
-