luciad::PointCreator Class Reference

This class can create point instances. More...

#include <luciad/create/geometries/PointCreator.h>

Inheritance diagram for luciad::PointCreator:

Public Member Functions
	PointCreator (std::shared_ptr< CoordinateReference > reference)
	Creates a new PointCreator. More...
	~PointCreator () override
std::shared_ptr< IPointConstraint >	getConstraint () const
	Returns the constraint that is used during creation. More...
EventResult	onEvent (const std::shared_ptr< IInputEvent > &inputEvent, const std::shared_ptr< FeatureCreateContext > &context) override
	Handles the given event, and returns if the event was handled or not. More...
void	setConstraint (std::shared_ptr< IPointConstraint > constraint)
	Sets the constraint that is used during creation. More...
void	start (std::shared_ptr< IGeometryCreateCallback > callback, const std::shared_ptr< FeatureCreateContext > &context) override
	This method is called to start creation. More...
Public Member Functions inherited from luciad::IGeometryCreator
virtual	~IGeometryCreator ()=default
virtual EventResult	onEvent (const std::shared_ptr< IInputEvent > &inputEvent, const std::shared_ptr< FeatureCreateContext > &context)=0
	Handles the given event, and returns if the event was handled or not. More...
virtual void	start (std::shared_ptr< IGeometryCreateCallback > callback, const std::shared_ptr< FeatureCreateContext > &context)=0
	This method is called to start creation. More...

Detailed Description

This class can create point instances.

It reacts to:

• mouse move events to position the point
• a mouse click to finish creation of the point.
• a touch tap to immediately create a point.

This class does not allow you to interactively choose the elevation of the point. The elevation will by default be set to 0.

Since

2020.1

Constructor & Destructor Documentation

PointCreator()

luciad::PointCreator::PointCreator ( std::shared_ptr< CoordinateReference >  reference )

explicit

Creates a new PointCreator.

Parameters

reference

the reference of the created point

~PointCreator()

luciad::PointCreator::~PointCreator ( )

override

Member Function Documentation

getConstraint()

std::shared_ptr< IPointConstraint > luciad::PointCreator::getConstraint

(

)

const

Returns the constraint that is used during creation.

Can be nullptr.

Returns

the constraint that is used during creation.

See also

setConstraint

onEvent()

EventResult luciad::PointCreator::onEvent ( const std::shared_ptr< IInputEvent > &  inputEvent, const std::shared_ptr< FeatureCreateContext > &  context  )

overridevirtual

Handles the given event, and returns if the event was handled or not.

Parameters

context	the context, cannot be nullptr
inputEvent	an event, cannot be nullptr

Returns

if the event was consumed or not

Exceptions

NullArgumentException

when nullptr is passed.

Implements luciad::IGeometryCreator.

setConstraint()

void luciad::PointCreator::setConstraint

(

std::shared_ptr< IPointConstraint >

constraint

)

Sets the constraint that is used during creation.

The default is no constraint.

Parameters

constraint

the constraint. Can be nullptr.

start()

void luciad::PointCreator::start ( std::shared_ptr< IGeometryCreateCallback >  callback, const std::shared_ptr< FeatureCreateContext > &  context  )

overridevirtual

This method is called to start creation.

After this call, IGeometryCreator::onEvent can be called.

When an IGeometryCreator has already started, it cannot be started again until it has finished. Before that time, it is recommended that implementations of this method throw an exception to signal a programming error by the caller of this method.

Parameters

context	the context, cannot be nullptr
callback	the callback to signal geometry changes, and whether creation for the geometry has finished, cannot be nullptr.

Exceptions

NullArgumentException

when nullptr is passed.

Implements luciad::IGeometryCreator.