com.luciad.edit.geometries

Class PolylineHandlesProvider

java.lang.Object

com.luciad.edit.geometries.PolylineHandlesProvider

All Implemented Interfaces:

IGeometryHandlesProvider, AutoCloseable

public final class PolylineHandlesProvider
extends Object
implements AutoCloseable, IGeometryHandlesProvider

This provider can create handles to edit Polyline geometries.

It offer the following handles:

• move point handles
• insert point handles
• a prepend point handle
• an append point handle
• remove point handles
• elevation point handles. Note that the default implementation of PointHandlesProvider.IHandleFactory automatically omits these handles on a 2D map, or on a 3D map for polylines without elevation.

Note: the handle to translate the entire feature is typically created by the IFeatureHandlesProvider. FeatureHandlesProvider does this by default.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PolylineHandlesProvider.IHandleFactory Allows you to specify which handles are used by this handles provider.

Constructor Summary

Constructors

Constructor and Description
PolylineHandlesProvider() Creates a new handles provider that can create handles to modify Polyline geometries.

Method Summary

Modifier and Type	Method and Description
boolean	canProvide(Observable<Geometry> geometry, FeatureEditContext context) Indicates if this handles provider can create handles for the given geometry.
void	close()
protected void	finalize()
IPolylineConstraint	getConstraint()
PolylineHandlesProvider.IHandleFactory	getHandleFactory()
long	getMaxPointCount()
long	getMinPointCount()
IEditHandles	provide(Observable<Geometry> geometry, FeatureEditContext context, IGeometryEditCallback geometryEditCallback) Returns the handles for the given feature.
ITranslateEditAction	provideTranslateAction(Observable<Geometry> geometry, FeatureEditContext context, IGeometryEditCallback geometryEditCallback) Provides a translate action that can be used by the caller to add translation behavior.
void	setConstraint(IPolylineConstraint constraint) Sets the constraint that is applied to the handles created by this handles provider.
void	setHandleFactory(PolylineHandlesProvider.IHandleFactory handleFactory) Sets the IHandleFactory that is used by this handles provider to create new handles.
void	setMaxPointCount(long maxPointCount) Sets the maximum number of points a polyline can have.
void	setMinPointCount(long minPointCount) Sets the minimum number of points a polyline can have.

Methods inherited from class java.lang.Object

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

Constructor Detail

PolylineHandlesProvider

public PolylineHandlesProvider()

Creates a new handles provider that can create handles to modify Polyline geometries.

Method Detail

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

canProvide

public boolean canProvide(@NotNull
                          Observable<Geometry> geometry,
                          @NotNull
                          FeatureEditContext context)

Indicates if this handles provider can create handles for the given geometry.

Specified by:

canProvide in interface IGeometryHandlesProvider

Parameters:

geometry - an observable geometry, cannot be null

context - the context. Contains additional information about the edited feature, cannot be null.

Returns:

if this handles provider can provide handles and a translate action for the given Feature

provide

@NotNull
public IEditHandles provide(@NotNull
                                     Observable<Geometry> geometry,
                                     @NotNull
                                     FeatureEditContext context,
                                     @NotNull
                                     IGeometryEditCallback geometryEditCallback)

Returns the handles for the given feature.

Note: translation of features is handled by IFeatureHandlesProvider. So geometry handles providers should not provide handles to translate a geometry.

Specified by:

provide in interface IGeometryHandlesProvider

Parameters:

geometry - the observable geometry for which to provide handles, cannot be null.

context - the context. Contains additional information about the edited feature, cannot be null.

geometryEditCallback - a callback that notifies the caller when the Feature has changed, cannot be null.

Returns:

handles for the given feature. Never null.

provideTranslateAction

@NotNull
public ITranslateEditAction provideTranslateAction(@NotNull
                                                            Observable<Geometry> geometry,
                                                            @NotNull
                                                            FeatureEditContext context,
                                                            @NotNull
                                                            IGeometryEditCallback geometryEditCallback)

Provides a translate action that can be used by the caller to add translation behavior.

A translation handle is typically added by an IFeatureHandlesProvider, like for example the FeatureHandlesProvider implementation. It calls this method to retrieve a translate action, and uses it to create a TranslateEditHandle.

When ITranslateEditAction#translate is called, the returned implementation must:

• apply a translation on the geometry
• apply this IGeometryHandlesProvider's constraint (if configured) on the translated geometry
• call IGeometryEditCallback with the resulting geometry

Specified by:

provideTranslateAction in interface IGeometryHandlesProvider

Parameters:

geometry - the observable geometry for which to provide a translate action, cannot be null

context - the context, cannot be null

geometryEditCallback - a callback that notifies the caller of this method when a translation has occurred, cannot be null

Returns:

a translate action. Never null.

getHandleFactory

@NotNull
public PolylineHandlesProvider.IHandleFactory getHandleFactory()

Returns:

the handle factory used by the handles provider

setHandleFactory

public void setHandleFactory(@NotNull
                             PolylineHandlesProvider.IHandleFactory handleFactory)
                      throws NullPointerException

Sets the IHandleFactory that is used by this handles provider to create new handles.

If this method is not called, a default handle factory is used. You can change the behavior of this default handle factory by:

• retrieving it
• wrapping it with your own IHandleFactory implementation, by delegating to the default factory
• omitting/replacing one or more handles that are returned

Parameters:

handleFactory - a handle factory

Throws:

NullPointerException - when null is passed.

setMinPointCount

public void setMinPointCount(long minPointCount)
                      throws IllegalArgumentException

Sets the minimum number of points a polyline can have.

If a polyline's point count is lower than or equal to this value, this handles provider will not provide handles to remove points from that polyline. By default, this value is 2.

Parameters:

minPointCount - the minimum number of points allowed.

Throws:

IllegalArgumentException - if minPointCount is lower than 2, or higher than the current maximum point count.

getMinPointCount

public long getMinPointCount()

Returns:

the minimum number of points a polyline can have.

See Also:

setMinPointCount

setMaxPointCount

public void setMaxPointCount(long maxPointCount)
                      throws IllegalArgumentException

Sets the maximum number of points a polyline can have.

If a polyline's point count is higher than or equal to this value, this handles provider will not provide handles to insert, prepend or append new points for that polyline. By default, this value is the maximum value of long, which realistically corresponds to "no maximum".

Parameters:

maxPointCount - the maximum number of points allowed.

Throws:

IllegalArgumentException - if maxPointCount is lower than the current min point count.

getMaxPointCount

public long getMaxPointCount()

Returns:

the maximum number of points a polyline can have.

See Also:

setMaxPointCount

setConstraint

public void setConstraint(@Nullable
                          IPolylineConstraint constraint)

Sets the constraint that is applied to the handles created by this handles provider.

They always call this constraint with a PolylineChange, describing a single change. More specifically:

• Move point handles and elevation point handles provide a PolylineChange containing one moved point index.
• Insert point handles and the prepend or append point handle provide a PolylineChange containing one inserted point index.
• Remove point handles provide a PolylineChange containing one removed point index.

Parameters:

constraint - the constraint that is applied to the handles' edit actions, or null if no constraint should be applied.

getConstraint

@Nullable
public IPolylineConstraint getConstraint()

Returns:

constraint the constraint that is applied to the handles' edit actions, or null if no constraint is set.