luciad::PolylineHandlesProvider Class Reference

This provider can create handles to edit Polyline geometries. More...

#include <luciad/edit/geometries/PolylineHandlesProvider.h>

Inheritance diagram for luciad::PolylineHandlesProvider:

Classes
class	IHandleFactory
	Allows you to specify which handles are used by this handles provider. More...

Public Member Functions
	PolylineHandlesProvider ()
	Creates a new handles provider that can create handles to modify Polyline geometries. More...
	~PolylineHandlesProvider () override
bool	canProvide (const std::shared_ptr< Observable< std::shared_ptr< Geometry > > > &geometry, const std::shared_ptr< FeatureEditContext > &context) const override
	Indicates if this handles provider can create handles for the given geometry. More...
std::shared_ptr< IPolylineConstraint >	getConstraint () const
std::shared_ptr< IHandleFactory >	getHandleFactory () const
size_t	getMaxPointCount () const
size_t	getMinPointCount () const
std::shared_ptr< IEditHandles >	provide (std::shared_ptr< Observable< std::shared_ptr< Geometry > > > geometry, const std::shared_ptr< FeatureEditContext > &context, std::shared_ptr< IGeometryEditCallback > geometryEditCallback) const override
	Returns the handles for the given feature. More...
std::shared_ptr< ITranslateEditAction >	provideTranslateAction (std::shared_ptr< Observable< std::shared_ptr< Geometry > > > geometry, const std::shared_ptr< FeatureEditContext > &context, std::shared_ptr< IGeometryEditCallback > geometryEditCallback) const override
	Provides a translate action that can be used by the caller to add translation behavior. More...
void	setConstraint (std::shared_ptr< IPolylineConstraint > constraint)
	Sets the constraint that is applied to the handles created by this handles provider. More...
void	setHandleFactory (std::shared_ptr< IHandleFactory > handleFactory)
	Sets the IHandleFactory that is used by this handles provider to create new handles. More...
void	setMaxPointCount (size_t maxPointCount)
	Sets the maximum number of points a polyline can have. More...
void	setMinPointCount (size_t minPointCount)
	Sets the minimum number of points a polyline can have. More...
Public Member Functions inherited from luciad::IGeometryHandlesProvider
virtual	~IGeometryHandlesProvider ()=default
virtual bool	canProvide (const std::shared_ptr< Observable< std::shared_ptr< Geometry > > > &geometry, const std::shared_ptr< FeatureEditContext > &context) const =0
	Indicates if this handles provider can create handles for the given geometry. More...
virtual std::shared_ptr< IEditHandles >	provide (std::shared_ptr< Observable< std::shared_ptr< Geometry > > > geometry, const std::shared_ptr< FeatureEditContext > &context, std::shared_ptr< IGeometryEditCallback > geometryEditCallback) const =0
	Returns the handles for the given feature. More...
virtual std::shared_ptr< ITranslateEditAction >	provideTranslateAction (std::shared_ptr< Observable< std::shared_ptr< Geometry > > > geometry, const std::shared_ptr< FeatureEditContext > &context, std::shared_ptr< IGeometryEditCallback > geometryEditCallback) const =0
	Provides a translate action that can be used by the caller to add translation behavior. More...

Detailed Description

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.

Since

2020.1

Constructor & Destructor Documentation

PolylineHandlesProvider()

luciad::PolylineHandlesProvider::PolylineHandlesProvider

(

)

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

~PolylineHandlesProvider()

luciad::PolylineHandlesProvider::~PolylineHandlesProvider ( )

override

Member Function Documentation

canProvide()

bool luciad::PolylineHandlesProvider::canProvide ( const std::shared_ptr< Observable< std::shared_ptr< Geometry > > > &  geometry, const std::shared_ptr< FeatureEditContext > &  context  ) const

overridevirtual

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

Parameters

geometry	an observable geometry, cannot be nullptr
context	the context. Contains additional information about the edited feature, cannot be nullptr.

Returns

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

Implements luciad::IGeometryHandlesProvider.

getConstraint()

std::shared_ptr< IPolylineConstraint > luciad::PolylineHandlesProvider::getConstraint

(

)

const

Returns

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

getHandleFactory()

std::shared_ptr< IHandleFactory > luciad::PolylineHandlesProvider::getHandleFactory

(

)

const

Returns

the handle factory used by the handles provider

getMaxPointCount()

size_t luciad::PolylineHandlesProvider::getMaxPointCount

(

)

const

Returns

the maximum number of points a polyline can have.

See also

setMaxPointCount

getMinPointCount()

size_t luciad::PolylineHandlesProvider::getMinPointCount

(

)

const

Returns

the minimum number of points a polyline can have.

See also

setMinPointCount

provide()

std::shared_ptr< IEditHandles > luciad::PolylineHandlesProvider::provide ( std::shared_ptr< Observable< std::shared_ptr< Geometry > > >  geometry, const std::shared_ptr< FeatureEditContext > &  context, std::shared_ptr< IGeometryEditCallback >  geometryEditCallback  ) const

overridevirtual

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.

Parameters

geometry	the observable geometry for which to provide handles, cannot be nullptr.
context	the context. Contains additional information about the edited feature, cannot be nullptr.
geometryEditCallback	a callback that notifies the caller when the Feature has changed, cannot be nullptr.

Returns

handles for the given feature. Never nullptr.

Implements luciad::IGeometryHandlesProvider.

provideTranslateAction()

std::shared_ptr< ITranslateEditAction > luciad::PolylineHandlesProvider::provideTranslateAction ( std::shared_ptr< Observable< std::shared_ptr< Geometry > > >  geometry, const std::shared_ptr< FeatureEditContext > &  context, std::shared_ptr< IGeometryEditCallback >  geometryEditCallback  ) const

overridevirtual

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

Parameters

geometry	the observable geometry for which to provide a translate action, cannot be nullptr
context	the context, cannot be nullptr
geometryEditCallback	a callback that notifies the caller of this method when a translation has occurred, cannot be nullptr

Returns

a translate action. Never nullptr.

Implements luciad::IGeometryHandlesProvider.

setConstraint()

void luciad::PolylineHandlesProvider::setConstraint

(

std::shared_ptr< 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 nullptr if no constraint should be applied.

setHandleFactory()

void luciad::PolylineHandlesProvider::setHandleFactory

(

std::shared_ptr< IHandleFactory >

handleFactory

)

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

Exceptions

NullArgumentException

when nullptr is passed.

setMaxPointCount()

void luciad::PolylineHandlesProvider::setMaxPointCount

(

size_t

maxPointCount

)

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 size_t, which realistically corresponds to "no maximum".

Parameters

maxPointCount

the maximum number of points allowed.

Exceptions

InvalidArgumentException

if maxPointCount is lower than the current min point count.

setMinPointCount()

void luciad::PolylineHandlesProvider::setMinPointCount

(

size_t

minPointCount

)

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.

Exceptions

InvalidArgumentException

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