Clipping information carried from parents. More...

#include <kanzi/node/node2d.hpp>

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

	ClippingParameters (KzcRectangle area, KzcRectangle previousArea, bool enabled, bool propagate)
	Constructor. More...

KzcRectangle	getArea () const
	Get current area. More...

void	setArea (float offsetX, float offsetY, float sizeX, float sizeY)
	Set current area. 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 (KzcRectangle intersectionArea)
	Intersect area with a rectangle. More...

bool	isAreaChanged () const
	Tell if clipping area is changed. More...

bool	isEnabled () const
	Tell if clipping is enabled. More...

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

bool	isPropagate () const
	Tell if propagation is enabled. More...

void	setPropagate (bool propagate)
	Set propagate flag. More...

Friends
bool	operator== (const ClippingParameters &lhs, const ClippingParameters &rhs)
	Equals operator for clipping parameters. More...

bool	operator!= (const ClippingParameters &lhs, const ClippingParameters &rhs)
	Not equals operator for clipping parameters. More...

Detailed Description

Clipping information carried from parents.

Constructor & Destructor Documentation

kanzi::Node2D::ClippingParameters::ClippingParameters ( )

inline

Empty constructor.

kanzi::Node2D::ClippingParameters::ClippingParameters	(	KzcRectangle	area,
		KzcRectangle	previousArea,
		bool	enabled,
		bool	propagate
	)

inline

Constructor.

Parameters

area	Area.
previousArea	Previous area.
enabled	Enabled flag.
propagate	Propagate flag.

Member Function Documentation

KzcRectangle kanzi::Node2D::ClippingParameters::getArea ( ) const

inline

Get current area.

Returns: Area.

void kanzi::Node2D::ClippingParameters::setArea	(	float	offsetX,
		float	offsetY,
		float	sizeX,
		float	sizeY
	)

inline

Set current area.

Parameters

offsetX	X offset.
offsetY	Y offset.
sizeX	X size.
sizeY	Y size.

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

inline

Get height.

Returns: Height.

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

inline

Set height.

Parameters

height New height.

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

inline

Get left edge.

Returns: Left edge.

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

inline

Set left edge.

Parameters

offset New X offset.

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

inline

Get top edge.

Returns: Top edge.

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

inline

Set top edge.

Parameters

offset New Y offset.

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

inline

Get right edge.

Returns: Right edge.

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

inline

Get bottom edge.

Returns: Bottom edge.

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

inline

Get width.

Returns: Width.

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

inline

Set width edge.

Parameters

width New width.

void kanzi::Node2D::ClippingParameters::intersect ( KzcRectangle intersectionArea )

inline

Intersect area with a rectangle.

Parameters

rectangle Rectangle to intersect with.

bool kanzi::Node2D::ClippingParameters::isAreaChanged ( ) const

inline

Tell if clipping area is changed.

Returns: True if yes, false if no.

bool kanzi::Node2D::ClippingParameters::isEnabled ( ) const

inline

Tell if clipping is enabled.

Returns: True if yes, false if no.

void kanzi::Node2D::ClippingParameters::setEnabled ( bool enabled )

inline

Set enabled flag.

Parameters

enabled New enabled flag.

bool kanzi::Node2D::ClippingParameters::isPropagate ( ) const

inline

Tell if propagation is enabled.

Returns: True if yes, false if no.

void kanzi::Node2D::ClippingParameters::setPropagate ( bool propagate )

inline

Set propagate flag.

Parameters

propagate New propagate flag.

Friends And Related Function Documentation

bool operator==	(	const ClippingParameters &	lhs,
		const ClippingParameters &	rhs
	)

friend

Equals operator for clipping parameters.

Parameters

rhs	Right-hand-side operand.

Returns: True if equal, false if equal

bool operator!=	(	const ClippingParameters &	lhs,
		const ClippingParameters &	rhs
	)

friend

Not equals operator for clipping parameters.

Parameters

rhs	Right-hand-side operand.

Returns: True if not equal, false if equal.

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

kanzi/node/node2d.hpp

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation