kicad/3d-viewer/3d_rendering/3d_render_raytracing/shapes2D/bbox_2d.h

202 lines
5.2 KiB
C
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2015-2016 Mario Luzeiro <mrluzeiro@ua.pt>
2020-12-11 13:51:42 +00:00
* Copyright (C) 1992-2020 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
/**
* @file bbox_2d.h
* @brief 2D bounding box class definition.
*/
#ifndef _BBOX_2D_H_
#define _BBOX_2D_H_
#include <plugins/3dapi/xv3d_types.h> // SFVEC2F
struct RAY2D;
struct RAYSEG2D;
/**
2020-12-11 13:51:42 +00:00
* Manage a bounding box defined by two SFVEC2F min max points.
*/
struct BBOX_2D
{
public:
/**
2020-12-11 13:51:42 +00:00
* Create with default values a bounding box (not initialized).
*/
BBOX_2D();
/**
2020-12-11 13:51:42 +00:00
* Initialize a bounding box with a given point.
*
* @param aPbInit a point for the bounding box initialization.
*/
explicit BBOX_2D( const SFVEC2F& aPbInit );
/**
2020-12-11 13:51:42 +00:00
* Initialize a bounding box with a minimum and a maximum point.
*
* @param aPbMin the minimum point to initialize the bounding box.
* @param aPbMax the maximum point to initialize the bounding box.
*/
BBOX_2D( const SFVEC2F& aPbMin, const SFVEC2F& aPbMax );
~BBOX_2D();
/**
2020-12-11 13:51:42 +00:00
* Set bounding box with new parameters.
*
* @param aPbMin the minimum point to initialize the bounding box.
* @param aPbMax the maximum point to initialize the bounding box.
*/
void Set( const SFVEC2F& aPbMin, const SFVEC2F& aPbMax );
/**
2020-12-11 13:51:42 +00:00
* Set bounding box based on another bounding box.
*
* @param BBOX_2D a bounding box to initialize this one.
*/
void Set( const BBOX_2D& aBBox );
/**
2020-12-11 13:51:42 +00:00
* Recalculate the bounding box adding a point.
*
* @param aPoint the point to be bounded
*/
void Union( const SFVEC2F& aPoint );
/**
2020-12-11 13:51:42 +00:00
* Recalculate the bounding box adding other bounding box.
*
* @param aBBox the bounding box to be bounded.
*/
void Union( const BBOX_2D& aBBox );
/**
2020-12-11 13:51:42 +00:00
* Scale a bounding box by its center.
*
* @param aScale scale factor to apply
*/
void Scale( float aScale );
/**
2020-12-11 13:51:42 +00:00
* Scale a bounding box to the next float representation making it larger.
*/
void ScaleNextUp();
/**
2020-12-11 13:51:42 +00:00
* Scale a bounding box to the next float representation making it smaller.
*/
void ScaleNextDown();
/**
2020-12-11 13:51:42 +00:00
* Test if a bounding box intersects this box.
*
* @param aBBox the bounding box to check if it intersects.
*/
bool Intersects( const BBOX_2D& aBBox ) const;
/**
2020-12-11 13:51:42 +00:00
* Test if a circle intersects this box.
*
* @param aBBox the bounding box to check if it intersects.
*/
bool Intersects( const SFVEC2F& aCenter, float aRadiusSquared ) const;
/**
2020-12-11 13:51:42 +00:00
* Check is a point is inside this bounding box.
*
* @param aPoint point to test.
*/
bool Inside( const SFVEC2F& aPoint ) const;
/**
2020-12-11 13:51:42 +00:00
* Calculate the area of a bounding box.
*
* @return area of this bounding box.
*/
float Area() const;
/**
2020-12-11 13:51:42 +00:00
* Check if this bounding box is already initialized.
*
* @return True if it was initialized, otherwise false.
*/
bool IsInitialized() const;
/**
2020-12-11 13:51:42 +00:00
* Reset the bounding box to zero and uninitialize it.
*/
void Reset();
/**
2020-12-11 13:51:42 +00:00
* @return the position of the center of this bounding box.
*/
SFVEC2F GetCenter() const;
/**
* @return SFVEC2F - max-min
*/
SFVEC2F GetExtent() const;
/**
2020-12-11 13:51:42 +00:00
* @return the minimum vertex position.
*/
const SFVEC2F& Min() const { return m_min; }
/**
2020-12-11 13:51:42 +00:00
* @return the maximum vertex position.
*/
const SFVEC2F& Max() const { return m_max; }
/**
2020-12-11 13:51:42 +00:00
* @return the index of the max dimension (0=x, 1=y)
*/
unsigned int MaxDimension() const;
/**
* @return the surface area of the box.
*/
float Perimeter() const;
/**
* @param aRay is a ray to intersect the box.
* @param t is the distance point of the ray of the intersection (if true).
* @return true if the ray hits the box.
*/
bool Intersect( const RAY2D& aRay, float* t ) const;
bool Intersect( const RAY2D& aRay, float* aOutHitT0, float* aOutHitT1 ) const;
bool Intersect( const RAYSEG2D& aRaySeg ) const;
private:
SFVEC2F m_min; ///< point of the lower position of the bounding box
SFVEC2F m_max; ///< point of the higher position of the bounding box
};
#endif // bbox_2d.h