FSDK.RectI Class Reference

Public Member Functions
	constructor ()
	Construct a rect not initialized.
	constructor (left1, top1, right1, bottom1)
	Construct a rect with left-top and right bottom corners. More...
	Contains (other_rect)
	Check if current rectangle fully contains the other provided rectangle. That means to check if the other rectangle is fully inside current one. More...
	Contains (x, y)
	Check if current rectangle contains the provided point. That means to check if the provided point is inside current one. More...
	Height ()
	Get the height of the rect. More...
	Intersect (src)
	Intersect with a rect. More...
	Intersect (left1, top1, right1, bottom1)
	Intersect with a rect. More...
	IsEmpty ()
	Verify whether the rect is empty. More...
	Normalize ()
	Normalize the rect. Make sure left <= right, top <= bottom. More...
	Offset (dx, dy)
	Shift the coordinates by delta value of x and y directions. More...
	Union (other_rect)
	Union with a rect. More...
	Valid ()
	Check if current rectangle is valid. More...
	Width ()
	Get the width of the rect. More...

Public Attributes
	bottom
	The bottom.
	left
	The left.
	right
	The right.
	top
	The top.

Detailed Description

The struct represents integer rectangle for Windows coordinates. Defined as equivalent of Windows RECT structure, with some convenient function members. This structure use Windows space where Y axis runs from top to bottom.

Member Function Documentation

constructor()

FSDK.RectI.constructor (   left1,   top1,   right1,   bottom1  )

inline

Construct a rect with left-top and right bottom corners.

Parameters

[in]	left1	The left.
[in]	top1	The top.
[in]	right1	The right.
[in]	bottom1	The bottom.

Contains() [1/2]

FSDK.RectI.Contains (   other_rect )

inline

Check if current rectangle fully contains the other provided rectangle. That means to check if the other rectangle is fully inside current one.

Parameters

[in]

other_rect

The other provided rect.

Returns

true means current rect fully contains the other rectangle, while false means not.

Contains() [2/2]

FSDK.RectI.Contains (   x,   y  )

inline

Check if current rectangle contains the provided point. That means to check if the provided point is inside current one.

Parameters

[in]	x	The x coordinate of the provided point.
[in]	y	The y coordinate of the provided point.

Returns

true means current rect contains the provided point, while false means not.

Height()

FSDK.RectI.Height ( )

inline

Get the height of the rect.

Returns

The height of the rect.

Intersect() [1/2]

FSDK.RectI.Intersect (   src )

inline

Intersect with a rect.

Parameters

[in]

src

The rect to intersect with.

Returns

None.

Intersect() [2/2]

FSDK.RectI.Intersect (   left1,   top1,   right1,   bottom1  )

inline

Intersect with a rect.

Parameters

[in]	left1	The left of the rect to intersect with.
[in]	top1	The top of the rect to intersect with.
[in]	right1	The right of the rect to intersect with.
[in]	bottom1	The bottom of the rect to intersect with.

Returns

None.

IsEmpty()

FSDK.RectI.IsEmpty ( )

inline

Verify whether the rect is empty.

Returns

true means current rect is empty, while false means not.

Normalize()

FSDK.RectI.Normalize ( )

inline

Normalize the rect. Make sure left <= right, top <= bottom.

Returns

None.

Offset()

FSDK.RectI.Offset (   dx,   dy  )

inline

Shift the coordinates by delta value of x and y directions.

Parameters

[in]	dx	The delta value of x-direction.
[in]	dy	The delta value of y-direction.

Returns

None.

Union()

FSDK.RectI.Union (   other_rect )

inline

Union with a rect.

Parameters

[in]

other_rect

The rect to union with.

Returns

None.

Valid()

FSDK.RectI.Valid ( )

inline

Check if current rectangle is valid.

Returns

true means valid, while false means invalid.

Width()

FSDK.RectI.Width ( )

inline

Get the width of the rect.

Returns

The width of the rect.