MGHGRCOLORSURFACE__DEFINE
Class Name
MGHgrColorSurface
Purpose
This class implements a colour plane using an IDLgrSurface. For a
description of what a colour plane is, see the documentation for
MGHgrColorPlane. Properties
The following properties are supported (amongst others):
DEFAULT_COLOR (Init,Get,Set)
The colour (indexed or RGB) of the surface, used if the
COLOR_VALUES property is not set.
COLOR_VALUES (Init,Get,Set)
An array of byte values dimensioned (m,n) or (3,m,n)
representing the colours of the cells (STYLE=0) or vertices
(STYLE=1).
DATAX, DATAY (Init,Get,Set)
1-D or 2-D arrays specifying the vertex positions.
MISSING_POINTS (Init,Get,Set)
A 2-D array of integer or byte values, with the same
dimensions as COLOR_VALUES, specifying which cell (STYLE=0) or
vertex (STYLE=1) values are deemed to be missing. Points are
omitted by setting the appropriate element of the
IDLgrSurface's DATAZ property to NaN.
PALETTE (Init,Get,Set)
A reference to the palette defining the byte<->color mapping.
STYLE (Init,Get)
An integer specifying whether colours are uniform over the
cells (STYLE=0) or interpolated from the vertices
(STYLE=1). Default is 0.
Category
Object graphics.
###########################################################################
This software is provided subject to the following conditions:
1. NIWA makes no representations or warranties regarding the
accuracy of the software, the use to which the software may
be put or the results to be obtained from the use of the
software. Accordingly NIWA accepts no liability for any loss
or damage (whether direct of indirect) incurred by any person
through the use of or reliance on the software.
2. NIWA is to be acknowledged as the original author of the
software where the software is used or presented in any form.
###########################################################################
Modification History
Mark Hadfield, 1998-09:
Written as MGHgrColorPlane2 (I think).
Mark Hadfield, 2000-12:
Renamed MGHgrColorSurface.
Mark Hadfield, 2004-07:
- Overhauled properties to support property-sheet
functionality. Properties now passed explicitly
to components--no EXTRA keywords.
- IDL 6.0 logical syntax.