BRect.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

#include <UI\UIFramework.h>

#include <UI\Core\BSize.h>
#include <UI\Core\BPoint.h>

#include <Geom\IntegerTypes\BSIRect.h>

BEGIN_BENTLEY_UIFRAMEWORK_NAMESPACE

//=======================================================================================
//=======================================================================================
class DLLEXPORT BRect : public BSIRect
    {
    public:
        BRect ();
        BRect (const BPoint &topleft, const BPoint &bottomright);
        BRect (const BPoint &topleft, const BSize &size);
        BRect (int left, int top, int width, int height);

        bool IsNull () const;
        bool IsEmpty () const;
        bool IsValid () const;

        BRect Normalized () const;

        int X () const;
        int Y () const;

        void SetX (int x);
        void SetY (int y);
        void SetLeft (int pos);
        void SetTop (int pos);
        void SetRight (int pos);
        void SetBottom (int pos);

        void SetTopLeft (const BPoint &p);
        void SetBottomRight (const BPoint &p);
        void SetTopRight (const BPoint &p);
        void SetBottomLeft (const BPoint &p);

        BPoint TopLeft () const;
        BPoint BottomRight () const;
        BPoint TopRight () const;
        BPoint BottomLeft () const;
        BPoint Center () const;

        BSize Size () const;
        void SetWidth (int w);
        void SetHeight (int h);
        void SetSize (const BSize &s);

        void MoveLeft (int pos);
        void MoveTop (int pos);
        void MoveRight (int pos);
        void MoveBottom (int pos);
        void MoveTopLeft (const BPoint &p);
        void MoveBottomRight (const BPoint &p);
        void MoveTopRight (const BPoint &p);
        void MoveBottomLeft (const BPoint &p);
        void MoveCenter (const BPoint &p);

        void MoveTo (int x, int y);
        void MoveTo (const BPoint &p);

        void Translate (int dx, int dy);

        void Translate (const BPoint &p);

        BRect Translated (int dx, int dy) const;

        BRect Translated (const BPoint &p) const;

        void SetRect (int x, int y, int w, int h);
        void GetRect (int *x, int *y, int *w, int *h) const;

        void SetCoords (int ox, int oy, int cx, int cy);
        void GetCoords (int *ox, int *oy, int *cx, int *cy) const;

        void Adjust (int ox, int oy, int cx, int cy);
        BRect Adjusted (int ox, int oy, int cx, int cy) const;

        bool Contains (const BPoint &p, bool proper = false) const;
        bool Contains (int x, int y, bool proper = false) const;
        bool Contains (const BRect &r, bool proper = false) const;

        BRect Unite (const BRect &r) const;
        BRect United (const BRect &other) const;

        BRect Intersect (const BRect &r) const;
        BRect Intersected (const BRect &other) const;
        bool Intersects (const BRect &r) const;

        BRect operator | (const BRect &r) const;
        BRect operator & (const BRect &r) const;
        BRect& operator |= (const BRect &r);
        BRect& operator &= (const BRect &r);

        friend bool operator == (const BRect &, const BRect &);
        friend bool operator != (const BRect &, const BRect &);
    };

/*****************************************************************************
 BRect inline friend operators
 *****************************************************************************/

inline bool operator == (const BRect &r1, const BRect &r2)
    {
    return r1.TopLeft () == r2.TopLeft () && r1.BottomRight () == r2.BottomRight ();
    }

inline bool operator != (const BRect &r1, const BRect &r2)
    {
    return r1.TopLeft () != r2.TopLeft () || r1.BottomRight () != r2.BottomRight ();
    }

END_BENTLEY_UIFRAMEWORK_NAMESPACE