Package com.luciad.view.lightspeed.editor

Class TLspLonLatHeightBufferEditor

java.lang.Object

com.luciad.view.lightspeed.editor.ALspEditor

com.luciad.view.lightspeed.editor.TLsp3DPointListEditor

com.luciad.view.lightspeed.editor.TLspLonLatHeightBufferEditor

All Implemented Interfaces:

ILspEditor

public class TLspLonLatHeightBufferEditor
extends TLsp3DPointListEditor

Enables visual editing of TLcdLonLatHeightBuffer objects in an ILspView.

Note that the discussion of the editing behaviour below focuses on how a LLH buffer is edited in a 3D view. In a 2D view, editing a LLH buffer works essentially the same as when using a TLspGeoBufferEditor with the exception of how the buffer width is changed. For the LLH buffer editor, in 2D the width is changed by using the buffer resize handles (instead of the buffer's outline). Note that when doing this, the height of the LLH buffer is also changed in such a way that the width/height ratio stays constant.

Note also that the TLspLLHBufferEditor is an extension of the TLsp3DPointListEditor and that it uses all of the handles generated by the parent class. Therefore, these handles are left out in the discussion above and the reader is referred to the class documentation of

Handles

The LLH buffer editor defines the following edit handles for a LLH buffer object in addition to the 3D point list handles:

• Buffer resize handle: allows the user to change the width and height of a LLH buffer object. This handle is drawn on the front face of the LLH buffer. This handle generates MOVE operations, with a HANDLE_IDENTIFIER property, with RESIZE as value.

The following figure illustrates all the handles for LLH buffer objects: the red dots represent the 3D point handles (from the TLsp3DPointListEditor), the blue dots represent the buffer resize handles and the green buffer shape (drawn on the terrain) represents the object translation handle (in the case of a 3D view):

Editing

Based on the TLspEditOperation, generated by an edit handle (see description of handles above), this editor performs different edit operations on the associated LLH buffer 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:

• 3D point handle
  
  NOTE: only part of the new state (red) is drawn to avoid cluttering the image.
  
• Buffer resize handle: Allows to edit the width of the buffer by dragging its outline.
  
  
  NOTE: only part of the new state (red) is drawn to avoid cluttering the image.
  
• Object translation handle: This handle translates the entire LLH buffer object.
  
  
  

Creation

The creation process of a LLH buffer object consists of a series of two distinct steps:

1. the first step initializes the XY location of the next axis point
2. the second step initializes the height of that point

This process continues until the user performs a finishing event (such as a double-click when using the mouse), which results in creation being finalized. The buffer's height and width are automatically set, based on the length of the first segment of the buffer axis.

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

Setting the XY location of the buffer's first axis point		Setting the height of the buffer's first axis point		Setting the XY location of the buffer's second axis point		Setting the height of the buffer's second axis point

Since:

2012.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TLspLonLatHeightBufferEditor.HandleIdentifier	Describes the type of an edit handle created by the enclosing editor implementation.
static enum	TLspLonLatHeightBufferEditor.PropertyKeys	Defines keys used by the enclosing editor implementation to store properties in its edit handles.
static enum	TLspLonLatHeightBufferEditor.ResizeHandleLocation	Enumeration listing possible locations for the buffer's resize handles.

Constructor Summary

Constructors

Constructor	Description
TLspLonLatHeightBufferEditor()	Creates a new TLspLonLatHeightBufferEditor.

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 TLcdLonLatHeightBuffer.
protected ALspEditHandle	createBufferResizeHandle(TLcdLonLatHeightBuffer aBuffer, TLspEditContext aContext, TLspLonLatHeightBufferEditor.ResizeHandleLocation aHandleLocation)	Creates an edit handle on the given location that allows the user to resize the given buffer's width and height.
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.TLsp3DPointListEditor

createInsertPointHandle, createObjectTranslationHandle, createPointHeightTranslationHandle, createPointPositionHandle, createRemovePointHandle

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

TLspLonLatHeightBufferEditor

public TLspLonLatHeightBufferEditor()

Creates a new TLspLonLatHeightBufferEditor. 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 TLcdLonLatHeightBuffer.

Specified by:

canEdit in interface ILspEditor

Overrides:

canEdit in class TLsp3DPointListEditor

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
• TLspEditOperationType.INSERT_POINT
• TLspEditOperationType.REMOVE_POINT

If any of the operations contains the POINT_INDEX property, with an integer value, then this editor will only perform the operation on that particular point, otherwise it will perform it on the entire point list.

If any of the operations contains the HANDLE_IDENTIFIER property, with a HandleIdentifier as value, and this identifier is RESIZE, then the buffer with and height are modified.

Overrides:

editImpl in class TLsp3DPointListEditor

Parameters:

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

aInteractionStatus -

aContext - the edit context

Returns:

SUCCESS if the above conditions are met, FAILED otherwise. The invalidation hint will be set if a point was added or removed.

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:

• createPointHeightTranslationHandle
• createPointPositionHandle
• createObjectTranslationHandle

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

Note that for the point handles, it delegates multiple times to those methods with different indices. By default this method returns a list that is twice the size, plus one, of the size of the pointlist. Additionally This method creates returns resize handles on all four corners of the front face of the buffer.

Specified by:

getEditHandles in interface ILspEditor

Overrides:

getEditHandles in class TLsp3DPointListEditor

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

createBufferResizeHandle

protected ALspEditHandle createBufferResizeHandle(TLcdLonLatHeightBuffer aBuffer,
 TLspEditContext aContext,
 TLspLonLatHeightBufferEditor.ResizeHandleLocation aHandleLocation)

Creates an edit handle on the given location that allows the user to resize the given buffer's width and height.

Parameters:

aBuffer - the buffer for which the handle is created

aContext - the current context

aHandleLocation - the handle location

Returns:

an edit handle or null if no handle is needed

getCreateHandle

public ALspEditHandle getCreateHandle(TLspEditContext aContext)

Description copied from class: TLsp3DPointListEditor

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 ILcd3DEditablePointList, as described in the class javadoc.

Specified by:

getCreateHandle in interface ILspEditor

Overrides:

getCreateHandle in class TLsp3DPointListEditor

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