A feature creator can create feature instances, based on input events. More...

#include <luciad/create/features/IFeatureCreator.h>

Inheritance diagram for luciad::IFeatureCreator:

Public Member Functions
virtual	~IFeatureCreator ()=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< IFeatureCreateCallback > callback, const std::shared_ptr< FeatureCreateContext > &context)=0
	This method is called to start creation. More...

Detailed Description

A feature creator can create feature instances, based on input events.

It uses a callback to signal changes to the feature or to signal that the creation has finished.

Users of this class need to

explicitly start creation
send events to the creator
listen to feature changes
stop sending events when creation has finished

IFeatureCreator instances can be used multiple times. Creating a new instance should only start after the last one has finished.

Since: 2020.1

Constructor & Destructor Documentation

◆ ~IFeatureCreator()

virtual luciad::IFeatureCreator::~IFeatureCreator ( )

virtualdefault

Member Function Documentation

◆ onEvent()

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

pure virtual

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

Parameters

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

Returns: if the event was consumed or not

Exceptions

NullArgumentException when nullptr is passed.

Implemented in luciad::FeatureCreator, and luciad::MilitarySymbolFeatureCreator.

◆ start()

virtual void luciad::IFeatureCreator::start	(	std::shared_ptr< IFeatureCreateCallback >	callback,
		const std::shared_ptr< FeatureCreateContext > &	context
	)