org.tinfour.demo.viewer.backplane

Class MvComposite

java.lang.Object

org.tinfour.demo.viewer.backplane.MvComposite

public class MvComposite
extends Object

Provides elements and method for managing the imagery associated with a model and a set of view options.

Constructor Summary

Constructors

Constructor and Description
MvComposite(IModel model, ViewOptions view, int width, int height, AffineTransform m2c, AffineTransform c2m, int taskIndex) Construct an instance with the specified rendering elements.
MvComposite(MvComposite mvComposite, ViewOptions view, boolean preserveTins, int taskIndex) Construct a new composite transferring data products from the older composite so that they may be reused without additional processing.

Method Summary

Modifier and Type	Method and Description
AffineTransform	getComposite2ModelTransform() Get the transform that maps the composite to the model
List<IConstraint>	getConstraintsForRender()
int	getHeight() Get the height of the composite
IModel	getModel() Get the model associated with composite.
AffineTransform	getModel2CompositeTransform() Get a transform that maps the model to the composite
String	getModelAndRenderingReport()
String	getModelDataStringAtCoordinates(double x, double y) Map the specified composite coordinates to the model and get a string indicating the data at that point.
int	getTaskIndex() Get the index of the task currently associated with the composite.
ViewOptions	getView() Get the view options associated with the composite.
int	getWidth() Get the width of the composite
boolean	isModelReloadRequired(ViewOptions v) Indicates whether a change in view options would require reloading the existing model.
boolean	isReady()
MvQueryResult	performQuery(double x, double y) Maps the specified composite coordinates to the model, performs a data query, and gets an HTML-formatted string indicating the data at that point.
BufferedImage	renderLegend(ViewOptions vx, IModel mx, int width, int height, int margin, Font font, boolean frame) Render a legend for the current model and view.
void	setConstraintsForRender(List<IConstraint> constraintsForRender) Sets the constraints for rendering.
void	setWireframeTin(IIncrementalTin tin, int reduction) Sets the TIN to be used for wireframe rendering.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MvComposite

public MvComposite(IModel model,
                   ViewOptions view,
                   int width,
                   int height,
                   AffineTransform m2c,
                   AffineTransform c2m,
                   int taskIndex)

Construct an instance with the specified rendering elements. Note that once instantiated, the model and view must never be changed.

Parameters:

model - a valid instance giving a data source

view - a valid specification giving instructions on how the data is to be rendered

width - the width of the panel rendering surface

height - the height of the panel rendering surface

m2c - the model to composite transformation; specify a null for first time initialization

c2m - the composite to model transformation; specify a null for first time initialization

taskIndex - the index of the task used during the initialization of this instance

MvComposite

public MvComposite(MvComposite mvComposite,
                   ViewOptions view,
                   boolean preserveTins,
                   int taskIndex)

Construct a new composite transferring data products from the older composite so that they may be reused without additional processing. These elements may include TINs and grids as well as transformations. Generally, this method is used when the styling has changed, but the geometry has not.

Parameters:

mvComposite - the older composite

view - a valid set of view parameters

preserveTins - preserve TIN elements from previous composite

taskIndex - the index for the task associated with the composite

Method Detail

getModel

public IModel getModel()

Get the model associated with composite.

Returns:

a valid instance

getView

public ViewOptions getView()

Get the view options associated with the composite. It is important that application code not alter the content of the options object/

Returns:

a valid view object.

getTaskIndex

public int getTaskIndex()

Get the index of the task currently associated with the composite.

Returns:

a positive integer

getWidth

public int getWidth()

Get the width of the composite

Returns:

a positive integer in pixels

getHeight

public int getHeight()

Get the height of the composite

Returns:

a positive integer value in pixels

setWireframeTin

public void setWireframeTin(IIncrementalTin tin,
                            int reduction)

Sets the TIN to be used for wireframe rendering. Important: the TIN must not be modified after it is added to this composite.

Parameters:

tin - a valid TIN.

reduction - the reduction factor applied when building the TIN

getComposite2ModelTransform

public AffineTransform getComposite2ModelTransform()

Get the transform that maps the composite to the model

Returns:

a valid instance

getModel2CompositeTransform

public AffineTransform getModel2CompositeTransform()

Get a transform that maps the model to the composite

Returns:

a valid instance

getModelDataStringAtCoordinates

public String getModelDataStringAtCoordinates(double x,
                                              double y)

Map the specified composite coordinates to the model and get a string indicating the data at that point. Typically called to support mouse move events.

Parameters:

x - a coordinate in the composite coordinate system

y - a coordinate in the composite coordinate system

Returns:

a valid string

performQuery

public MvQueryResult performQuery(double x,
                                  double y)

Maps the specified composite coordinates to the model, performs a data query, and gets an HTML-formatted string indicating the data at that point.

Parameters:

x - a coordinate in the composite coordinate system

y - a coordinate in the composite coordinate system

Returns:

a valid string

isModelReloadRequired

public boolean isModelReloadRequired(ViewOptions v)

Indicates whether a change in view options would require reloading the existing model.

Parameters:

v - a set of view options for comparison

Returns:

true if the comparison options are incompatible and require a reloading of the model.

getModelAndRenderingReport

public String getModelAndRenderingReport()

isReady

public boolean isReady()

renderLegend

public BufferedImage renderLegend(ViewOptions vx,
                                  IModel mx,
                                  int width,
                                  int height,
                                  int margin,
                                  Font font,
                                  boolean frame)

Render a legend for the current model and view. The width and height are the dimensions of the color bar, but the actual legend will extend larger to accommodate labels.

Parameters:

vx - a valid view

mx - a valid model

width - the width of the color bar

height - the height of the color bar

margin - the margin around the overall legend

font - the font to be used for labeling (if enabled)

frame - indicates that a framing rectangle is to be drawn around the legend

Returns:

if successful, a valid buffered image; otherwise, a null

toString

public String toString()

Overrides:

toString in class Object

setConstraintsForRender

public void setConstraintsForRender(List<IConstraint> constraintsForRender)

Sets the constraints for rendering. These are often not the constraints from the model but a reduced-resolution version.

Parameters:

constraintsForRender - a potentially empty list of constraints

getConstraintsForRender

public List<IConstraint> getConstraintsForRender()