Package com.luciad.view.lightspeed.editor

Class TLspCircleBy3PointsEditor

java.lang.Object

com.luciad.view.lightspeed.editor.ALspEditor

com.luciad.view.lightspeed.editor.TLspCircleBy3PointsEditor

All Implemented Interfaces:

ILspEditor

public class TLspCircleBy3PointsEditor
extends ALspEditor

Enables visual editing of ILcd2DEditableCircleBy3Points objects in an ILspView.

Handles

The circle-by-3-points editor defines the following edit handles for a circle object:

• Circle point handles: allows the user to edit the circle. When a circle point is translated, the circle will make sure it includes that point. The user can change the location if the points by dragging the handle. This handle generates MOVE operations, with a HANDLE_IDENTIFIER property and START_POINT, INTERMEDIATE_POINT or END_POINT as value.
• Center point handle: allows the user to translate the center of the arc. The user can change the position of the center point by dragging the handle. This handle generates MOVE operations, with a HANDLE_IDENTIFIER property with CENTER as value.
• Object translation handle: allows the user to translate the circle object. This handle generates MOVE operations, without any additional properties.

The following figure illustrates all the handles: the point and center handles are represented by red points, the green fill color indicates the area that can be used to activate the object translation handle (note that the outline is also included in this area).

Editing

Based on the TLspEditOperation, generated by an edit handle (see description of handles above), this editor performs different edit operations on the associated circle object. The images below illustrate the effect of the different handles. In each image the gray color represents the previous state of the object and the red color represents the edited object:

• Circle point handles: the editor adjusts the circle so that it contains all three circle points of the circle-by-3-points. The figure below illustrates this behaviour.
  
  
  
• Center point handle: translates the entire circle
  
  
  
• Object translation handle: the editor translates the entire circle. Note that the behaviour for this handle is identical to the behaviour of the center point handle, with the exception of how the handle is activated
  
  

Creation

The initialization process of a circle-by-3-points object consists of following steps:

1. the first step sets the first intermediate point of the circle-by-3-points
2. the second step sets the second intermediate point of the circle-by-3-points
3. the third step sets the start point of the circle-by-3-points

The figures below illustrate the creation process. Relevant changes that are new in each step are marked in red:

Setting the first intermediate point		Setting the second intermediate point		Setting the start point

Since:

2012.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TLspCircleBy3PointsEditor.HandleIdentifier	Describes a control point of a circle-by-3-points shape.
static enum	TLspCircleBy3PointsEditor.PropertyKeys	Defines keys used by the enclosing editor implementation to store user properties in its edit handles.

Constructor Summary

Constructors

Constructor	Description
TLspCircleBy3PointsEditor()	Creates a new TLspCircleBy3PointsEditor.

Method Summary

Modifier and Type	Method	Description
boolean	canEdit(TLspEditContext aContext)	Returns true if super returns true and the given object is an instance of ILcd2DEditableCircleBy3Points.
protected ALspEditHandle	createCenterHandle(ILcd2DEditableCircleBy3Points aCircle, TLspEditContext aContext)	Creates an edit handle that allows the user to translate the given circle by translating its center point.
protected ALspEditHandle	createFirstIntermediateHandle(ILcd2DEditableCircleBy3Points aCircle, TLspEditContext aContext)	Creates an edit handle that allows the user to edit the given arc by translating its first intermediate point.
protected ALspEditHandle	createObjectTranslationHandle(ILcd2DEditableCircleBy3Points aCircle, TLspEditContext aContext)	Creates an edit handle that allows the user to translate the given shape.
protected ALspEditHandle	createSecondIntermediateHandle(ILcd2DEditableCircleBy3Points aCircle, TLspEditContext aContext)	Creates an edit handle that allows the user to edit the given circle by translating its second intermediate point.
protected ALspEditHandle	createStartPointHandle(ILcd2DEditableCircleBy3Points aCircle, TLspEditContext aContext)	Creates an edit handle that allows the user to edit the given circle by translating its start point.
protected TLspEditOperationResult	editImpl(TLspEditOperation aOperation, ELspInteractionStatus aInteractionStatus, TLspEditContext aContext)	Called by the edit method to edit the given object based on the given edit operation.
ALspEditHandle	getCreateHandle(TLspEditContext aContext)	Returns a handle that is used to create the given object.
List<ALspEditHandle>	getEditHandles(TLspEditContext aContext)	Returns a set of handles for editing the given object.

Methods inherited from class com.luciad.view.lightspeed.editor.ALspEditor

canCopyGeometry, canPerformOperation, copyGeometrySFCT, edit, fireUndoableHappened

Methods inherited from class java.lang.Object

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

Constructor Details

TLspCircleBy3PointsEditor

public TLspCircleBy3PointsEditor()

Creates a new TLspCircleBy3PointsEditor. This constructor does not initialize any state.

Method Details

canEdit

public boolean canEdit(TLspEditContext aContext)

Returns true if super returns true and the given object is an instance of ILcd2DEditableCircleBy3Points.

Specified by:

canEdit in interface ILspEditor

Overrides:

canEdit in class ALspEditor

Parameters:

aContext - provides context information to the editor

Returns:

true if the above conditions are met, false otherwise.

editImpl

protected TLspEditOperationResult editImpl(TLspEditOperation aOperation,
 ELspInteractionStatus aInteractionStatus,
 TLspEditContext aContext)

Called by the edit method to edit the given object based on the given edit operation.

Note that this method does not need to lock the model of the object, this already happens in the edit method.

By default, this editor can handle the following operations:

• TLspEditOperationType.MOVE

If any of the operations contains the HANDLE_IDENTIFIER property, with a HandleIdentifier as value, then this editor will only perform the operation on that particular point, otherwise it will perform it on the entire object.

Specified by:

editImpl in class ALspEditor

Parameters:

aOperation - the event that contains the information on how to edit the object

aInteractionStatus - the interaction status

aContext - the edit context

Returns:

The result of the operation: Whether or not there was success, and whether or not the current handles of the object should be invalidated.

getCreateHandle

public ALspEditHandle getCreateHandle(TLspEditContext aContext)

Returns a handle that is used to create the given object. The returned handle is used by the controller to initialize the other of the object.

Typically the returned handle is an instance of ALspCreateHandle which is a specialized handle implementation used for creating an object.

By default, this method returns an ALspCreateHandle capable of creating an ILcd2DEditableCircleBy3Points, as described in the class javadoc.

Parameters:

aContext - provides context information such as the layer for which the object is being created

Returns:

an edit handle, or null if creation should not be allowed.

See Also:

• ALspCreateHandle
• TLspCreateController

getEditHandles

public List<ALspEditHandle> getEditHandles(TLspEditContext aContext)

Returns a set of handles for editing the given object.

These handles will be able to generate edit operations, that are passed to the edit method. As a way to communicate with this method, handles will copy their properties to the edit operation properties. By default this method delegates to the following methods:

• createFirstIntermediateHandle
• createSecondIntermediateHandle
• createStartPointHandle
• createCenterHandle
• createObjectTranslationHandle

It returns a list containing the handles returned by those methods. These methods are added for convenience, so they can easily be overridden.

Parameters:

aContext - provides context information such as the layer for which the object is being edited

Returns:

the edit handles to edit the given object, or an empty list if it should not be possible to edit the given object.

See Also:

• TLspEditController

createObjectTranslationHandle

protected ALspEditHandle createObjectTranslationHandle(ILcd2DEditableCircleBy3Points aCircle,
 TLspEditContext aContext)

Creates an edit handle that allows the user to translate the given shape. By default this is a TLspObjectTranslationHandle.

Parameters:

aCircle - the shape for which the handle is created

aContext - the current context

Returns:

an edit handle or null if no handle is needed

createCenterHandle

protected ALspEditHandle createCenterHandle(ILcd2DEditableCircleBy3Points aCircle,
 TLspEditContext aContext)

Creates an edit handle that allows the user to translate the given circle by translating its center point. By default this method returns a TLspPointTranslationHandle with a HANDLE_IDENTIFIER user property with CENTER_POINT as value.

Parameters:

aCircle - the circle for which the handle is created

aContext - the current context

Returns:

an edit handle or null if no handle is needed

createStartPointHandle

protected ALspEditHandle createStartPointHandle(ILcd2DEditableCircleBy3Points aCircle,
 TLspEditContext aContext)

Creates an edit handle that allows the user to edit the given circle by translating its start point. By default this method returns a TLspPointTranslationHandle with a HANDLE_IDENTIFIER user property with START_POINT as value.

Parameters:

aCircle - the circle for which the handle is created

aContext - the current context

Returns:

an edit handle or null if no handle is needed

createSecondIntermediateHandle

protected ALspEditHandle createSecondIntermediateHandle(ILcd2DEditableCircleBy3Points aCircle,
 TLspEditContext aContext)

Creates an edit handle that allows the user to edit the given circle by translating its second intermediate point. By default this method returns a TLspPointTranslationHandle with a HANDLE_IDENTIFIER user property with END_POINT as value.

Parameters:

aCircle - the circle for which the handle is created

aContext - the current context

Returns:

an edit handle or null if no handle is needed

createFirstIntermediateHandle

protected ALspEditHandle createFirstIntermediateHandle(ILcd2DEditableCircleBy3Points aCircle,
 TLspEditContext aContext)

Creates an edit handle that allows the user to edit the given arc by translating its first intermediate point. By default this method returns a TLspPointTranslationHandle with a HANDLE_IDENTIFIER user property with INTERMEDIATE_POINT as value.

Parameters:

aCircle - the circle for which the handle is created

aContext - the current context

Returns:

an edit handle or null if no handle is needed