Package com.luciad.view.lightspeed.editor

Class TLspArcByBulgeEditor

java.lang.Object

com.luciad.view.lightspeed.editor.ALspEditor

com.luciad.view.lightspeed.editor.TLspArcByBulgeEditor

All Implemented Interfaces:

ILspEditor

public class TLspArcByBulgeEditor
extends ALspEditor

Enables visual editing of ILcd2DEditableCircularArcByBulge objects in an ILspView.

Handles

The arc-by-bulge editor defines the following edit handles for an arc object:

• Start and endpoint handles: allows the user to edit the start and end point of the arc. The user can change the position of these points by dragging the handle. These handles generate MOVE operations, with a HANDLE_IDENTIFIER property and START_POINT or END_POINT as value.
• Bulge point handle: allows the user to change the bulge factor of the arc-by-bulge. The user can change the position of the bulge factor by dragging the handle. This handle generates MOVE operations, with a HANDLE_IDENTIFIER property and BULGE_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 arc object. This handle generates MOVE operations, without any additional properties.

The following image clarifies the handle locations: the point and center handles are represented by red dots, the green outline indicates the object itself which can be used to activate the object translation handle.

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 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:

• Start or end point handle:
  
  
  NOTE: the end point handle is not illustrated in these images, but its functionality is similar to the start point handle.
• Bulge point handle:
  
  
  
• Center point handle:
  
  
  
• Object translation handle: the editor translates the entire arc. 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 creation process of an arc-by-bulge object consists of the following steps:

1. the first step sets the start point of the arc-by-bulge
2. the second step sets the end point of the arc-by-bulge
3. the third step initializes the bulge factor of the arc-by-bulge

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

Setting the start point		Setting the end point		Initializing the bulge factor

Since:

2012.0

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
TLspArcByBulgeEditor()	Creates a new TLspArcByBulgeEditor.

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 ILcd2DEditableCircularArcByBulge.
protected ALspEditHandle	createBulgeHandle(ILcd2DEditableCircularArcByBulge aArc, TLspEditContext aContext)	Creates an edit handle that allows the user to edit the given arc by translating its bulge point.
protected ALspEditHandle	createCenterHandle(ILcd2DEditableCircularArcByBulge aArc, TLspEditContext aContext)	Creates an edit handle that allows the user to translate the given arc by dragging its center point.
protected ALspEditHandle	createEndHandle(ILcd2DEditableCircularArcByBulge aArc, TLspEditContext aContext)	Creates an edit handle that allows the user to edit the given arc by translating its end point.
protected ALspEditHandle	createObjectTranslationHandle(ILcd2DEditableCircularArcByBulge aArc, TLspEditContext aContext)	Creates an edit handle that allows the user to translate the given shape.
protected ALspEditHandle	createStartHandle(ILcd2DEditableCircularArcByBulge aArc, TLspEditContext aContext)	Creates an edit handle that allows the user to edit the given arc 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

TLspArcByBulgeEditor

public TLspArcByBulgeEditor()

Creates a new TLspArcByBulgeEditor. 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 ILcd2DEditableCircularArcByBulge.

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:

• createStartHandle
• createEndHandle
• createBulgeHandle
• 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(ILcd2DEditableCircularArcByBulge aArc,
 TLspEditContext aContext)

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

Parameters:

aArc - 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(ILcd2DEditableCircularArcByBulge aArc,
 TLspEditContext aContext)

Creates an edit handle that allows the user to translate the given arc by dragging its center point.

Parameters:

aArc - the arc for which the handle is created

aContext - the current context

Returns:

an edit handle or null when no handle is needed

createBulgeHandle

protected ALspEditHandle createBulgeHandle(ILcd2DEditableCircularArcByBulge aArc,
 TLspEditContext aContext)

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

Parameters:

aArc - the arc for which the handle is created

aContext - the current context

Returns:

an edit handle or null when no handle is needed

createEndHandle

protected ALspEditHandle createEndHandle(ILcd2DEditableCircularArcByBulge aArc,
 TLspEditContext aContext)

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

Parameters:

aArc - the arc for which the handle is created

aContext - the current context

Returns:

an edit handle or null when no handle is needed

createStartHandle

protected ALspEditHandle createStartHandle(ILcd2DEditableCircularArcByBulge aArc,
 TLspEditContext aContext)

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

Parameters:

aArc - 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 ILcd2DEditableCircularArcByBulge, 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

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.