legato_rect.h

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2020 Microchip Technology Inc. and its subsidiaries.
*
* Subject to your compliance with these terms, you may use Microchip software
* and any derivatives exclusively with Microchip products. It is your
* responsibility to comply with third party license terms applicable to your
* use of third party software (including open source software) that may
* accompany Microchip software.
*
* THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER
* EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED
* WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A
* PARTICULAR PURPOSE.
*
* IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
* INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
* WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS
* BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE
* FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN
* ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY,
* THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
*******************************************************************************/

/*******************************************************************************
 Module for Microchip Graphics Library - Legato User Interface Library

  Company:
    Microchip Technology Inc.

  File Name:
    legato_rect.h

  Summary:
    Defines general purposes rectangle functions.

  Description:
    Rectangle management functions.
*******************************************************************************/

#ifndef LE_RECT_H
#define LE_RECT_H

#include "gfx/legato/common/legato_common.h"

#ifdef __cplusplus
extern "C" {
#endif

// *****************************************************************************
// *****************************************************************************
// Section: Routines
// *****************************************************************************
// *****************************************************************************

// *****************************************************************************
leBool leRectContainsPoint(const leRect* rect, const lePoint* point);

// *****************************************************************************
leBool leRectContainsRect(const leRect* l_rect, const leRect* r_rect);

// *****************************************************************************
leBool leRectIntersects(const leRect* l_rect, const leRect* r_rect);

// *****************************************************************************
void leRectCombine(const leRect* l_rect,
                   const leRect* r_rect,
                   leRect* res);

// *****************************************************************************
void leRectClip(const leRect* l_rect,
                const leRect* r_rect,
                leRect* result);

// *****************************************************************************
/* Function:
    leRect leRectClipAdj(const leRect* l_rect,
                         const leRect* r_rect, 
                         leRect* adj)

  Summary:
    Returns the rectangle clipped using r_rect, and also adjusts the third rectangle

  Parameters:
    const leRect* l_rect - the subject rectangle
    const leRect* r_rect - the object rectangle
    leRect* adj - the adjust rectangle
    
  Returns:
    void
    
  Remarks:
    result will equals l_rect if the rectangles aren't intersecting
    
*/
void leRectClipAdj(const leRect* l_rect,
                   const leRect* r_rect,
                   leRect* adj,
                   leRect* res);

// *****************************************************************************                 
void leRectFromPoints(const lePoint* p1,
                      const lePoint* p2,
                      leRect* res);

// *****************************************************************************
void leRectToPoints(const leRect* rect,
                    lePoint* p1,
                    lePoint* p2);

// *****************************************************************************
uint32_t leRectSplit(const leRect* sub,
                     const leRect* obj,
                     leRect res[4]);

// *****************************************************************************
int32_t leRectCompare(const leRect* l,
                      const leRect* r);

// *****************************************************************************
leBool leRectsAreSimilar(const leRect* l,
                         const leRect* r);
static const leRect leRect_Zero = {0, 0, 0, 0};
#ifdef __cplusplus
}
#endif

#endif /* LE_RECT_H */