openCom-Companion/sbapp/kivymd/uix/behaviors/elevation.py

773 lines
22 KiB
Python
Raw Normal View History

2022-07-07 22:16:10 +02:00
"""
Behaviors/Elevation
===================
.. seealso::
`Material Design spec, Elevation <https://material.io/design/environment/elevation.html>`_
.. rubric:: Elevation is the relative distance between two surfaces along the z-axis.
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/elevation-previous.png
:align: center
2022-10-08 17:17:59 +02:00
To create an elevation effect, use the :class:`~CommonElevationBehavior` class.
For example, let's create a button with a rectangular elevation effect:
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. tabs::
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. tab:: Declarative style with KV
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. code-block:: python
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
from kivy.lang import Builder
from kivy.uix.behaviors import ButtonBehavior
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
from kivymd.app import MDApp
from kivymd.uix.behaviors import (
RectangularRippleBehavior,
BackgroundColorBehavior,
CommonElevationBehavior,
)
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
KV = '''
<RectangularElevationButton>
size_hint: None, None
size: "250dp", "50dp"
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
MDScreen:
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
# With elevation effect
RectangularElevationButton:
pos_hint: {"center_x": .5, "center_y": .6}
2023-07-10 02:49:58 +02:00
elevation: 4
shadow_offset: 0, -6
shadow_softness: 4
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
# Without elevation effect
RectangularElevationButton:
pos_hint: {"center_x": .5, "center_y": .4}
'''
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
class RectangularElevationButton(
RectangularRippleBehavior,
CommonElevationBehavior,
ButtonBehavior,
BackgroundColorBehavior,
):
def __init__(self, **kwargs):
super().__init__(**kwargs)
self.md_bg_color = "red"
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
class Example(MDApp):
def build(self):
return Builder.load_string(KV)
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
Example().run()
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. tab:: Declarative python style
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. code-block:: python
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
from kivy.uix.behaviors import ButtonBehavior
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
from kivymd.app import MDApp
from kivymd.uix.behaviors import (
RectangularRippleBehavior,
BackgroundColorBehavior,
CommonElevationBehavior,
)
from kivymd.uix.screen import MDScreen
2022-10-08 17:17:59 +02:00
class RectangularElevationButton(
RectangularRippleBehavior,
CommonElevationBehavior,
ButtonBehavior,
BackgroundColorBehavior,
):
def __init__(self, **kwargs):
super().__init__(**kwargs)
self.md_bg_color = "red"
self.size_hint = (None, None)
self.size = ("250dp", "50dp")
2022-10-08 17:17:59 +02:00
class Example(MDApp):
def build(self):
return (
MDScreen(
RectangularElevationButton(
pos_hint={"center_x": .5, "center_y": .6},
2023-07-10 02:49:58 +02:00
elevation=4,
shadow_softness=4,
shadow_offset=(0, -6),
2022-10-08 17:17:59 +02:00
),
RectangularElevationButton(
pos_hint={"center_x": .5, "center_y": .4},
),
)
)
2022-10-08 17:17:59 +02:00
Example().run()
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/rectangular-elevation-effect.png
2022-07-07 22:16:10 +02:00
:align: center
2022-10-08 17:17:59 +02:00
.. warning::
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
If before the KivyMD 1.1.0 library version you used the elevation property
with an average value of `12` for the shadow, then starting with the KivyMD
1.1.0 library version, the average value of the elevation property will be
somewhere `4`.
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
Similarly, create a circular button:
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. tabs::
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. tab:: Declarative style with KV
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. code-block:: python
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
from kivy.lang import Builder
from kivy.uix.behaviors import ButtonBehavior
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
from kivymd.app import MDApp
from kivymd.uix.behaviors import CircularRippleBehavior, CommonElevationBehavior
from kivymd.uix.floatlayout import MDFloatLayout
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
KV = '''
<CircularElevationButton>
size_hint: None, None
size: "100dp", "100dp"
radius: self.size[0] / 2
shadow_radius: self.radius[0]
md_bg_color: "red"
MDIcon:
icon: "hand-heart"
halign: "center"
valign: "center"
pos_hint: {"center_x": .5, "center_y": .5}
size: root.size
pos: root.pos
font_size: root.size[0] * .6
theme_text_color: "Custom"
text_color: "white"
MDScreen:
CircularElevationButton:
pos_hint: {"center_x": .5, "center_y": .6}
elevation: 4
2023-07-10 02:49:58 +02:00
shadow_softness: 4
2022-10-08 17:17:59 +02:00
'''
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
class CircularElevationButton(
CommonElevationBehavior,
CircularRippleBehavior,
ButtonBehavior,
MDFloatLayout,
):
pass
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
class Example(MDApp):
def build(self):
return Builder.load_string(KV)
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
Example().run()
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. tab:: Declarative python style
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. code-block:: python
2022-10-08 17:17:59 +02:00
from kivy.metrics import dp
from kivy.uix.behaviors import ButtonBehavior
2022-10-08 17:17:59 +02:00
from kivymd.app import MDApp
from kivymd.uix.behaviors import CircularRippleBehavior, CommonElevationBehavior
from kivymd.uix.floatlayout import MDFloatLayout
from kivymd.uix.label import MDIcon
from kivymd.uix.screen import MDScreen
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
class CircularElevationButton(
CommonElevationBehavior,
CircularRippleBehavior,
ButtonBehavior,
MDFloatLayout,
):
def __init__(self, **kwargs):
super().__init__(**kwargs)
self.size_hint = (None, None)
self.size = (dp(100), dp(100))
self.radius = dp(100) / 2
self.shadow_radius = dp(100) / 2
self.md_bg_color = "red"
self.add_widget(
MDIcon(
icon="hand-heart",
halign="center",
valign="center",
pos_hint={"center_x": .5, "center_y": .5},
size=self.size,
theme_text_color="Custom",
text_color="white",
font_size=self.size[0] * 0.6,
)
)
2022-10-08 17:17:59 +02:00
class Example(MDApp):
def build(self):
return (
MDScreen(
CircularElevationButton(
pos_hint={"center_x": .5, "center_y": .5},
elevation=4,
2023-07-10 02:49:58 +02:00
shadow_softness=4,
2022-10-08 17:17:59 +02:00
)
)
)
2022-10-08 17:17:59 +02:00
Example().run()
2022-10-08 17:17:59 +02:00
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/circular-elevation-effect.png
2022-07-07 22:16:10 +02:00
:align: center
Animating the elevation
-----------------------
2022-10-08 17:17:59 +02:00
.. tabs::
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. tab:: Declarative style with KV
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. code-block:: python
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
from kivy.animation import Animation
from kivy.lang import Builder
from kivy.uix.behaviors import ButtonBehavior
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
from kivymd.app import MDApp
from kivymd.uix.behaviors import CommonElevationBehavior, RectangularRippleBehavior
from kivymd.uix.widget import MDWidget
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
KV = '''
MDScreen:
ElevatedWidget:
pos_hint: {'center_x': .5, 'center_y': .5}
size_hint: None, None
size: 100, 100
md_bg_color: 0, 0, 1, 1
2023-07-10 02:49:58 +02:00
elevation: 2
2022-10-08 17:17:59 +02:00
radius: 18
'''
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
class ElevatedWidget(
CommonElevationBehavior,
RectangularRippleBehavior,
ButtonBehavior,
MDWidget,
):
_elev = 0 # previous elevation value
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
def on_press(self, *args):
if not self._elev:
self._elev = self.elevation
Animation(elevation=self.elevation + 2, d=0.4).start(self)
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
def on_release(self, *args):
Animation.cancel_all(self, "elevation")
Animation(elevation=self._elev, d=0.1).start(self)
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
class Example(MDApp):
def build(self):
return Builder.load_string(KV)
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
Example().run()
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. tab:: Declarative python style
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. code-block:: python
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
from kivy.animation import Animation
from kivy.uix.behaviors import ButtonBehavior
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
from kivymd.app import MDApp
from kivymd.uix.behaviors import CommonElevationBehavior, RectangularRippleBehavior
from kivymd.uix.screen import MDScreen
from kivymd.uix.widget import MDWidget
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
class ElevatedWidget(
CommonElevationBehavior,
RectangularRippleBehavior,
ButtonBehavior,
MDWidget,
):
_elev = 0 # previous elevation value
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
def on_press(self, *args):
if not self._elev:
self._elev = self.elevation
Animation(elevation=self.elevation + 2, d=0.4).start(self)
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
def on_release(self, *args):
Animation.cancel_all(self, "elevation")
Animation(elevation=self._elev, d=0.1).start(self)
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
class Example(MDApp):
def build(self):
return (
MDScreen(
ElevatedWidget(
pos_hint={'center_x': .5, 'center_y': .5},
size_hint=(None, None),
size=(100, 100),
md_bg_color="blue",
2023-07-10 02:49:58 +02:00
elevation=2,
2022-10-08 17:17:59 +02:00
radius=18,
)
)
)
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
Example().run()
2022-10-08 17:17:59 +02:00
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/rectangular-elevation-animation-effect.gif
2022-07-07 22:16:10 +02:00
:align: center
"""
2022-10-08 17:17:59 +02:00
from __future__ import annotations
2022-07-07 22:16:10 +02:00
__all__ = (
"CommonElevationBehavior",
"RectangularElevationBehavior",
"CircularElevationBehavior",
"RoundedRectangularElevationBehavior",
"FakeRectangularElevationBehavior",
"FakeCircularElevationBehavior",
)
from kivy import Logger
2023-07-10 02:49:58 +02:00
from kivy.lang import Builder
2022-07-07 22:16:10 +02:00
from kivy.properties import (
BoundedNumericProperty,
2022-10-08 17:17:59 +02:00
ColorProperty,
2022-07-07 22:16:10 +02:00
ListProperty,
NumericProperty,
VariableListProperty,
)
from kivy.uix.widget import Widget
2023-07-10 02:49:58 +02:00
Builder.load_string(
"""
<CommonElevationBehavior>
canvas.before:
PushMatrix
Scale:
x: self.scale_value_x
y: self.scale_value_y
z: self.scale_value_x
origin:
self.center \
if not self.scale_value_center else \
self.scale_value_center
Rotate:
angle: self.rotate_value_angle
axis: tuple(self.rotate_value_axis)
origin: self.center
Color:
rgba:
(0, 0, 0, 0) \
if self.disabled or not self.elevation else \
root.shadow_color
BoxShadow:
pos: self.pos
size: self.size
offset: root.shadow_offset
spread_radius: -(root.shadow_softness), -(root.shadow_softness)
blur_radius: root.elevation * 10
border_radius:
(root.radius if hasattr(self, "radius") else [0, 0, 0, 0]) \
if root.shadow_radius == [0.0, 0.0, 0.0, 0.0] else \
root.shadow_radius
canvas.after:
PopMatrix
"""
)
2022-07-07 22:16:10 +02:00
class CommonElevationBehavior(Widget):
2023-07-10 02:49:58 +02:00
"""
Common base class for rectangular and circular elevation behavior.
For more information, see in the :class:`~kivy.uix.widget.Widget`
class documentation.
"""
2022-07-07 22:16:10 +02:00
elevation = BoundedNumericProperty(0, min=0, errorvalue=0)
"""
Elevation of the widget.
:attr:`elevation` is an :class:`~kivy.properties.BoundedNumericProperty`
and defaults to `0`.
"""
2022-10-08 17:17:59 +02:00
shadow_radius = VariableListProperty([0], length=4)
2022-07-07 22:16:10 +02:00
"""
2022-10-08 17:17:59 +02:00
Radius of the corners of the shadow.
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. versionadded:: 1.1.0
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
You don't have to use this parameter.
The radius of the elevation effect is calculated automatically one way
or another based on the radius of the parent widget, for example:
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. code-block:: python
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
from kivy.lang import Builder
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
from kivymd.app import MDApp
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
KV = '''
MDScreen:
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
MDCard:
radius: 12, 46, 12, 46
size_hint: .5, .3
pos_hint: {"center_x": .5, "center_y": .5}
2023-07-10 02:49:58 +02:00
elevation: 2
shadow_softness: 4
shadow_offset: (2, -2)
2022-10-08 17:17:59 +02:00
'''
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
class Test(MDApp):
def build(self):
return Builder.load_string(KV)
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
Test().run()
2022-10-08 17:17:59 +02:00
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/shadow-radius.png
:align: center
2022-10-08 17:17:59 +02:00
:attr:`shadow_radius` is an :class:`~kivy.properties.VariableListProperty`
2022-07-07 22:16:10 +02:00
and defaults to `[0, 0, 0, 0]`.
"""
2023-07-10 02:49:58 +02:00
shadow_softness = NumericProperty(0.0)
2022-07-07 22:16:10 +02:00
"""
2022-10-08 17:17:59 +02:00
Softness of the shadow.
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. versionadded:: 1.1.0
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. code-block:: python
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
from kivy.lang import Builder
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
from kivymd.app import MDApp
from kivymd.uix.behaviors import BackgroundColorBehavior, CommonElevationBehavior
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
KV = '''
<RectangularElevationButton>
size_hint: None, None
size: "250dp", "50dp"
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
MDScreen:
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
RectangularElevationButton:
pos_hint: {"center_x": .5, "center_y": .6}
elevation: 6
shadow_softness: 6
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
RectangularElevationButton:
pos_hint: {"center_x": .5, "center_y": .4}
elevation: 6
shadow_softness: 12
'''
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
class RectangularElevationButton(CommonElevationBehavior, BackgroundColorBehavior):
2023-07-10 02:49:58 +02:00
def __init__(self, **kwargs):
super().__init__(**kwargs)
self.md_bg_color = "blue"
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
class Example(MDApp):
def build(self):
return Builder.load_string(KV)
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
Example().run()
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/shadow-softness.png
:align: center
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
:attr:`shadow_softness` is an :class:`~kivy.properties.NumericProperty`
and defaults to `12`.
2022-07-07 22:16:10 +02:00
"""
2023-07-10 02:49:58 +02:00
shadow_softness_size = BoundedNumericProperty(2, min=2, deprecated=True)
"""
The value of the softness of the shadow.
.. versionadded:: 1.1.0
.. deprecated:: 1.2.0
:attr:`shadow_softness_size` is an :class:`~kivy.properties.NumericProperty`
and defaults to `2`.
"""
shadow_offset = ListProperty((0, 0))
2022-07-07 22:16:10 +02:00
"""
2022-10-08 17:17:59 +02:00
Offset of the shadow.
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. versionadded:: 1.1.0
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. code-block:: python
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
from kivy.lang import Builder
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
from kivymd.app import MDApp
from kivymd.uix.behaviors import BackgroundColorBehavior, CommonElevationBehavior
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
KV = '''
<RectangularElevationButton>
size_hint: None, None
size: "100dp", "100dp"
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
MDScreen:
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
RectangularElevationButton:
pos_hint: {"center_x": .5, "center_y": .5}
elevation: 6
2023-07-10 02:49:58 +02:00
shadow_radius: 6
shadow_softness: 12
shadow_offset: -12, -12
2022-10-08 17:17:59 +02:00
'''
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
class RectangularElevationButton(CommonElevationBehavior, BackgroundColorBehavior):
2023-07-10 02:49:58 +02:00
def __init__(self, **kwargs):
super().__init__(**kwargs)
self.md_bg_color = "blue"
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
class Example(MDApp):
def build(self):
return Builder.load_string(KV)
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
Example().run()
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/shadow-offset-1.png
:align: center
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. code-block:: kv
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
RectangularElevationButton:
2023-07-10 02:49:58 +02:00
shadow_offset: 12, -12
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/shadow-offset-2.png
:align: center
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. code-block:: kv
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
RectangularElevationButton:
2023-07-10 02:49:58 +02:00
shadow_offset: 12, 12
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/shadow-offset-3.png
:align: center
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. code-block:: kv
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
RectangularElevationButton:
2023-07-10 02:49:58 +02:00
shadow_offset: -12, 12
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/shadow-offset-4.png
:align: center
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
:attr:`shadow_offset` is an :class:`~kivy.properties.ListProperty`
2023-07-10 02:49:58 +02:00
and defaults to `(0, 0)`.
2022-07-07 22:16:10 +02:00
"""
2022-10-08 17:17:59 +02:00
shadow_color = ColorProperty([0, 0, 0, 0.6])
2022-07-07 22:16:10 +02:00
"""
2022-10-08 17:17:59 +02:00
Offset of the shadow.
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. versionadded:: 1.1.0
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. code-block:: python
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
RectangularElevationButton:
shadow_color: 0, 0, 1, .8
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/shadow-color.png
:align: center
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
:attr:`shadow_color` is an :class:`~kivy.properties.ColorProperty`
2023-07-10 02:49:58 +02:00
and defaults to `[0, 0, 0, 0.6]`.
"""
scale_value_x = NumericProperty(1)
"""
X-axis value.
.. versionadded:: 1.2.0
:attr:`scale_value_x` is an :class:`~kivy.properties.NumericProperty`
and defaults to `1`.
"""
scale_value_y = NumericProperty(1)
"""
Y-axis value.
.. versionadded:: 1.2.0
:attr:`scale_value_y` is an :class:`~kivy.properties.NumericProperty`
and defaults to `1`.
"""
scale_value_z = NumericProperty(1)
"""
Z-axis value.
.. versionadded:: 1.2.0
:attr:`scale_value_z` is an :class:`~kivy.properties.NumericProperty`
and defaults to `1`.
"""
scale_value_center = ListProperty()
"""
Origin of the scale.
.. versionadded:: 1.2.0
The format of the origin can be either (x, y) or (x, y, z).
:attr:`scale_value_center` is an :class:`~kivy.properties.NumericProperty`
and defaults to `[]`.
"""
rotate_value_angle = NumericProperty(0)
"""
Property for getting/setting the angle of the rotation.
.. versionadded:: 1.2.0
:attr:`rotate_value_angle` is an :class:`~kivy.properties.NumericProperty`
and defaults to `0`.
"""
rotate_value_axis = ListProperty((0, 0, 1))
"""
Property for getting/setting the axis of the rotation.
.. versionadded:: 1.2.0
:attr:`rotate_value_axis` is an :class:`~kivy.properties.ListProperty`
and defaults to `(0, 0, 1)`.
"""
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
_elevation = 0
2022-07-07 22:16:10 +02:00
2022-10-08 17:17:59 +02:00
def on_elevation(self, instance, value) -> None:
2023-07-10 02:49:58 +02:00
self._elevation = value
2022-07-07 22:16:10 +02:00
class RectangularElevationBehavior(CommonElevationBehavior):
"""
2022-10-08 17:17:59 +02:00
.. deprecated:: 1.1.0
Use :class:`~CommonElevationBehavior` class instead.
2022-07-07 22:16:10 +02:00
"""
def __init__(self, **kwargs):
super().__init__(**kwargs)
2022-10-08 17:17:59 +02:00
Logger.warning(
"KivyMD: "
"The `RectangularElevationBehavior` class has been deprecated. "
"Use the `CommonElevationBehavior` class instead.`"
)
2022-07-07 22:16:10 +02:00
class CircularElevationBehavior(CommonElevationBehavior):
"""
2022-10-08 17:17:59 +02:00
.. deprecated:: 1.1.0
Use :class:`~CommonElevationBehavior` class instead.
2022-07-07 22:16:10 +02:00
"""
def __init__(self, **kwargs):
super().__init__(**kwargs)
2022-10-08 17:17:59 +02:00
Logger.warning(
"KivyMD: "
"The `CircularElevationBehavior` class has been deprecated. "
"Use the `CommonElevationBehavior` class instead.`"
)
2022-07-07 22:16:10 +02:00
class RoundedRectangularElevationBehavior(CommonElevationBehavior):
"""
2022-10-08 17:17:59 +02:00
.. deprecated:: 1.1.0
Use :class:`~CommonElevationBehavior` class instead.
2022-07-07 22:16:10 +02:00
"""
def __init__(self, **kwargs):
super().__init__(**kwargs)
2022-10-08 17:17:59 +02:00
Logger.warning(
"KivyMD: "
"The `RoundedRectangularElevationBehavior` class has been "
"deprecated. Use the `CommonElevationBehavior` class instead.`"
2022-07-07 22:16:10 +02:00
)
class FakeRectangularElevationBehavior(CommonElevationBehavior):
"""
2022-10-08 17:17:59 +02:00
.. deprecated:: 1.1.0
Use :class:`~CommonElevationBehavior` class instead.
2022-07-07 22:16:10 +02:00
"""
def __init__(self, **kwargs):
super().__init__(**kwargs)
2022-10-08 17:17:59 +02:00
Logger.warning(
"KivyMD: "
"The `FakeRectangularElevationBehavior` class has been "
"deprecated. Use the `CommonElevationBehavior` class instead."
)
2022-07-07 22:16:10 +02:00
class FakeCircularElevationBehavior(CommonElevationBehavior):
"""
2022-10-08 17:17:59 +02:00
.. deprecated:: 1.1.0
Use :class:`~CommonElevationBehavior` class instead.
2022-07-07 22:16:10 +02:00
"""
def __init__(self, **kwargs):
super().__init__(**kwargs)
2022-10-08 17:17:59 +02:00
Logger.warning(
"KivyMD: "
"The `FakeCircularElevationBehavior` class has been deprecated. "
"Use the `CommonElevationBehavior` class instead."
)