geometrize::dialog::ImageTaskScriptingWidget Class Reference

The ImageTaskScriptingWidget implements a widget for manipulating scripts that are run when an image is being geometrized e.g. before/after a shape is added. More...

#include <imagetaskscriptingwidget.h>

Inheritance diagram for geometrize::dialog::ImageTaskScriptingWidget:

Collaboration diagram for geometrize::dialog::ImageTaskScriptingWidget:

Classes
class	ImageTaskScriptingWidgetImpl

Signals
void	signal_scriptChanged (const std::string &functionName, const std::string &code)

Public Member Functions
	ImageTaskScriptingWidget (QWidget *parent=nullptr)
virtual	~ImageTaskScriptingWidget ()
void	setImageTask (task::ImageTask *task)
	setImageTask Sets the current image task used by the scripts. More...
void	syncUserInterface ()
	syncUserInterface Syncs the user interface with the current image task. This should be called after setting a new image task, or new task settings. More...
std::map< std::string, std::string >	getScripts () const
	getScripts Gets all the scripts (shape setup/mutation scripts, and additional scripts). More...
void	evaluateBeforeStepScripts () const
	evaluateBeforeStepScripts Evaluates the scripts set to run directly before the image task is stepped (i.e. immediately before the image task starts a step). More...
void	evaluateAfterStepScripts () const
	evaluateAfterStepScripts Evaluates the scripts set to run directly after the image task is stepped (i.e. immediately after the image task starts a step). More...
bool	evaluateStopConditionScripts () const
	evaluateStopConditionScripts Returns true if the condition(s) for stopping geometrizing the image were met. This is run each time the image task completes a step. More...
void	evaluateOnStopConditionMetScripts () const
	evaluateOnStopConditionMetScripts Evaluates the scripts set to run when the stop condition for stopping geometrizing the image is met. More...
bool	evaluateAddShapePreconditionScripts () const
	evaluateAddShapePreconditionScripts Evaluates the scripts set to decide whether to add a shape to the image or not. More...
void	evaluateBeforeAddShapeScripts () const
	evaluateBeforeAddShapeScripts Evaluates the scripts set to run directly before a shape is added to the image. More...
void	evaluateAfterAddShapeScripts () const
	evaluateAfterAddShapeScripts Evaluates the scripts set to run directly after a shape is added to the image. More...
void	evaluateOnPenInputEventScripts () const
	evaluateOnPenInputEventScripts Evaluates the scripts set to run directly after a pen e.g. Wacom stylus interacts with the scenes. More...
void	evaluateOnPenProximityEnterEventScripts () const
	evaluateOnPenProximityEnterEventScripts Evaluates the scripts set to run directly after a pen e.g. Wacom stylus enters proximity of the screen (application global, not just the scenes). More...
void	evaluateOnPenProximityExitEventScripts () const
	evaluateOnPenProximityExitEventScripts Evaluates the scripts set to run directly after a pen e.g. Wacom stylus leaves the proximity of the screen (application global, not just the scenes). More...
void	evaluateOnKeyDownEventScripts () const
	evaluateOnKeyDownEventScripts Evaluates the scripts set to run directly after a keyboard key is pressed in the context of a scene. More...
void	evaluateOnKeyUpEventScripts () const
	evaluateOnKeyUpEventScripts Evaluates the scripts set to run directly after a keyboard key is released in the context of a scene. More...
void	evaluateOnMouseDownEventScripts () const
	evaluateOnMouseDownEventScripts Evaluates the scripts set to run directly after a mouse key is pressed in the context of a scene. More...
void	evaluateOnMouseUpEventScripts () const
	evaluateOnMouseUpEventScripts Evaluates the scripts set to run directly after a mouse key is released in the context of a scene. More...
void	evaluateOnMouseMoveEventScripts () const
	evaluateOnMouseMoveEventScripts Evaluates the scripts set to run when the mouse is moved in the context of a scene. More...
void	evaluateOnMouseWheelEventScripts () const
	evaluateOnMouseWheelEventScripts Evaluates the scripts set to run when the mouse wheel is moved in the context of a scene. More...
void	evaluateOnTimedUpdateEventScripts () const
	evaluateOnTimedUpdateEventScripts Evaluates the scripts that are set to run periodically (i.e. on an update function triggered by a timer). More...

Protected Member Functions
void	changeEvent (QEvent *) override

Private Attributes
std::unique_ptr< ImageTaskScriptingWidgetImpl >	d

Detailed Description

The ImageTaskScriptingWidget implements a widget for manipulating scripts that are run when an image is being geometrized e.g. before/after a shape is added.

Constructor & Destructor Documentation

ImageTaskScriptingWidget()

geometrize::dialog::ImageTaskScriptingWidget::ImageTaskScriptingWidget

(

QWidget *

parent = nullptr

)

                                                                  :
    QWidget{parent},
    d{std::make_unique<ImageTaskScriptingWidget::ImageTaskScriptingWidgetImpl>(this)}
{
}

~ImageTaskScriptingWidget()

geometrize::dialog::ImageTaskScriptingWidget::~ImageTaskScriptingWidget ( )

virtual

{
}

Member Function Documentation

changeEvent()

void geometrize::dialog::ImageTaskScriptingWidget::changeEvent ( QEvent *  event )

overrideprotected

{
    if (event->type() == QEvent::LanguageChange) {
        d->onLanguageChange();
    }
    QWidget::changeEvent(event);
}

evaluateAddShapePreconditionScripts()

bool geometrize::dialog::ImageTaskScriptingWidget::evaluateAddShapePreconditionScripts

(

)

const

evaluateAddShapePreconditionScripts Evaluates the scripts set to decide whether to add a shape to the image or not.

Returns

True if the shape should be added.

{
    return d->evaluateAddShapePreconditionScripts();
}

evaluateAfterAddShapeScripts()

void geometrize::dialog::ImageTaskScriptingWidget::evaluateAfterAddShapeScripts

(

)

const

evaluateAfterAddShapeScripts Evaluates the scripts set to run directly after a shape is added to the image.

{
    d->evaluateAfterAddShapeScripts();
}

evaluateAfterStepScripts()

void geometrize::dialog::ImageTaskScriptingWidget::evaluateAfterStepScripts

(

)

const

evaluateAfterStepScripts Evaluates the scripts set to run directly after the image task is stepped (i.e. immediately after the image task starts a step).

{
    d->evaluateAfterStepScripts();
}

evaluateBeforeAddShapeScripts()

void geometrize::dialog::ImageTaskScriptingWidget::evaluateBeforeAddShapeScripts

(

)

const

evaluateBeforeAddShapeScripts Evaluates the scripts set to run directly before a shape is added to the image.

{
    d->evaluateBeforeAddShapeScripts();
}

evaluateBeforeStepScripts()

void geometrize::dialog::ImageTaskScriptingWidget::evaluateBeforeStepScripts

(

)

const

evaluateBeforeStepScripts Evaluates the scripts set to run directly before the image task is stepped (i.e. immediately before the image task starts a step).

{
    d->evaluateBeforeStepScripts();
}

evaluateOnKeyDownEventScripts()

void geometrize::dialog::ImageTaskScriptingWidget::evaluateOnKeyDownEventScripts

(

)

const

evaluateOnKeyDownEventScripts Evaluates the scripts set to run directly after a keyboard key is pressed in the context of a scene.

{
    d->evaluateOnKeyDownEventScripts();
}

evaluateOnKeyUpEventScripts()

void geometrize::dialog::ImageTaskScriptingWidget::evaluateOnKeyUpEventScripts

(

)

const

evaluateOnKeyUpEventScripts Evaluates the scripts set to run directly after a keyboard key is released in the context of a scene.

{
    d->evaluateOnKeyUpEventScripts();
}

evaluateOnMouseDownEventScripts()

void geometrize::dialog::ImageTaskScriptingWidget::evaluateOnMouseDownEventScripts

(

)

const

evaluateOnMouseDownEventScripts Evaluates the scripts set to run directly after a mouse key is pressed in the context of a scene.

{
    d->evaluateOnMouseDownEventScripts();
}

evaluateOnMouseMoveEventScripts()

void geometrize::dialog::ImageTaskScriptingWidget::evaluateOnMouseMoveEventScripts

(

)

const

evaluateOnMouseMoveEventScripts Evaluates the scripts set to run when the mouse is moved in the context of a scene.

{
    d->evaluateOnMouseMoveEventScripts();
}

evaluateOnMouseUpEventScripts()

void geometrize::dialog::ImageTaskScriptingWidget::evaluateOnMouseUpEventScripts

(

)

const

evaluateOnMouseUpEventScripts Evaluates the scripts set to run directly after a mouse key is released in the context of a scene.

{
    d->evaluateOnMouseUpEventScripts();
}

evaluateOnMouseWheelEventScripts()

void geometrize::dialog::ImageTaskScriptingWidget::evaluateOnMouseWheelEventScripts

(

)

const

evaluateOnMouseWheelEventScripts Evaluates the scripts set to run when the mouse wheel is moved in the context of a scene.

{
    d->evaluateOnMouseWheelEventScripts();
}

evaluateOnPenInputEventScripts()

void geometrize::dialog::ImageTaskScriptingWidget::evaluateOnPenInputEventScripts

(

)

const

evaluateOnPenInputEventScripts Evaluates the scripts set to run directly after a pen e.g. Wacom stylus interacts with the scenes.

{
    d->evaluateOnPenInputEventScripts();
}

evaluateOnPenProximityEnterEventScripts()

void geometrize::dialog::ImageTaskScriptingWidget::evaluateOnPenProximityEnterEventScripts

(

)

const

evaluateOnPenProximityEnterEventScripts Evaluates the scripts set to run directly after a pen e.g. Wacom stylus enters proximity of the screen (application global, not just the scenes).

{
    d->evaluateOnPenProximityEnterEventScripts();
}

evaluateOnPenProximityExitEventScripts()

void geometrize::dialog::ImageTaskScriptingWidget::evaluateOnPenProximityExitEventScripts

(

)

const

evaluateOnPenProximityExitEventScripts Evaluates the scripts set to run directly after a pen e.g. Wacom stylus leaves the proximity of the screen (application global, not just the scenes).

{
    d->evaluateOnPenProximityExitEventScripts();
}

evaluateOnStopConditionMetScripts()

void geometrize::dialog::ImageTaskScriptingWidget::evaluateOnStopConditionMetScripts

(

)

const

evaluateOnStopConditionMetScripts Evaluates the scripts set to run when the stop condition for stopping geometrizing the image is met.

{
    d->evaluateOnStopConditionMetScripts();
}

evaluateOnTimedUpdateEventScripts()

void geometrize::dialog::ImageTaskScriptingWidget::evaluateOnTimedUpdateEventScripts

(

)

const

evaluateOnTimedUpdateEventScripts Evaluates the scripts that are set to run periodically (i.e. on an update function triggered by a timer).

{
    d->evaluateOnTimedUpdateEventScripts();
}

evaluateStopConditionScripts()

bool geometrize::dialog::ImageTaskScriptingWidget::evaluateStopConditionScripts

(

)

const

evaluateStopConditionScripts Returns true if the condition(s) for stopping geometrizing the image were met. This is run each time the image task completes a step.

Returns

True if a stop condition was met

{
    return d->evaluateStopConditionScripts();
}

getScripts()

std::map< std::string, std::string > geometrize::dialog::ImageTaskScriptingWidget::getScripts

(

)

const

getScripts Gets all the scripts (shape setup/mutation scripts, and additional scripts).

Returns

All scripts within the scripting widget and the shape scripting widget.

{
    return d->getScripts();
}

setImageTask()

void geometrize::dialog::ImageTaskScriptingWidget::setImageTask

(

task::ImageTask *

task

)

setImageTask Sets the current image task used by the scripts.

Parameters

task	Non-owning pointer to the image task that the scripts on this widget will use.

{
    d->setImageTask(task);
}

signal_scriptChanged

void geometrize::dialog::ImageTaskScriptingWidget::signal_scriptChanged ( const std::string &  functionName, const std::string &  code  )

signal

syncUserInterface()

void geometrize::dialog::ImageTaskScriptingWidget::syncUserInterface

(

)

syncUserInterface Syncs the user interface with the current image task. This should be called after setting a new image task, or new task settings.

{
    d->syncUserInterface();
}

Member Data Documentation

d

std::unique_ptr<ImageTaskScriptingWidgetImpl> geometrize::dialog::ImageTaskScriptingWidget::d

private

---

The documentation for this class was generated from the following files:

• /home/appveyor/projects/geometrize-docs/geometrize/geometrize/dialog/imagetaskscriptingwidget.h
• /home/appveyor/projects/geometrize-docs/geometrize/geometrize/dialog/imagetaskscriptingwidget.cpp