haiku-website/static/legacy-docs/bebook/BRegion_Overview.html

31 lines
6.1 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>The Be Book - System Overview - The Interface Kit</title><link rel="stylesheet" href="be_book.css" type="text/css" media="all" /><link rel="shortcut icon" type="image/vnd.microsoft.icon" href="./images/favicon.ico" /><!--[if IE]>
<link rel="stylesheet" type="text/css" href="be_book_ie.css" />
<![endif]--><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /><meta name="keywords" content="Access, BeOS, BeBook, API" /><link rel="start" href="index.html" title="The Be Book" /><link rel="up" href="TheInterfaceKit_Overview.html" title="The Interface Kit" /><link rel="prev" href="BRect_Overview.html" title="BRect" /><link rel="next" href="BScreen_Overview.html" title="BScreen" /></head><body><div id="header"><div id="headerT"><div id="headerTL"><a accesskey="p" href="BRect_Overview.html" title="BRect"><img src="./images/navigation/prev.png" alt="Prev" /></a> <a accesskey="u" href="TheInterfaceKit_Overview.html" title="The Interface Kit"><img src="./images/navigation/up.png" alt="Up" /></a> <a accesskey="n" href="BScreen_Overview.html" title="BScreen"><img src="./images/navigation/next.png" alt="Next" /></a></div><div id="headerTR"><div id="navigpeople"><a href="http://www.haiku-os.org"><img src="./images/People_24.png" alt="haiku-os.org" title="Visit The Haiku Website" /></a></div><div class="navighome" title="Home"><a accesskey="h" href="index.html"><img src="./images/navigation/home.png" alt="Home" /></a></div><div class="navigboxed" id="navigindex"><a accesskey="i" href="ClassIndex.html" title="Index">I</a></div><div class="navigboxed" id="naviglang" title="English">en</div></div><div id="headerTC">The Be Book - System Overview - The Interface Kit</div></div><div id="headerB">Prev: <a href="BRect_Overview.html">BRect</a>  Up: <a href="TheInterfaceKit_Overview.html">The Interface Kit</a>  Next: <a href="BScreen_Overview.html">BScreen</a></div><hr /></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h2 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BRegion_Overview"></a>BRegion</h2></div></div></div><a id="id555325" class="indexterm"></a><p>
A <a class="link" href="BRegion.html" title="BRegion"><code class="classname">BRegion</code></a>
object comprises a set of rectangles in a two-dimensional
coordinate system. The rectangles needn't overlap; a single
<a class="link" href="BRegion.html" title="BRegion"><code class="classname">BRegion</code></a> can
contain a little rectangle way down there, a big one over yonder, and
another that lives somewhere to the left of Baden Baden.
</p><p>
You define and modify the contents of a region through to
<a class="link" href="BRegion.html#BRegion_Set" title="Set(), Include(), Exclude(), IntersectWith()"><code class="methodname">Set()</code></a>,
<a class="link" href="BRegion.html#BRegion_Include"><code class="methodname">Include()</code></a>,
<a class="link" href="BRegion.html#BRegion_Exclude"><code class="methodname">Exclude()</code></a>, and
<a class="link" href="BRegion.html#BRegion_IntersectWith"><code class="methodname">IntersectWith()</code></a>.
You can examine a region's rectangle's through
<a class="link" href="BRegion.html#BRegion_RectAt" title="RectAt(), CountRects()"><code class="methodname">RectAt()</code></a>,
but note that the object coalesces rectangles when it can, so the
rectangles that you retrieve may not match the ones that you passed in.
</p><div class="admonition warning"><div class="title">Warning</div><div class="graphic"><img class="icon" alt="Warning" width="32" src="./images/admonitions/Stop_32.png" /><div class="text"><p>The <a class="link" href="BRegion.html" title="BRegion"><code class="classname">BRegion</code></a>
class is designed to be used with coordinates with integral
values only; if any non-integral values are used in the
<a class="link" href="BRegion.html" title="BRegion"><code class="classname">BRegion</code></a>,
functions in the class may behave unpredictably.</p></div></div></div><p>
<a class="link" href="BRegion.html" title="BRegion"><code class="classname">BRegion</code></a> objects can be allocated on the stack.
</p></div><div id="footer"><hr /><div id="footerT">Prev: <a href="BRect_Overview.html">BRect</a>  Up: <a href="TheInterfaceKit_Overview.html">The Interface Kit</a>  Next: <a href="BScreen_Overview.html">BScreen</a> </div><div id="footerB"><div id="footerBL"><a href="BRect_Overview.html" title="BRect"><img src="./images/navigation/prev.png" alt="Prev" /></a> <a href="TheInterfaceKit_Overview.html" title="The Interface Kit"><img src="./images/navigation/up.png" alt="Up" /></a> <a href="BScreen_Overview.html" title="BScreen"><img src="./images/navigation/next.png" alt="Next" /></a></div><div id="footerBR"><div><a href="http://www.haiku-os.org"><img src="./images/People_24.png" alt="haiku-os.org" title="Visit The Haiku Website" /></a></div><div class="navighome" title="Home"><a accesskey="h" href="index.html"><img src="./images/navigation/home.png" alt="Home" /></a></div></div><div id="footerBC"><a href="http://www.access-company.com/home.html" title="ACCESS Co."><img alt="Access Company" src="./images/access_logo.png" /></a></div></div></div><div id="licenseFooter"><div id="licenseFooterBL"><a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/3.0/" title="Creative Commons License"><img alt="Creative Commons License" style="border-width:0" src="https://licensebuttons.net/l/by-nc-nd/3.0/88x31.png" /></a></div><div id="licenseFooterBR"><a href="./LegalNotice.html">Legal Notice</a></div><div id="licenseFooterBC"><span id="licenseText">This work is licensed under a
<a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/3.0/">Creative
Commons Attribution-Non commercial-No Derivative Works 3.0 License</a>.</span></div></div></body></html>