QGIS/python/gui/auto_generated/symbology/qgssymbolanimationsettingswidget.sip.in
Nyall Dawson 4eede35d55 Allow any symbol to be an animated symbol
Users can now indicate that a symbol should be treated as a animated
symbol, through the new "Animation Settings" option in the symbol
widget's Advanced menu.

This settings panel allows users to enable animation for the symbol
and set a specific frame rate at which the symbol should be redrawn.
When enabled, the @symbol_frame variable can be used in any
symbol data defined property in order to animate that property.

For instance, setting the symbol's rotation to the data defined
expression

    @symbol_frame % 360

will cause the symbol to rotate over time. (with rotation speed
dictated by the symbol's refresh rate)
2022-04-09 18:14:44 +10:00

90 lines
2.6 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/symbology/qgssymbolanimationsettingswidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsSymbolAnimationSettingsWidget: QgsPanelWidget
{
%Docstring(signature="appended")
A widget for customising animation settings for a symbol.
.. versionadded:: 3.26
%End
%TypeHeaderCode
#include "qgssymbolanimationsettingswidget.h"
%End
public:
QgsSymbolAnimationSettingsWidget( QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsSymbolAnimationSettingsWidget
%End
void setAnimationSettings( const QgsSymbolAnimationSettings &settings );
%Docstring
Sets the animation ``settings`` to show in the widget.
.. seealso:: :py:func:`animationSettings`
%End
QgsSymbolAnimationSettings animationSettings() const;
%Docstring
Returns the animation settings as defined in the widget.
.. seealso:: :py:func:`setAnimationSettings`
%End
};
class QgsSymbolAnimationSettingsDialog : QDialog
{
%Docstring(signature="appended")
A dialog for customising animation settings for a symbol.
.. versionadded:: 3.26
%End
%TypeHeaderCode
#include "qgssymbolanimationsettingswidget.h"
%End
public:
QgsSymbolAnimationSettingsDialog( QWidget *parent /TransferThis/ = 0, Qt::WindowFlags f = Qt::WindowFlags() );
%Docstring
Constructor for QgsSymbolAnimationSettingsDialog
%End
void setAnimationSettings( const QgsSymbolAnimationSettings &settings );
%Docstring
Sets the animation ``settings`` to show in the dialog.
.. seealso:: :py:func:`animationSettings`
%End
QgsSymbolAnimationSettings animationSettings() const;
%Docstring
Returns the animation settings as defined in the dialog.
.. seealso:: :py:func:`setAnimationSettings`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/symbology/qgssymbolanimationsettingswidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/