|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
---|---|
A |
createAspect(P profile,
ConfigMap aspectConfig,
Range[] ranges)
Creates an aspect from configuration information. |
Navigator<A> |
createNavigator(ConfigMap navigatorConfig)
Creates a navigator from configuration information. |
P |
createProfile(ConfigMap config)
Creates a profile that can be used when creating a plot surface. |
Surface |
createSurface(Rectangle plotBounds,
P profile,
A aspect)
Returns a new plot surface. |
ConfigKey[] |
getAspectKeys()
Returns the configuration keys that may be used to configure aspect for this surface factory. |
ConfigKey[] |
getNavigatorKeys()
Returns the configuration keys that may be used to configure a navigator for use with this surface factory. |
ConfigKey[] |
getProfileKeys()
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 to createAspect . |
boolean |
useRanges(P profile,
ConfigMap aspectConfig)
Indicates whether ranges should be provided to generate an aspect. |
Method Detail |
---|
Surface createSurface(Rectangle plotBounds, P profile, A aspect)
plotBounds
- rectangle to containing actual plot data
(not insets)profile
- configuration object defining plot styleaspect
- configuration object defining plot viewpoint
ConfigKey[] getProfileKeys()
createProfile
method.
P createProfile(ConfigMap config)
getProfileKeys
.
The return value can be used as input to
createSurface
and other methods in this class.
config
- map of profile configuration items
ConfigKey[] getAspectKeys()
useRanges
and
createAspect
methods.
boolean useRanges(P profile, ConfigMap aspectConfig)
readRanges
to createAspect
alongside the arguments of this method.
If false, any such ranges will be ignored.
profile
- surface configuration profileaspectConfig
- configuration map that may contain keys from
getAspectKeys
@Slow Range[] readRanges(P profile, PlotLayer[] layers, DataStore dataStore)
createAspect
.
There is only any point calling this if useRanges
returns true.
profile
- surface configuration profilelayers
- plot layers to be plotteddataStore
- contains actual data
A createAspect(P profile, ConfigMap aspectConfig, Range[] ranges)
useRanges
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 by
createSurface
.
profile
- surface configuration profileaspectConfig
- configuration map that may contain keys from
getAspectKeys
ranges
- range data filled in from layers, or null
ConfigKey[] getNavigatorKeys()
createNavigator(uk.ac.starlink.ttools.plot2.config.ConfigMap)
method.
Navigator<A> createNavigator(ConfigMap navigatorConfig)
navigatorConfig
- configuration map that may contain keys from
getNavigatorKeys
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |