Package com.luciad.view.lightspeed.editor

Class TLspArcBandEditor

java.lang.Object

com.luciad.view.lightspeed.editor.ALspEditor

com.luciad.view.lightspeed.editor.TLspArcBandEditor

All Implemented Interfaces:

ILspEditor

public class TLspArcBandEditor
extends ALspEditor

Enables visual editing of ILcd2DEditableArcBand objects in an ILspView.

Handles

The arc band editor defines the following edit handles for an arc band object:

• Min radius start corner handle: allows the user to edit the min radius start corner of the arc band. This handle generates MOVE operations, with a HANDLE_IDENTIFIER user property with MIN_RADIUS_START_CORNER as value.
• Max radius start corner handle: allows the user to edit the max radius start corner of the arc band. This handle generates MOVE operations, with a HANDLE_IDENTIFIER user property with MAX_RADIUS_START_CORNER as value.
• Min radius end corner handle: allows the user to edit the min radius end corner of the arc band. This handle generates MOVE operations, with a HANDLE_IDENTIFIER user property with MIN_RADIUS_END_CORNER as value.
• Max radius end corner handle: allows the user to edit the max radius end corner of the arc band. This handle generates MOVE operations, with a HANDLE_IDENTIFIER user property with MAX_RADIUS_END_CORNER as value.
• Max radius handle: allows the user to edit the max radius of the arc band. This handle generates PROPERTY_CHANGE operations, with ""maxRadius"" as property name, and a Double as value.
• Min radius handle: allows the user to edit the min radius of the arc band. This handle generates PROPERTY_CHANGE operations, with ""minRadius"" as property name, and a Double as value.
• Center point handle: allows the user to translate the center of the arcband. 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_POINT as value.
• Object translation handle: allows the user to translate the object. This handle generates MOVE operations.

The following image clarifies the handle locations: the corner point handles and center handle are represented by red points, the green fill color indicates the area that can be used to activate the object 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 arc band 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:

• Corner point handle: the editor adjusts the corresponding point of the arc band. The figure below illustrates this behaviour if the max point of the starting axis is moved (the movement is depicted by the the black arrow).
  
  
  
  
• Min/max radius handle: the editor adjusts the corresponding radius of the arc band. The figure below illustrates the behaviour if the max radius is modified.
  
  
  
  
• Center point handle: the editor translates the entire arc band. The figure below illustrates this behaviour.
  
  
  
  
• Object translation handle: the editor translates the entire arc band. 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 (see the Handles section above).

Creation

The initialization process of an arc band consists of three distinct steps:

1. The first step sets the center of the arc band
2. The second step initializes the minimum radius and the start angle of the arc band
3. The third step initializes the maximum radius and the arc angle

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

Setting the center point		Initializing minimum radius and start angle		Initializing maximum radius and arc angle

Since:

2012.0

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
TLspArcBandEditor()	Creates a new TLspArcBandEditor.

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 ILcd2DEditableArcBand.
protected ALspEditHandle	createCenterHandle(ILcd2DEditableArcBand aArcBand, TLspEditContext aContext)	Creates an edit handle that allows the user to translate the given arc by translating its center point.
protected ALspEditHandle	createMaxRadiusEndCornerHandle(ILcd2DEditableArcBand aArcBand, TLspEditContext aContext)	Creates an edit handle that allows the user to edit the arc band by translating its MAX_RADIUS_END_CORNER point.
protected ALspEditHandle	createMaxRadiusHandle(ILcd2DEditableArcBand aArcBand, TLspEditContext aContext)	Creates an edit handle that allow the user to edit the max radius property of the arc band.
protected ALspEditHandle	createMaxRadiusStartCornerHandle(ILcd2DEditableArcBand aArcBand, TLspEditContext aContext)	Creates an edit handle that allows the user to edit the arc band by translating its MAX_RADIUS_START_CORNER point.
protected ALspEditHandle	createMinRadiusEndCornerHandle(ILcd2DEditableArcBand aArcBand, TLspEditContext aContext)	Creates an edit handle that allows the user to edit the arc band by translating its MIN_RADIUS_END_CORNER point.
protected ALspEditHandle	createMinRadiusHandle(ILcd2DEditableArcBand aArcBand, TLspEditContext aContext)	Creates an edit handle that allow the user to edit the min radius property of the arc band.
protected ALspEditHandle	createMinRadiusStartCornerHandle(ILcd2DEditableArcBand aArcBand, TLspEditContext aContext)	Creates an edit handle that allows the user to edit the arc band by translating its MIN_RADIUS_START_CORNER point.
protected ALspEditHandle	createObjectTranslationHandle(ILcd2DEditableArcBand aArcBand, TLspEditContext aContext)	Creates an edit handle that allows the user to translate the given shape.
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

TLspArcBandEditor

public TLspArcBandEditor()

Creates a new TLspArcBandEditor. 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 ILcd2DEditableArcBand.

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.

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:

• createMinRadiusStartCornerHandle
• createMaxRadiusStartCornerHandle
• createMinRadiusEndCornerHandle
• createMaxRadiusEndCornerHandle
• createCenterHandle
• createMaxRadiusHandle
• createMinRadiusHandle
• 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(ILcd2DEditableArcBand aArcBand,
 TLspEditContext aContext)

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

Parameters:

aArcBand - 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(ILcd2DEditableArcBand aArcBand,
 TLspEditContext aContext)

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

Parameters:

aArcBand - the arc for which the handle is created

aContext - the current context

Returns:

an edit handle or null when no handle is needed

createMinRadiusStartCornerHandle

protected ALspEditHandle createMinRadiusStartCornerHandle(ILcd2DEditableArcBand aArcBand,
 TLspEditContext aContext)

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

Parameters:

aArcBand - the arc for which the handle is created

aContext - the current context

Returns:

an edit handle or null when no handle is needed

createMaxRadiusStartCornerHandle

protected ALspEditHandle createMaxRadiusStartCornerHandle(ILcd2DEditableArcBand aArcBand,
 TLspEditContext aContext)

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

Parameters:

aArcBand - the arc for which the handle is created

aContext - the current context

Returns:

an edit handle or null when no handle is needed

createMinRadiusEndCornerHandle

protected ALspEditHandle createMinRadiusEndCornerHandle(ILcd2DEditableArcBand aArcBand,
 TLspEditContext aContext)

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

Parameters:

aArcBand - the arc for which the handle is created

aContext - the current context

Returns:

an edit handle or null when no handle is needed

createMaxRadiusEndCornerHandle

protected ALspEditHandle createMaxRadiusEndCornerHandle(ILcd2DEditableArcBand aArcBand,
 TLspEditContext aContext)

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

Parameters:

aArcBand - the arc for which the handle is created

aContext - the current context

Returns:

an edit handle or null when no handle is needed

createMaxRadiusHandle

protected ALspEditHandle createMaxRadiusHandle(ILcd2DEditableArcBand aArcBand,
 TLspEditContext aContext)

Creates an edit handle that allow the user to edit the max radius property of the arc band. By default, this method returns an ALspOutlineResizeHandle that represents the outer arc of the arcband.

Parameters:

aArcBand - the arc for which the handle is created

aContext - the current context

Returns:

an edit handle or null when no handle is needed

createMinRadiusHandle

protected ALspEditHandle createMinRadiusHandle(ILcd2DEditableArcBand aArcBand,
 TLspEditContext aContext)

Creates an edit handle that allow the user to edit the min radius property of the arc band. By default, this method returns an ALspOutlineResizeHandle that represents the inner arc of the arcband.

Parameters:

aArcBand - the arc for which the handle is created

aContext - the current context

Returns:

an edit handle or null when no handle is needed

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 ILcd2DEditableArcBand, 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

editImpl

public 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
• TLspEditOperationType.PROPERTY_CHANGE

If any of the move operations contains the HANDLE_IDENTIFIER property, then this editor will only perform the operation on the respective corner point, otherwise it will perform it on the entire arc.

If the operation type is PROPERTY_CHANGE, and the name of the changed property is ""maxRadius"", the max radius of the arcband is modified. If the name is ""minRadius"", the min radius of the arcband is modified.

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.