Clipping information carried from parents. More...

#include <kanzi/core.ui/node/node2d.hpp>

Public Types
typedef Rectangle< float >	RectangleType
	Type of rectangle used for clipping. More...

Public Member Functions
	ClippingArea ()
	Empty constructor. More...

	ClippingArea (RectangleType rectangle, RectangleType childRectangle, RectangleType previousRectangle, bool clipSelfEnabled, bool clipChildrenEnabled)
	Constructor. More...

	ClippingArea (RectangleType rectangle, RectangleType previousRectangle, bool clipSelfEnabled, bool clipChildrenEnabled)
	Constructor where node and child clipping rectangles are equal. More...

RectangleType	getClippingRectangle () const
	Gets the clipping rectangle for the node content. More...

RectangleType	getChildClippingRectangle () const
	Gets the clipping rectangle passed down to the children of the node. More...

void	setChildClippingRectangle (RectangleType rect)
	Sets the clipping rectangle passed down to the children of the node. More...

float	getHeight () const
	Get height. More...

void	setHeight (float height)
	Set height. More...

float	getOffsetX () const
	Get left edge. More...

void	setOffsetX (float offset)
	Set left edge. More...

float	getOffsetY () const
	Get top edge. More...

void	setOffsetY (float offset)
	Set top edge. More...

float	getX2 () const
	Get right edge. More...

float	getY2 () const
	Get bottom edge. More...

float	getWidth () const
	Get width. More...

void	setWidth (float width)
	Set width edge. More...

void	intersect (RectangleType intersectionArea)
	Intersect area with a rectangle. More...

bool	isClippingRectangleChanged () const
	Tell if clipping rectangle is changed. More...

bool	isClipSelfEnabled () const
	Tell if node should clip itself tot he clipping area defined. More...

void	setClipSelfEnabled (bool enabled)
	Set enabled flag. More...

bool	isClipChildrenEnabled () const
	Tell if the node is passing a clipping rectangle down to its children. More...

void	setClipChildrenEnabled (bool enabled)
	Set propagate flag. More...

Detailed Description

Clipping information carried from parents.

Member Typedef Documentation

typedef Rectangle<float> kanzi::Node2D::ClippingArea::RectangleType

Type of rectangle used for clipping.

Constructor & Destructor Documentation

kanzi::Node2D::ClippingArea::ClippingArea ( )

inlineexplicit

Empty constructor.

kanzi::Node2D::ClippingArea::ClippingArea	(	RectangleType	rectangle,
		RectangleType	childRectangle,
		RectangleType	previousRectangle,
		bool	clipSelfEnabled,
		bool	clipChildrenEnabled
	)

inlineexplicit

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.

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.

Member Function Documentation

RectangleType kanzi::Node2D::ClippingArea::getClippingRectangle ( ) const

inline

Gets the clipping rectangle for the node content.

RectangleType kanzi::Node2D::ClippingArea::getChildClippingRectangle ( ) const

inline

Gets the clipping rectangle passed down to the children of the node.

void kanzi::Node2D::ClippingArea::setChildClippingRectangle ( RectangleType rect )

inline

Sets the clipping rectangle passed down to the children of the node.

float kanzi::Node2D::ClippingArea::getHeight ( ) const

inline

Get height.

Returns: Height.

void kanzi::Node2D::ClippingArea::setHeight ( float height )

inline

Set height.

Parameters

height New height.

float kanzi::Node2D::ClippingArea::getOffsetX ( ) const

inline

Get left edge.

Returns: Left edge.

void kanzi::Node2D::ClippingArea::setOffsetX ( float offset )

inline

Set left edge.

Parameters

offset New X offset.

float kanzi::Node2D::ClippingArea::getOffsetY ( ) const

inline

Get top edge.

Returns: Top edge.

void kanzi::Node2D::ClippingArea::setOffsetY ( float offset )

inline

Set top edge.

Parameters

offset New Y offset.

float kanzi::Node2D::ClippingArea::getX2 ( ) const

inline

Get right edge.

Returns: Right edge.

float kanzi::Node2D::ClippingArea::getY2 ( ) const

inline

Get bottom edge.

Returns: Bottom edge.

float kanzi::Node2D::ClippingArea::getWidth ( ) const

inline

Get width.

Returns: Width.

void kanzi::Node2D::ClippingArea::setWidth ( float width )

inline

Set width edge.

Parameters

width New width.

void kanzi::Node2D::ClippingArea::intersect ( RectangleType intersectionArea )

inline

Intersect area with a rectangle.

Parameters

rectangle Rectangle to intersect with.

bool kanzi::Node2D::ClippingArea::isClippingRectangleChanged ( ) const

inline

Tell if clipping rectangle is changed.

Returns: True if yes, false if no.

bool kanzi::Node2D::ClippingArea::isClipSelfEnabled ( ) const

inline

Tell if node should clip itself tot he clipping area defined.

Returns: True if yes, false if no.

void kanzi::Node2D::ClippingArea::setClipSelfEnabled ( bool enabled )

inline

Set enabled flag.

Parameters

enabled New enabled flag.

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.

void kanzi::Node2D::ClippingArea::setClipChildrenEnabled ( bool enabled )

inline

Set propagate flag.

Parameters

enabled New enabled flag.

The documentation for this struct was generated from the following file:

kanzi/core.ui/node/node2d.hpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation