|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.plot2.geom.TimeSurfaceFactory
public class TimeSurfaceFactory
Surface factory for time plots.
Nested Class Summary | |
---|---|
static class |
TimeSurfaceFactory.Profile
Profile class which defines fixed configuration items for a TimeSurface. |
Field Summary | |
---|---|
static ConfigKey<Boolean> |
GRID_KEY
Config key to determine if grid lines are drawn. |
static ConfigKey<Double> |
TCROWD_KEY
Config key to control tick mark crowding on time axis. |
static ConfigKey<TimeFormat> |
TFORMAT_KEY
Config key to control time value formatting. |
static ConfigKey<String> |
TLABEL_KEY
Config key for time axis text label. |
static ConfigKey<Double> |
TMAX_KEY
Config key for time axis upper bound, before subranging. |
static ConfigKey<Double> |
TMIN_KEY
Config key for time axis lower bound, before subranging. |
static ConfigKey<Subrange> |
TSUBRANGE_KEY
Config key for time axis subrange. |
static ConfigKey<Double> |
YCROWD_KEY
Config key to control tick mark crowding on Y axis. |
static ConfigKey<Boolean> |
YFLIP_KEY
Config key for Y axis flip flag. |
static ConfigKey<String> |
YLABEL_KEY
Config key for Y axis text label. |
static ConfigKey<Boolean> |
YLOG_KEY
Config key for Y axis log scale flag. |
static ConfigKey<Double> |
YMAX_KEY
Config key for Y axis upper bound, before subranging. |
static ConfigKey<Double> |
YMIN_KEY
Config key for Y axis lower bound, before subranging. |
static ConfigKey<Subrange> |
YSUBRANGE_KEY
Config key for Y axis subrange. |
Constructor Summary | |
---|---|
TimeSurfaceFactory()
|
Method Summary | |
---|---|
TimeAspect |
createAspect(TimeSurfaceFactory.Profile profile,
ConfigMap config,
Range[] ranges)
Creates an aspect from configuration information. |
Navigator<TimeAspect> |
createNavigator(ConfigMap navConfig)
Creates a navigator from configuration information. |
TimeSurfaceFactory.Profile |
createProfile(ConfigMap config)
Creates a profile that can be used when creating a plot surface. |
Surface |
createSurface(Rectangle plotBounds,
TimeSurfaceFactory.Profile profile,
TimeAspect 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(TimeSurfaceFactory.Profile profile,
PlotLayer[] layers,
DataStore dataStore)
Provides the ranges that may be passed to createAspect . |
boolean |
useRanges(TimeSurfaceFactory.Profile profile,
ConfigMap config)
Indicates whether ranges should be provided to generate an aspect. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final ConfigKey<Double> TMIN_KEY
public static final ConfigKey<Double> TMAX_KEY
public static final ConfigKey<Subrange> TSUBRANGE_KEY
public static final ConfigKey<Double> YMIN_KEY
public static final ConfigKey<Double> YMAX_KEY
public static final ConfigKey<Subrange> YSUBRANGE_KEY
public static final ConfigKey<Boolean> YLOG_KEY
public static final ConfigKey<Boolean> YFLIP_KEY
public static final ConfigKey<String> TLABEL_KEY
public static final ConfigKey<String> YLABEL_KEY
public static final ConfigKey<Boolean> GRID_KEY
public static final ConfigKey<Double> TCROWD_KEY
public static final ConfigKey<Double> YCROWD_KEY
public static final ConfigKey<TimeFormat> TFORMAT_KEY
Constructor Detail |
---|
public TimeSurfaceFactory()
Method Detail |
---|
public Surface createSurface(Rectangle plotBounds, TimeSurfaceFactory.Profile profile, TimeAspect aspect)
SurfaceFactory
createSurface
in interface SurfaceFactory<TimeSurfaceFactory.Profile,TimeAspect>
plotBounds
- rectangle to containing actual plot data
(not insets)profile
- configuration object defining plot styleaspect
- configuration object defining plot viewpoint
public ConfigKey[] getProfileKeys()
SurfaceFactory
createProfile
method.
getProfileKeys
in interface SurfaceFactory<TimeSurfaceFactory.Profile,TimeAspect>
public TimeSurfaceFactory.Profile createProfile(ConfigMap config)
SurfaceFactory
getProfileKeys
.
The return value can be used as input to
createSurface
and other methods in this class.
createProfile
in interface SurfaceFactory<TimeSurfaceFactory.Profile,TimeAspect>
config
- map of profile configuration items
public ConfigKey[] getAspectKeys()
SurfaceFactory
useRanges
and
createAspect
methods.
getAspectKeys
in interface SurfaceFactory<TimeSurfaceFactory.Profile,TimeAspect>
public boolean useRanges(TimeSurfaceFactory.Profile profile, ConfigMap config)
SurfaceFactory
readRanges
to createAspect
alongside the arguments of this method.
If false, any such ranges will be ignored.
useRanges
in interface SurfaceFactory<TimeSurfaceFactory.Profile,TimeAspect>
profile
- surface configuration profileconfig
- configuration map that may contain keys from
getAspectKeys
public TimeAspect createAspect(TimeSurfaceFactory.Profile profile, ConfigMap config, Range[] ranges)
SurfaceFactory
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
.
createAspect
in interface SurfaceFactory<TimeSurfaceFactory.Profile,TimeAspect>
profile
- surface configuration profileconfig
- configuration map that may contain keys from
getAspectKeys
ranges
- range data filled in from layers, or null
public Range[] readRanges(TimeSurfaceFactory.Profile profile, PlotLayer[] layers, DataStore dataStore)
SurfaceFactory
createAspect
.
There is only any point calling this if useRanges
returns true.
readRanges
in interface SurfaceFactory<TimeSurfaceFactory.Profile,TimeAspect>
profile
- surface configuration profilelayers
- plot layers to be plotteddataStore
- contains actual data
public ConfigKey[] getNavigatorKeys()
SurfaceFactory
SurfaceFactory.createNavigator(uk.ac.starlink.ttools.plot2.config.ConfigMap)
method.
getNavigatorKeys
in interface SurfaceFactory<TimeSurfaceFactory.Profile,TimeAspect>
public Navigator<TimeAspect> createNavigator(ConfigMap navConfig)
SurfaceFactory
createNavigator
in interface SurfaceFactory<TimeSurfaceFactory.Profile,TimeAspect>
navConfig
- configuration map that may contain keys from
getNavigatorKeys
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |