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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsmaplayertemporalproperties.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsMapLayerTemporalProperties : QgsTemporalProperty
{
%Docstring(signature="appended")
Base class for storage of map layer temporal properties.
:py:class:`QgsMapLayerTemporalProperties` exposes user-configurable
settings for controlling how an individual :py:class:`QgsMapLayer`
behaves in a temporal context, e.g. while animating a map object.
.. versionadded:: 3.14
%End
%TypeHeaderCode
#include "qgsmaplayertemporalproperties.h"
#include "qgsrasterlayertemporalproperties.h"
#include "qgsmeshlayertemporalproperties.h"
#include "qgsvectorlayertemporalproperties.h"
%End
%ConvertToSubClassCode
if ( qobject_cast<QgsRasterLayerTemporalProperties *>( sipCpp ) )
{
sipType = sipType_QgsRasterLayerTemporalProperties;
}
else if ( qobject_cast<QgsMeshLayerTemporalProperties *>( sipCpp ) )
{
sipType = sipType_QgsMeshLayerTemporalProperties;
}
else if ( qobject_cast<QgsVectorLayerTemporalProperties *>( sipCpp ) )
{
sipType = sipType_QgsVectorLayerTemporalProperties;
}
else
{
sipType = 0;
}
%End
public:
QgsMapLayerTemporalProperties( QObject *parent /TransferThis/, bool enabled = false );
%Docstring
Constructor for QgsMapLayerTemporalProperties, with the specified
``parent`` object.
The ``enabled`` argument specifies whether the temporal properties are
initially enabled or not (see
:py:func:`~QgsMapLayerTemporalProperties.isActive`).
%End
virtual QDomElement writeXml( QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context ) = 0;
%Docstring
Writes the properties to a DOM ``element``, to be used later with
:py:func:`~QgsMapLayerTemporalProperties.readXml`.
.. seealso:: :py:func:`readXml`
%End
virtual bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) = 0;
%Docstring
Reads temporal properties from a DOM ``element`` previously written by
:py:func:`~QgsMapLayerTemporalProperties.writeXml`.
.. seealso:: :py:func:`writeXml`
%End
virtual bool isVisibleInTemporalRange( const QgsDateTimeRange &range ) const;
%Docstring
Returns ``True`` if the layer should be visible and rendered for the
specified time ``range``.
%End
virtual void setDefaultsFromDataProviderTemporalCapabilities( const QgsDataProviderTemporalCapabilities *capabilities ) = 0;
%Docstring
Sets the layers temporal settings to appropriate defaults based on a
provider's temporal ``capabilities``.
%End
virtual QList< QgsDateTimeRange > allTemporalRanges( QgsMapLayer *layer ) const;
%Docstring
Attempts to calculate the overall list of all temporal extents which are
contained in the specified ``layer``, using the settings defined by the
temporal properties object.
May return an empty list if the ranges could not be calculated.
.. versionadded:: 3.20
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsmaplayertemporalproperties.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
