Overview
Package
Class
Use
Tree
Deprecated
Index
Help
PREV LETTER
NEXT LETTER
FRAMES
NO FRAMES
All Classes
A
B
C
D
E
F
G
H
I
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
G
get(PVector)
- Method in class org.gicentre.utils.geom.
HashGrid
Returns a collection of the locatable objects that are within the
radius
of the given location.
getAll()
- Method in class org.gicentre.utils.geom.
HashGrid
Returns a set of all objects stored in the hash grid.
getAlpha(int)
- Static method in class org.gicentre.utils.colour.
ColourTable
Reports the alpha value of the given colour.
getAnimationSpeed()
- Method in class org.gicentre.utils.stat.
LikertChart
Reports the animation speed for all transitions (e.g.
getArea()
- Method in class org.gicentre.utils.spatial.
Postcode
Reports the postcode area or null if the postcode is invalid.
getAreaCode()
- Method in class org.gicentre.utils.spatial.
Postcode
Reports the part of the postcode that represents the postcode area or null if the postcode is invalid.
getAttributes(String)
- Method in class org.gicentre.utils.io.
DOMProcessor
Searches the entire DOM for a given attribute and returns the value associated with it.
getAttributes(String, Node)
- Method in class org.gicentre.utils.io.
DOMProcessor
Searches the given node and its children for a given attribute and returns the value associated with it.
getBarAt(float, float)
- Method in class org.gicentre.utils.stat.
LikertChart
Reports the bar at the given (x,y) location.
getBorder(AbstractChart.Side)
- Method in class org.gicentre.utils.stat.
AbstractChart
Reports the internal border between the given edge of the chart and the drawing area.
getCentre()
- Method in class org.gicentre.utils.stat.
StandardEllipse
Reports the centre of the ellipse.
getColour(double, double, double, boolean)
- Method in class org.gicentre.utils.colour.
CIELab
Finds the colour corresponding to the given CIELab triplet.
getColour(double, double, double, boolean)
- Method in class org.gicentre.utils.colour.
CIELuv
Finds the colour corresponding to the given CIELuv triplet.
getColour(float)
- Method in class org.gicentre.utils.colour.
ColourRule
Interpolates the colour associated with the given index.
getColourFromLCh(double, double, double)
- Method in class org.gicentre.utils.colour.
CIELuv
Finds the colour corresponding to the given CIELCh triplet.
getColourFromLCh(double, double, double, boolean)
- Method in class org.gicentre.utils.colour.
CIELuv
Finds the colour corresponding to the given CIELCh triplet.
getColourRules()
- Method in class org.gicentre.utils.colour.
ColourTable
Returns the rules associated with the colour table
getColourTableType()
- Method in class org.gicentre.utils.colour.
ColourTable
Reports type of colour table (
COLOUR_RULES
,
COLOUR_ATTRIB
or
COLOUR_RAW
).
getConsensus()
- Method in class org.gicentre.utils.stat.
LikertChart
Reports the consensus score of this Likert distribution.
getConsensusComparator()
- Static method in class org.gicentre.utils.stat.
LikertChart
Provides a comparator that can be used for sorting Likert charts by their consensus scores.
getCoordToDisp(PVector)
- Method in class org.gicentre.utils.move.
ZoomPan
Transforms the given point from coordinate to display space.
getCustomComparator()
- Static method in class org.gicentre.utils.stat.
LikertChart
Provides a custom comparator that can be used for sorting Likert charts in the order implied by the values provided to
setOrder()
.
getData(int)
- Method in class org.gicentre.utils.stat.
AbstractChart
Reports the data to be displayed along the given axis of the chart.
getData()
- Method in class org.gicentre.utils.stat.
BarChart
Reports the data values used to calculate bar lengths in the chart.
getDataToScreen(PVector)
- Method in class org.gicentre.utils.stat.
BarChart
Converts given data point into its screen location.
getDataToScreen(PVector)
- Method in class org.gicentre.utils.stat.
XYChart
Converts given data point into its screen location.
getDescription()
- Method in class org.gicentre.utils.spatial.
AlbersEqualAreaConic
Provides a general description of the transformation.
getDescription()
- Method in class org.gicentre.utils.spatial.
FrenchNTF
Provides a general description of the transformation.
getDescription()
- Method in class org.gicentre.utils.spatial.
ObliqueMercator
Provides a general description of the transformation.
getDescription()
- Method in class org.gicentre.utils.spatial.
OSGB
Provides a general description of the transformation.
getDescription()
- Method in class org.gicentre.utils.spatial.
Swiss
Provides a general description of the transformation.
getDescription()
- Method in class org.gicentre.utils.spatial.
UTM
Provides a general description of the transformation.
getDispToCoord(PVector)
- Method in class org.gicentre.utils.move.
ZoomPan
Transforms the given point from display to coordinate space.
getDistrict()
- Method in class org.gicentre.utils.spatial.
Postcode
Reports the postcode district or null if the postcode is invalid.
getDistrictCode()
- Method in class org.gicentre.utils.spatial.
Postcode
Reports the part of the postcode that represents the postcode district or null if the postcode is invalid.
getElapsedTime()
- Method in class org.gicentre.utils.
FrameTimer
Retrieves the time since the last call to
startTimer()
getElements(String)
- Method in class org.gicentre.utils.io.
DOMProcessor
Returns a list of the DOM elements with the given name.
getElements(String, Node)
- Method in class org.gicentre.utils.io.
DOMProcessor
Returns a list of the DOM elements with the given name that are nested within the given node.
getEllipsoid()
- Method in class org.gicentre.utils.spatial.
AlbersEqualAreaConic
Reports the ellipsoid used in the transformation.
getEllipsoid()
- Method in class org.gicentre.utils.spatial.
FrenchNTF
Reports the ellipsoid used in the transformation (Clarke 1880).
getEllipsoid()
- Method in class org.gicentre.utils.spatial.
ObliqueMercator
Reports the ellipsoid used in the transformation.
getEllipsoid()
- Method in class org.gicentre.utils.spatial.
Swiss
Reports the ellipsoid used in the transformation.
getEllipsoid()
- Method in class org.gicentre.utils.spatial.
UTM
Reports the ellipsoid used in the transformation.
getEquatorialRadius()
- Method in class org.gicentre.utils.spatial.
Ellipsoid
Reports the equatorial radius represented by this ellipsoid.
getErrorMessage()
- Method in class org.gicentre.utils.spatial.
Postcode
Reports any error messages associated with an attempt to parse the postcode text.
getExternalMargin()
- Method in class org.gicentre.utils.gui.
TextPopup
Reports the external margins between the popup and the sketch.
getFrequencies()
- Method in class org.gicentre.utils.stat.
LikertChart
Reports the frequency values that are used to produce the Likert chart.
getHeight()
- Method in class org.gicentre.utils.gui.
Tooltip
Reports the height of the tooltip.
getHexString(int)
- Static method in class org.gicentre.utils.colour.
ColourTable
Converts a given colour into its HTML-like hex string in the form
#rrggbb
.
getHexStringABGR(int)
- Static method in class org.gicentre.utils.colour.
ColourTable
Converts a given colour into its hex string in the form
aabbggrr
.
getHighlightBar()
- Method in class org.gicentre.utils.stat.
LikertChart
Reports the index of the currently highlighted bar or -1 if no bar highlighted.
getHull(Collection<PVector>)
- Static method in class org.gicentre.utils.geom.
ConvexHull
Calculates the convex hull from the given collection of point values.
getHull()
- Method in class org.gicentre.utils.geom.
ConvexHull
Provides the convex hull that surrounds the collection of points stored in this object.
getID()
- Method in class org.gicentre.utils.spatial.
Ellipsoid
Reports the ID of this ellipsoid.
getInEdges()
- Method in class org.gicentre.utils.network.
Node
Reports a list of all incoming edges attached to this node.
getInternalMargin()
- Method in class org.gicentre.utils.gui.
TextPopup
Reports the internal margins between the popup and the text displayed within it.
getIsActive()
- Method in class org.gicentre.utils.colour.
ColourPicker
Reports whether or not the colour picker is currently active.
getIsActive()
- Method in class org.gicentre.utils.gui.
HelpScreen
Reports whether or not the help window is currently active.
getIsActive()
- Method in class org.gicentre.utils.gui.
TextPopup
Reports whether or not the popup is currently active.
getIsDiscrete()
- Method in class org.gicentre.utils.colour.
ColourTable
Reports whether this colour table can be treated as consisting of discrete values only.
getIsLogScale(int)
- Method in class org.gicentre.utils.stat.
AbstractChart
Reports whether or not the data in the given dimension are to be represented on the log10 scale.
getLab(Color)
- Method in class org.gicentre.utils.colour.
CIELab
Finds the CIELab triplet representing the given colour.
getLab(Color, ColourConverter.WhitePoint)
- Static method in class org.gicentre.utils.colour.
ColourConverter
Finds the CIELab triplet representing the given colour.
getLastColour()
- Method in class org.gicentre.utils.colour.
ColourPicker
Reports the last selected colour.
getLastColourTable()
- Method in class org.gicentre.utils.colour.
ColourPicker
Reports the last selected colour table.
getLCh(Color)
- Method in class org.gicentre.utils.colour.
CIELuv
Finds the CIELCh triplet representing the given colour.
getlColour()
- Method in class org.gicentre.utils.colour.
ColourRule
Finds the colour associated with the lower index.
getlIndex()
- Method in class org.gicentre.utils.colour.
ColourRule
Finds the lower index associated with colour rule.
getLocation()
- Method in interface org.gicentre.utils.geom.
Locatable
Should report the location of the object as a PVector.
getLocation()
- Method in class org.gicentre.utils.network.
Node
Reports the node's location.
getLongTitle()
- Method in class org.gicentre.utils.stat.
LikertChart
Reports the long title of this Likert chart.
getLuv(Color)
- Method in class org.gicentre.utils.colour.
CIELuv
Finds the CIELuv triplet representing the given colour.
getLuv(Color, ColourConverter.WhitePoint)
- Static method in class org.gicentre.utils.colour.
ColourConverter
Finds the CIELuv triplet representing the given colour.
getMajorAxis()
- Method in class org.gicentre.utils.stat.
StandardEllipse
Reports the length of the major axis of the ellipse.
getMajorEndpoint1()
- Method in class org.gicentre.utils.stat.
StandardEllipse
Reports the coordinates of one of the end points of the major axis.
getMajorEndpoint2()
- Method in class org.gicentre.utils.stat.
StandardEllipse
Reports the coordinates of one of the end points of the major axis.
getMax(int)
- Method in class org.gicentre.utils.stat.
AbstractChart
Reports the maximum value of the data to be charted on the axis of the given dimension.
getMaxIndex()
- Method in class org.gicentre.utils.colour.
ColourTable
Finds the highest index value in a set of colour rules.
getMaxLog(int)
- Method in class org.gicentre.utils.stat.
AbstractChart
Reports the maximum value of the log10 of the data to be charted on the axis of the given dimension.
getMaxValue()
- Method in class org.gicentre.utils.stat.
BarChart
Reports the maximum value that can be displayed by the bar chart.
getMaxX()
- Method in class org.gicentre.utils.stat.
XYChart
Reports the maximum x value that can be displayed by the XY chart.
getMaxY()
- Method in class org.gicentre.utils.stat.
XYChart
Reports the maximum y value that can be displayed by the XY chart.
getMean()
- Method in class org.gicentre.utils.stat.
LikertChart
Reports the mean score of this Likert distribution.
getMeanComparator()
- Static method in class org.gicentre.utils.stat.
LikertChart
Provides a comparator that can be used for sorting Likert charts by their mean scores.
getMin(int)
- Method in class org.gicentre.utils.stat.
AbstractChart
Reports the minimum value of the data to be charted on the axis of the given dimension.
getMinBorder()
- Method in class org.gicentre.utils.stat.
AbstractChart
Reports the minimum internal border between the chart and the drawing area.
getMinIndex()
- Method in class org.gicentre.utils.colour.
ColourTable
Finds the lowest index value in a set of colour rules.
getMinLog(int)
- Method in class org.gicentre.utils.stat.
AbstractChart
Reports the minimum value of the log10 of the data to be charted on the axis of the given dimension.
getMinorAxis()
- Method in class org.gicentre.utils.stat.
StandardEllipse
Reports the length of the minor axis of the ellipse.
getMinorEndpoint1()
- Method in class org.gicentre.utils.stat.
StandardEllipse
Reports the coordinates of one of the end points of the minor axis.
getMinorEndpoint2()
- Method in class org.gicentre.utils.stat.
StandardEllipse
Reports the coordinates of one of the end points of the minor axis.
getMinValue()
- Method in class org.gicentre.utils.stat.
BarChart
Reports the minimum value that can be displayed by the bar chart.
getMinX()
- Method in class org.gicentre.utils.stat.
XYChart
Reports the minimum x value that can be displayed by the XY chart.
getMinY()
- Method in class org.gicentre.utils.stat.
XYChart
Reports the minimum y value that can be displayed by the XY chart.
getMostSaturatedColour(double)
- Method in class org.gicentre.utils.colour.
CIELuv
Finds the most saturated colour for the given hue.
getMouseCoord()
- Method in class org.gicentre.utils.move.
ZoomPan
Reports the current mouse position in coordinate space.
getN()
- Method in class org.gicentre.utils.spatial.
Ellipsoid
Reports the degree of flattening as the ratio (a-b)/(a+b).
getName()
- Method in class org.gicentre.utils.colour.
ColourTable
Reports the name attached to the colour table.
getName()
- Method in class org.gicentre.utils.spatial.
Ellipsoid
Reports the name associated with this ellipsoid.
getName(int)
- Static method in class org.gicentre.utils.spatial.
Ellipsoid
Reports the name associated with the given ellipsoid ID.
getNode1()
- Method in class org.gicentre.utils.network.
Edge
Reports the first node connected to this edge
getNode2()
- Method in class org.gicentre.utils.network.
Edge
Reports the second node connected to this edge
getNodeAttribute(String, Node)
- Method in class org.gicentre.utils.io.
DOMProcessor
Searches the given node for a given attribute and returns the value associated with it.
getNodeElement(String, Node)
- Method in class org.gicentre.utils.io.
DOMProcessor
Returns a DOM element with the given name that is the child of the given node.
getNodeElements(String, Node)
- Method in class org.gicentre.utils.io.
DOMProcessor
Returns the DOM elements with the given name that are the children of the given node.
getNodeText(Node)
- Method in class org.gicentre.utils.io.
DOMProcessor
Searches for a given node and returns text associated with it.
getNumBars()
- Method in class org.gicentre.utils.stat.
BarChart
Reports the number of bars in the bar chart.
getOrder()
- Method in class org.gicentre.utils.stat.
LikertChart
Reports the order value used for custom ordering of a collection of Likert charts.
getOutEdges()
- Method in class org.gicentre.utils.network.
Node
Reports a list of all outgoing edges attached to this node.
getPanOffset()
- Method in class org.gicentre.utils.move.
ZoomPan
Reports the current pan offset.
getParentSketch()
- Method in class org.gicentre.utils.multisketch.
EmbeddedSketch
Reports the parent sketch that spawned this embedded one.
getParticle(Node)
- Method in class org.gicentre.utils.network.
ParticleViewer
Provides the particle associated with the given node.
getPolarRadius()
- Method in class org.gicentre.utils.spatial.
Ellipsoid
Reports the polar radius represented by the ellipsoid.
getPresetColourTable(int)
- Static method in class org.gicentre.utils.colour.
ColourTable
Creates a preset colour table scaled between default minimum and maximum values.
getPresetColourTable(int, float, float)
- Static method in class org.gicentre.utils.colour.
ColourTable
Creates a preset colour table between the given values.
getRotation()
- Method in class org.gicentre.utils.stat.
StandardEllipse
Reports the rotation of the ellipse.
getScale()
- Method in class org.gicentre.utils.stat.
StandardEllipse
Reports the scaling of the ellipse.
getScreenToData(PVector)
- Method in class org.gicentre.utils.stat.
BarChart
Converts given screen coordinate into its equivalent data value.
getScreenToData(PVector)
- Method in class org.gicentre.utils.stat.
XYChart
Converts given screen coordinate into its equivalent data value.
getSecondaryColour()
- Method in class org.gicentre.utils.stat.
LikertChart
Reports the colour to be used for the secondary data in the chart.
getSecondaryData()
- Method in class org.gicentre.utils.stat.
LikertChart
Reports the seconday data that may be drawn in this chart.
getSector()
- Method in class org.gicentre.utils.spatial.
Postcode
Reports the postcode sector or null if the postcode is invalid.
getSectorCode()
- Method in class org.gicentre.utils.spatial.
Postcode
Reports the part of the postcode that represents the postcode sector or null if the postcode is invalid.
getSequential(double, int)
- Method in class org.gicentre.utils.colour.
CIELuv
Provides a single hue sequential scheme using the given hue and having the given number of colours.
getSequential(double, double, double, int)
- Method in class org.gicentre.utils.colour.
CIELuv
Provides a single hue sequential scheme using the given hue and having the given number of colours.
getSequential(double, double, double, double, int)
- Method in class org.gicentre.utils.colour.
CIELuv
Provides a multi-hue sequential scheme using the given hues and having the given number of colours.
getShowAxis(int)
- Method in class org.gicentre.utils.stat.
AbstractChart
Reports whether or not the axis representing the given dimension is drawn.
getSquaredEccentricity()
- Method in class org.gicentre.utils.spatial.
Ellipsoid
Reports the squared eccentricity of this ellipsoid.
getText()
- Method in class org.gicentre.utils.gui.
TextInput
Reports the text that has been entered in the input field.
getText(String)
- Method in class org.gicentre.utils.io.
DOMProcessor
Searches the entire DOM for a given element and returns text associated with it.
getText(Node)
- Method in class org.gicentre.utils.io.
DOMProcessor
Returns any text associated found in the given node or its children.
getText(String, Node)
- Method in class org.gicentre.utils.io.
DOMProcessor
Searches for a given element and returns text associated with it.
getText()
- Static method in class org.gicentre.utils.
Version
Reports the current version of the gicentre utilities package.
getTextColour()
- Method in class org.gicentre.utils.stat.
LikertChart
Reports the colour to be used for the title of the chart and any other text.
getTextPadding()
- Method in class org.gicentre.utils.stat.
LikertChart
Reports the extra padding between title and chart.
getTextSize()
- Method in class org.gicentre.utils.gui.
TextPopup
Reports the current text size in pixels.
getTextSize()
- Method in class org.gicentre.utils.stat.
LikertChart
Reports the size of the title text in pixels or -1 if text size is calculated automatically.
getTitle()
- Method in class org.gicentre.utils.stat.
LikertChart
Reports the title of this Likert chart.
getType()
- Method in class org.gicentre.utils.colour.
ColourRule
Reports the type of colour rule.
getuColour()
- Method in class org.gicentre.utils.colour.
ColourRule
Finds the colour associated with the upper index.
getuIndex()
- Method in class org.gicentre.utils.colour.
ColourRule
Finds the upper index associated with colour rule.
getUnit()
- Method in class org.gicentre.utils.spatial.
Postcode
Reports the postcode unit or null if the postcode is invalid.
getUnit7()
- Method in class org.gicentre.utils.spatial.
Postcode
Reports a seven digit unit postcode or null if the postcode is invalid.
getUnitCode()
- Method in class org.gicentre.utils.spatial.
Postcode
Reports the part of the postcode that represents the postcode unit or null if the postcode is invalid.
getVersion()
- Static method in class org.gicentre.utils.
Version
Reports the numeric version of the gicentre utilities package.
getWidth()
- Method in class org.gicentre.utils.gui.
Tooltip
Reports the width of the tooltip.
getWidthScale()
- Method in class org.gicentre.utils.stat.
LikertChart
Reports the proportion of the width allocated to each bar that contains a coloured bar.
getXData()
- Method in class org.gicentre.utils.stat.
XYChart
Reports the data values that are displayed in the chart along the X axis.
getYData()
- Method in class org.gicentre.utils.stat.
XYChart
Reports the data values that are displayed in the chart along the Y axis.
getZone()
- Method in class org.gicentre.utils.spatial.
UTM
Reports the full UTM zone of currently used by the projection.
getZoneLetter()
- Method in class org.gicentre.utils.spatial.
FrenchNTF
Reports the Lambert zone letter.
getZoneLetter()
- Method in class org.gicentre.utils.spatial.
UTM
Reports the UTM zone letter currently used by the projection.
getZoneNumber()
- Method in class org.gicentre.utils.spatial.
FrenchNTF
Reports the Lambert zone number used for the projection.
getZoneNumber()
- Method in class org.gicentre.utils.spatial.
UTM
Reports the UTM zone currently used by the projection.
getZoomScale()
- Method in class org.gicentre.utils.move.
ZoomPan
Reports the current zoom scale.
GN_BU
- Static variable in class org.gicentre.utils.colour.
ColourTable
ColorBrewer sequential green-blue scheme.
GREENS
- Static variable in class org.gicentre.utils.colour.
ColourTable
ColorBrewer sequential monochrome green scheme.
GREYS
- Static variable in class org.gicentre.utils.colour.
ColourTable
ColorBrewer sequential monochrome grey scheme.
GREYSCALE
- Static variable in class org.gicentre.utils.colour.
ColourTable
Greyscale (black to white) colour table.
GRS_1967
- Static variable in class org.gicentre.utils.spatial.
Ellipsoid
GRS 1967 ellipsoid.
GRS_1980
- Static variable in class org.gicentre.utils.spatial.
Ellipsoid
GRS 1980 ellipsoid (used by NAD 1983 datum).
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
PREV LETTER
NEXT LETTER
FRAMES
NO FRAMES
All Classes
A
B
C
D
E
F
G
H
I
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
gicentreUtils V.3.1, API documentation generated 18th February, 2011