1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/project/qgsprojecttimesettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsProjectTimeSettings : QObject
{
%Docstring(signature="appended")
Contains temporal settings and properties for the project, this may be
used when animating maps or showing temporal layers.
.. versionadded:: 3.14
%End
%TypeHeaderCode
#include "qgsprojecttimesettings.h"
%End
public:
QgsProjectTimeSettings( QObject *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsProjectTimeSettings with the specified ``parent``
object.
%End
void reset();
%Docstring
Resets the settings to a default state.
%End
QgsDateTimeRange temporalRange() const;
%Docstring
Returns the project's temporal range, which indicates the earliest and
latest datetime ranges associated with the project.
.. note::
This is a manual, use-set property, and does not necessarily
coincide with the earliest and latest temporal ranges set for
individual layers in the project.
.. seealso:: :py:func:`setTemporalRange`
.. seealso:: :py:func:`temporalRangeChanged`
%End
void setTemporalRange( const QgsDateTimeRange &range );
%Docstring
Sets the project's temporal ``range``, which indicates the earliest and
latest datetime ranges associated with the project.
.. note::
This is a manual, use-set property, and does not necessarily
coincide with the earliest and latest temporal ranges set for
individual layers in the project.
.. seealso:: :py:func:`temporalRange`
.. seealso:: :py:func:`temporalRangeChanged`
%End
bool readXml( const QDomElement &element, const QgsReadWriteContext &context );
%Docstring
Reads the settings's state from a DOM ``element``.
.. seealso:: :py:func:`writeXml`
%End
QDomElement writeXml( QDomDocument &document, const QgsReadWriteContext &context ) const;
%Docstring
Returns a DOM element representing the settings.
.. seealso:: :py:func:`readXml`
%End
Qgis::TemporalUnit timeStepUnit() const;
%Docstring
Returns the project's time step (length of one animation frame) unit,
which is used as the default value when animating the project.
.. seealso:: :py:func:`setTimeStepUnit`
.. seealso:: :py:func:`timeStep`
%End
void setTimeStepUnit( Qgis::TemporalUnit unit );
%Docstring
Sets the project's time step (length of one animation frame) ``unit``,
which is used as the default value when animating the project.
.. seealso:: :py:func:`timeStepUnit`
.. seealso:: :py:func:`setTimeStep`
%End
double timeStep() const;
%Docstring
Returns the project's time step (length of one animation frame), which
is used as the default value when animating the project.
Units are specified via :py:func:`~QgsProjectTimeSettings.timeStepUnit`
.. seealso:: :py:func:`setTimeStep`
.. seealso:: :py:func:`timeStepUnit`
%End
void setTimeStep( double step );
%Docstring
Sets the project's time ``step`` (length of one animation frame), which
is used as the default value when animating the project.
Units are specified via
:py:func:`~QgsProjectTimeSettings.setTimeStepUnit`
.. seealso:: :py:func:`timeStep`
.. seealso:: :py:func:`setTimeStepUnit`
%End
void setFramesPerSecond( double rate );
%Docstring
Sets the project's default animation frame ``rate``, in frames per
second.
.. seealso:: :py:func:`framesPerSecond`
%End
double framesPerSecond() const;
%Docstring
Returns the project's default animation frame rate, in frames per
second.
.. seealso:: :py:func:`setFramesPerSecond`
%End
void setIsTemporalRangeCumulative( bool state );
%Docstring
Sets the project's temporal range as cumulative in animation settings.
.. seealso:: :py:func:`isTemporalRangeCumulative`
%End
bool isTemporalRangeCumulative() const;
%Docstring
Returns the value of cumulative temporal range in animation settings.
.. seealso:: :py:func:`setIsTemporalRangeCumulative`
%End
long long totalMovieFrames() const;
%Docstring
Returns the total number of frames for the project's movie.
.. note::
This is only used when the navigation mode is set to :py:class:`Qgis`.TemporalNavigationMode.Movie.
.. seealso:: :py:func:`setTotalMovieFrames`
.. versionadded:: 3.36
%End
void setTotalMovieFrames( long long frames );
%Docstring
Sets the total number of ``frames`` for the movie.
.. note::
This is only used when the navigationm mode is set to :py:class:`Qgis`.TemporalNavigationMode.Movie.
.. seealso:: :py:func:`totalMovieFrames`
.. versionadded:: 3.36
%End
signals:
void temporalRangeChanged();
%Docstring
Emitted when the temporal range changes.
.. seealso:: :py:func:`temporalRange`
.. seealso:: :py:func:`setTemporalRange`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/project/qgsprojecttimesettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
