Package com.luciad.view.gxy

Interface ILcdGXYContext

All Superinterfaces:

Serializable

All Known Implementing Classes:

ALcdGXYContextWrapper, TLcdGXYContext

public interface ILcdGXYContext
extends Serializable

ILcdGXYContext defines the context to be used by an ILcdGXYPainter (respectively an ILcdGXYEditor) for drawing (editing) on an ILcdGXYView an Object belonging to an ILcdModel.

It contains information such as:

• the ILcdGXYView where the drawing or editing occurs,
• the ILcdGXYLayer and therefor the ILcdModel the Object belongs to,
• the Graphics where to perform the drawing,
• the ILcdModelXYWorldTransformation to transform model coordinates into world coordinates and vice versa.
• the ILcdGXYViewXYWorldTransformation to transform world coordinates into view coordinates and vice versa.
• the current location of a number of input points (mouse, touch etc...) and their translations (e.g. mouse drag) when this information is required.
• snapping information when available
• an ILcdGXYPen for supporting drawing and editing on a Graphics.

.

Note: As of 10.0 implementing or wrapping ILcdGXYContext from scratch is strongly discouraged. Please extend from TLcdGXYContext for your own implementations. If you want to wrap an ILcdGXYContext, extend ALcdGXYContextWrapper.

See Also:

• ILcdGXYPainter
• ILcdGXYEditor
• ILcdGXYLayer

Method Summary

Modifier and Type	Method	Description
int	getDeltaX()	Returns the delta x for the first input point.
int	getDeltaX(int aIndex)	Returns the delta x for the input point at index aIndex.
int	getDeltaY()	Returns the delta y for the first input point.
int	getDeltaY(int aIndex)	Returns the delta y for the input point at index aIndex.
ILcdGXYLayer	getGXYLayer()
ILcdGXYPen	getGXYPen()
ILcdGXYView	getGXYView()
ILcdGXYViewXYWorldTransformation	getGXYViewXYWorldTransformation()
int	getInputPointCount()	Returns the number of input points.
ILcdModelXYWorldTransformation	getModelXYWorldTransformation()
Map<Object,Object>	getProperties()	Returns a modifiable map to store and retrieve implementation specific context information.
int	getSensitivity()	Returns the sensitivity that should be used for painting and editing purposes.
Object	getSnapTarget()	Short for getSnapTarget( 0 )
Object	getSnapTarget(int aIndex)	The snap target at index aIndex if the painting or editing action requires one.
ILcdGXYLayer	getSnapTargetLayer()	Short for getSnapTargetLayer( 0 )
ILcdGXYLayer	getSnapTargetLayer(int aIndex)	Returns the ILcdGXYLayer of the snap target at index aIndex.
int	getX()	Returns the current x coordinate of the first input point.
int	getX(int aIndex)	Returns the current x coordinate of the input point at the given index.
int	getY()	Returns the current y coordinate of the first input point.
int	getY(int aIndex)	Returns the current y coordinate of the input point at the given index.

Method Details

getGXYView

ILcdGXYView getGXYView()

Returns:

the ILcdGXYView where the drawing or editing occurs.

See Also:

• ILcdGXYView

getGXYLayer

ILcdGXYLayer getGXYLayer()

Returns:

the ILcdGXYLayer (and therefor the ILcdModel) the Object to paint or edit belongs to.

See Also:

• ILcdLayer.getModel()

getGXYViewXYWorldTransformation

ILcdGXYViewXYWorldTransformation getGXYViewXYWorldTransformation()

Returns:

a valid ILcdGXYViewXYWorldTransformation that can be used as support for painting or editing.

See Also:

• ILcdGXYPen

getModelXYWorldTransformation

ILcdModelXYWorldTransformation getModelXYWorldTransformation()

Returns:

a valid ILcdModelXYWorldTransformation that can be used as support for painting or editing.

See Also:

• ILcdGXYPen

getGXYPen

ILcdGXYPen getGXYPen()

Returns:

a valid ILcdGXYPen that can be used as support for painting or editing.

See Also:

• ILcdGXYPen

getInputPointCount

int getInputPointCount()

Returns the number of input points. For mouse-based interaction, this will usually be 1, for touch-based interaction it can be more.

Returns:

the number of input points

getX

int getX()

Returns the current x coordinate of the first input point.

Returns:

the x coordinate of the current location of the input point at index 0 expressed in view coordinates. If getInputPointCount() == 0, 0 will be returned.

See Also:

• ILcdGXYPainter.paint(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext)
• ILcdGXYEditor.edit(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext)
• getInputPointCount()
• getX(int)

getX

int getX(int aIndex)
  throws IndexOutOfBoundsException

Returns the current x coordinate of the input point at the given index.

Parameters:

aIndex - the index of the input point

Returns:

the x coordinate of the current location of the input point at index aIndex, expressed in view coordinates

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getInputPointCount())

See Also:

• ILcdGXYPainter.paint(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext)
• ILcdGXYEditor.edit(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext)
• getInputPointCount()

getY

int getY()

Returns the current y coordinate of the first input point.

Returns:

the y coordinate of the current location of the input point at index 0, expressed in view coordinates. If getInputPointCount() == 0, 0 will be returned.

See Also:

• ILcdGXYPainter.paint(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext)
• ILcdGXYEditor.edit(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext)
• getInputPointCount()
• getY(int)

getY

int getY(int aIndex)
  throws IndexOutOfBoundsException

Returns the current y coordinate of the input point at the given index.

Parameters:

aIndex - the index of the input point

Returns:

the y coordinate of the current location of the input point at index aIndex, expressed in view coordinates

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getInputPointCount())

See Also:

• ILcdGXYPainter.paint(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext)
• ILcdGXYEditor.edit(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYContext)
• getInputPointCount()

getDeltaX

int getDeltaX()

Returns the delta x for the first input point. This is typically the difference between the current x value and the original x value triggering an interaction.

Returns:

the delta x value of the first input point, or 0 when getInputPointCount() == 0.

See Also:

• getInputPointCount()
• getDeltaX(int)

getDeltaX

int getDeltaX(int aIndex)
       throws IndexOutOfBoundsException

Returns the delta x for the input point at index aIndex. This is typically the difference between the current x value and the original x value triggering an interaction.

Parameters:

aIndex - the index

Returns:

the delta x for the input point at index aIndex, expressed in view coordinates

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getInputPointCount())

See Also:

• getInputPointCount()

getDeltaY

int getDeltaY()

Returns the delta y for the first input point. This is typically the difference between the current y value and the original y value triggering the interaction.

Returns:

the delta y value of the first input point, or 0 when getInputPointCount() == 0.

See Also:

• getInputPointCount()
• getDeltaY(int)

getDeltaY

int getDeltaY(int aIndex)
       throws IndexOutOfBoundsException

Returns the delta y for the input point at index aIndex. This is typically the difference between the current x value and the original y value triggering an interaction.

Parameters:

aIndex - the index

Returns:

the delta y for the input point at index aIndex, expressed in view coordinates

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getInputPointCount())

See Also:

• getInputPointCount()

getSnapTarget

Object getSnapTarget()

Short for getSnapTarget( 0 )

When getInputPointCount() ()} == 0, this method will return null, while getSnapTarget( 0 ) will throw an IndexOutOfBoundsException.

Returns:

the first snap target, or null when no snap target is available

See Also:

• getSnapTarget(int)

getSnapTarget

Object getSnapTarget(int aIndex)
              throws IndexOutOfBoundsException

The snap target at index aIndex if the painting or editing action requires one. This snap target should correspond to the input point at index aIndex.

Parameters:

aIndex - the index

Returns:

the snap target at index aIndex

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getInputPointCount())

getSnapTargetLayer

ILcdGXYLayer getSnapTargetLayer()

Short for getSnapTargetLayer( 0 )

When getInputPointCount() ()} == 0, this method will return null, while getSnapTarget( 0 ) will throw an IndexOutOfBoundsException.

Returns:

the layer of the first snap target, or null when no snap target is available

getSnapTargetLayer

ILcdGXYLayer getSnapTargetLayer(int aIndex)
                         throws IndexOutOfBoundsException

Returns the ILcdGXYLayer of the snap target at index aIndex.

Parameters:

aIndex - the index

Returns:

the ILcdGXYLayer of the snap target at index aIndex

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getInputPointCount())

getSensitivity

int getSensitivity()

Returns the sensitivity that should be used for painting and editing purposes. This is for instance the distance between an input point and a handle that still allows the input to interact with the handle. Returning a value smaller than zero indicates that the painter/editor can choose the sensitivity to use.

Returns:

the sensitivity for painting/editing purposes or a value smaller than zero if the sensitivity should be chosen by the painter/editor.

getProperties

Map<Object,Object> getProperties()

Returns a modifiable map to store and retrieve implementation specific context information. For example, an editor can use it to store information on an ongoing creation or editing process across multiple invocations, e.g. the handle that is currently being edited.

Returns:

a modifiable map to store and retrieve implementation specific context information