Clipping information carried from parents.
More...
#include <kanzi/core.ui/node/node2d.hpp>
Clipping information carried from parents.
◆ RectangleType
Type of rectangle used for clipping.
◆ ClippingArea() [1/3]
kanzi::Node2D::ClippingArea::ClippingArea |
( |
| ) |
|
|
inlineexplicit |
◆ ClippingArea() [2/3]
Constructor.
- Parameters
-
rectangle | Clipping rectangle. |
childRectangle | Clipping rectangle for children. |
previousRectangle | Previous clipping rectangle. |
clipSelfEnabled | True if the node should clip self into the clipping rectangle. |
clipChildrenEnabled | True if the children of the node should clip themselves into the child clipping rectangle. |
◆ ClippingArea() [3/3]
kanzi::Node2D::ClippingArea::ClippingArea |
( |
RectangleType |
rectangle, |
|
|
RectangleType |
previousRectangle, |
|
|
bool |
clipSelfEnabled, |
|
|
bool |
clipChildrenEnabled |
|
) |
| |
|
inlineexplicit |
Constructor where node and child clipping rectangles are equal.
- Parameters
-
rectangle | Clipping rectangle. |
previousRectangle | Previous clipping rectangle. |
clipSelfEnabled | True if the node should clip self into the clipping rectangle. |
clipChildrenEnabled | True if the children of the node should clip themselves into the child clipping rectangle. |
◆ getClippingRectangle()
RectangleType kanzi::Node2D::ClippingArea::getClippingRectangle |
( |
| ) |
const |
|
inline |
Gets the clipping rectangle for the node content.
◆ getChildClippingRectangle()
RectangleType kanzi::Node2D::ClippingArea::getChildClippingRectangle |
( |
| ) |
const |
|
inline |
Gets the clipping rectangle passed down to the children of the node.
◆ setChildClippingRectangle()
void kanzi::Node2D::ClippingArea::setChildClippingRectangle |
( |
RectangleType |
rect | ) |
|
|
inline |
Sets the clipping rectangle passed down to the children of the node.
◆ getHeight()
float kanzi::Node2D::ClippingArea::getHeight |
( |
| ) |
const |
|
inline |
Get height.
- Returns
- Height.
◆ setHeight()
void kanzi::Node2D::ClippingArea::setHeight |
( |
float |
height | ) |
|
|
inline |
◆ getOffsetX()
float kanzi::Node2D::ClippingArea::getOffsetX |
( |
| ) |
const |
|
inline |
Get left edge.
- Returns
- Left edge.
◆ setOffsetX()
void kanzi::Node2D::ClippingArea::setOffsetX |
( |
float |
offset | ) |
|
|
inline |
Set left edge.
- Parameters
-
◆ getOffsetY()
float kanzi::Node2D::ClippingArea::getOffsetY |
( |
| ) |
const |
|
inline |
Get top edge.
- Returns
- Top edge.
◆ setOffsetY()
void kanzi::Node2D::ClippingArea::setOffsetY |
( |
float |
offset | ) |
|
|
inline |
◆ getX2()
float kanzi::Node2D::ClippingArea::getX2 |
( |
| ) |
const |
|
inline |
Get right edge.
- Returns
- Right edge.
◆ getY2()
float kanzi::Node2D::ClippingArea::getY2 |
( |
| ) |
const |
|
inline |
Get bottom edge.
- Returns
- Bottom edge.
◆ getWidth()
float kanzi::Node2D::ClippingArea::getWidth |
( |
| ) |
const |
|
inline |
◆ setWidth()
void kanzi::Node2D::ClippingArea::setWidth |
( |
float |
width | ) |
|
|
inline |
Set width edge.
- Parameters
-
◆ intersect()
void kanzi::Node2D::ClippingArea::intersect |
( |
RectangleType |
intersectionArea | ) |
|
|
inline |
Intersect area with a rectangle.
- Parameters
-
◆ isClippingRectangleChanged()
bool kanzi::Node2D::ClippingArea::isClippingRectangleChanged |
( |
| ) |
const |
|
inline |
Tell if clipping rectangle is changed.
- Returns
- True if yes, false if no.
◆ isClipSelfEnabled()
bool kanzi::Node2D::ClippingArea::isClipSelfEnabled |
( |
| ) |
const |
|
inline |
Tells if node should clip itself to the clipping area defined.
- Returns
- True if yes, false if no.
◆ setClipSelfEnabled()
void kanzi::Node2D::ClippingArea::setClipSelfEnabled |
( |
bool |
enabled | ) |
|
|
inline |
Set enabled flag.
- Parameters
-
◆ isClipChildrenEnabled()
bool kanzi::Node2D::ClippingArea::isClipChildrenEnabled |
( |
| ) |
const |
|
inline |
Tell if the node is passing a clipping rectangle down to its children.
- Returns
- True if yes, false if no.
◆ setClipChildrenEnabled()
void kanzi::Node2D::ClippingArea::setClipChildrenEnabled |
( |
bool |
enabled | ) |
|
|
inline |
Set propagate flag.
- Parameters
-
The documentation for this struct was generated from the following file: