SAGA API: CSG_Rect Class Reference

SAGA API v9.6

#include <geo_tools.h>

Inheritance diagram for CSG_Rect:

Public Member Functions
	CSG_Rect (void)

	CSG_Rect (const CSG_Rect &Rect)

	CSG_Rect (const TSG_Rect &Rect)

	CSG_Rect (const CSG_Point &A, const CSG_Point &B)

	CSG_Rect (double xMin, double yMin, double xMax, double yMax)

	~CSG_Rect (void)

bool	Create (double xMin, double yMin, double xMax, double yMax)

bool	Create (const CSG_Point &A, const CSG_Point &B)

bool	Create (const CSG_Rect &Rect)

bool	operator== (const CSG_Rect &Rect) const

bool	operator!= (const CSG_Rect &Rect) const

CSG_Rect &	operator= (const CSG_Rect &Rect)

CSG_Rect &	operator+= (const CSG_Point &Point)

CSG_Rect &	operator-= (const CSG_Point &Point)

CSG_Rect &	Assign (double xMin, double yMin, double xMax, double yMax)

CSG_Rect &	Assign (const CSG_Point &A, const CSG_Point &B)

CSG_Rect &	Assign (const CSG_Rect &Rect)

CSG_Rect &	Set_BottomLeft (double x, double y)

CSG_Rect &	Set_BottomLeft (const CSG_Point &Point)

CSG_Rect &	Set_TopRight (double x, double y)

CSG_Rect &	Set_TopRight (const CSG_Point &Point)

double	Get_XMin (void) const

double	Get_XMax (void) const

double	Get_YMin (void) const

double	Get_YMax (void) const

double	Get_XRange (void) const

double	Get_YRange (void) const

double	Get_Area (void) const

double	Get_Diameter (void) const

CSG_Point	Get_TopLeft (void) const

CSG_Point	Get_BottomRight (void) const

CSG_Point	Get_Center (void) const

double	Get_XCenter (void) const

double	Get_YCenter (void) const

CSG_Rect &	Move (double dx, double dy)

CSG_Rect &	Move (const CSG_Point &Point)

CSG_Rect &	Inflate (double d, bool bPercent=true)

CSG_Rect &	Deflate (double d, bool bPercent=true)

CSG_Rect &	Inflate (double dx, double dy, bool bPercent=true)

CSG_Rect &	Deflate (double dx, double dy, bool bPercent=true)

CSG_Rect &	Union (double x, double y)

CSG_Rect &	Union (const CSG_Point &Point)

CSG_Rect &	Union (const CSG_Rect &Rect)

bool	Intersect (const CSG_Rect &Rect)

bool	is_Equal (double xMin, double yMin, double xMax, double yMax, double epsilon=0.) const

bool	is_Equal (const CSG_Rect &Rect, double epsilon=0.) const

bool	Contains (double x, double y) const

bool	Contains (const CSG_Point &Point) const

TSG_Intersection	Intersects (const CSG_Rect &Rect) const

Additional Inherited Members
Public Attributes inherited from SSG_Rect
double	xMin

double	yMin

double	xMax

double	yMax

Detailed Description

Definition at line 470 of file geo_tools.h.

Constructor & Destructor Documentation

◆ CSG_Rect() [1/5]

CSG_Rect::CSG_Rect ( void )

Definition at line 663 of file geo_classes.cpp.

References Assign().

◆ CSG_Rect() [2/5]

CSG_Rect::CSG_Rect ( const CSG_Rect & Rect )

Definition at line 668 of file geo_classes.cpp.

References Assign(), SSG_Rect::xMax, SSG_Rect::xMin, SSG_Rect::yMax, and SSG_Rect::yMin.

◆ CSG_Rect() [3/5]

CSG_Rect::CSG_Rect ( const TSG_Rect & Rect )

Definition at line 673 of file geo_classes.cpp.

References Assign(), SSG_Rect::xMax, SSG_Rect::xMin, SSG_Rect::yMax, and SSG_Rect::yMin.

◆ CSG_Rect() [4/5]

CSG_Rect::CSG_Rect	(	const CSG_Point &	A,
		const CSG_Point &	B
	)

Definition at line 678 of file geo_classes.cpp.

References A, Assign(), and B.

◆ CSG_Rect() [5/5]

CSG_Rect::CSG_Rect	(	double	xMin,
		double	yMin,
		double	xMax,
		double	yMax
	)

Definition at line 683 of file geo_classes.cpp.

References Assign(), SSG_Rect::xMax, SSG_Rect::xMin, SSG_Rect::yMax, and SSG_Rect::yMin.

◆ ~CSG_Rect()

CSG_Rect::~CSG_Rect ( void )

Definition at line 689 of file geo_classes.cpp.

Member Function Documentation

◆ Assign() [1/3]

CSG_Rect & CSG_Rect::Assign	(	const CSG_Point &	A,
		const CSG_Point &	B
	)

Definition at line 734 of file geo_classes.cpp.

References A, B, and Create().

◆ Assign() [2/3]

CSG_Rect & CSG_Rect::Assign ( const CSG_Rect & Rect )

Definition at line 741 of file geo_classes.cpp.

References Create(), SSG_Rect::xMax, SSG_Rect::xMin, SSG_Rect::yMax, and SSG_Rect::yMin.

◆ Assign() [3/3]

CSG_Rect & CSG_Rect::Assign	(	double	xMin,
		double	yMin,
		double	xMax,
		double	yMax
	)

Definition at line 727 of file geo_classes.cpp.

References Create(), SSG_Rect::xMax, SSG_Rect::xMin, SSG_Rect::yMax, and SSG_Rect::yMin.

Referenced by CSG_TIN::_Triangulate(), CSG_Shape_Part::_Update_Extent(), CSG_Rect(), CSG_Shape_Point::Get_Extent(), CSG_PointCloud::Get_Selection_Extent(), CSG_Shapes::Get_Selection_Extent(), Inflate(), CSG_PointCloud::On_Update(), CSG_Shapes::On_Update(), CSG_TIN::On_Update(), Set_BottomLeft(), CSG_PRQuadTree_Item::Set_Extent(), and Set_TopRight().

◆ Contains() [1/2]

bool CSG_Rect::Contains ( const CSG_Point & Point ) const

Definition at line 875 of file geo_classes.cpp.

References Contains(), SSG_Point::x, and SSG_Point::y.

◆ Contains() [2/2]

bool CSG_Rect::Contains	(	double	x,
		double	y
	)		const

Definition at line 870 of file geo_classes.cpp.

References SSG_Rect::xMax, SSG_Rect::xMin, SSG_Rect::yMax, and SSG_Rect::yMin.

Referenced by Contains(), CSG_PointCloud::Get_Shape(), CSG_Grid::Get_Value(), Intersects(), and CSG_TIN_Triangle::is_Containing().

◆ Create() [1/3]

bool CSG_Rect::Create	(	const CSG_Point &	A,
		const CSG_Point &	B
	)

Definition at line 710 of file geo_classes.cpp.

References A, B, and Create().

◆ Create() [2/3]

bool CSG_Rect::Create ( const CSG_Rect & Rect )

Definition at line 716 of file geo_classes.cpp.

References SSG_Rect::xMax, SSG_Rect::xMin, SSG_Rect::yMax, and SSG_Rect::yMin.

◆ Create() [3/3]

bool CSG_Rect::Create	(	double	xMin,
		double	yMin,
		double	xMax,
		double	yMax
	)

Definition at line 698 of file geo_classes.cpp.

References SSG_Rect::xMax, SSG_Rect::xMin, SSG_Rect::yMax, and SSG_Rect::yMin.

Referenced by Assign(), Create(), and CSG_Grid_System::Destroy().

◆ Deflate() [1/2]

CSG_Rect & CSG_Rect::Deflate	(	double	d,
		bool	bPercent = `true`
	)

Definition at line 818 of file geo_classes.cpp.

Referenced by CSG_Parameters_Grid_Target::Get_System().

◆ Deflate() [2/2]

CSG_Rect & CSG_Rect::Deflate	(	double	dx,
		double	dy,
		bool	bPercent = `true`
	)

Definition at line 813 of file geo_classes.cpp.

References Inflate().

◆ Get_Area()

double CSG_Rect::Get_Area ( void ) const

inline

Definition at line 510 of file geo_tools.h.

Referenced by CSG_Parameters_Point_Search::On_Parameter_Changed(), and CSG_Parameters_Grid_Target::Set_User_Defined().

◆ Get_BottomRight()

CSG_Point CSG_Rect::Get_BottomRight ( void ) const

inline

Definition at line 514 of file geo_tools.h.

◆ Get_Center()

CSG_Point CSG_Rect::Get_Center ( void ) const

inline

Definition at line 516 of file geo_tools.h.

Referenced by CSG_Grid_System::Create().

◆ Get_Diameter()

double CSG_Rect::Get_Diameter ( void ) const

inline

Definition at line 511 of file geo_tools.h.

◆ Get_TopLeft()

CSG_Point CSG_Rect::Get_TopLeft ( void ) const

inline

Definition at line 513 of file geo_tools.h.

◆ Get_XCenter()

double CSG_Rect::Get_XCenter ( void ) const

inline

Definition at line 517 of file geo_tools.h.

Referenced by CSG_TIN::_Triangulate(), CSG_Shape_Polygon_Part::_Update_Area(), CSG_PRQuadTree::Create(), CSG_PRQuadTree_Item::Set_Extent(), and CSG_Parameters_Grid_Target::Set_User_Defined().

◆ Get_XMax()

double CSG_Rect::Get_XMax ( void ) const

inline

Definition at line 503 of file geo_tools.h.

Referenced by CSG_Parameter_Grid_System::_Serialize(), CSG_Grid::Get_Histogram(), CSG_Grids::Get_Histogram(), CSG_Grid::Get_Statistics(), CSG_Grids::Get_Statistics(), Intersect(), Intersects(), CSG_PRQuadTree_Item::Set_Extent(), CSG_Parameters_Grid_Target::Set_User_Defined(), and Union().

◆ Get_XMin()

double CSG_Rect::Get_XMin ( void ) const

inline

Definition at line 502 of file geo_tools.h.

Referenced by CSG_Parameter_Grid_System::_Serialize(), CSG_Grid_System::Create(), CSG_Grid::Get_Histogram(), CSG_Grids::Get_Histogram(), CSG_Grid::Get_Statistics(), CSG_Grids::Get_Statistics(), Intersect(), Intersects(), CSG_PRQuadTree_Item::Set_Extent(), CSG_Parameters_Grid_Target::Set_User_Defined(), and Union().

◆ Get_XRange()

double CSG_Rect::Get_XRange ( void ) const

inline

Definition at line 507 of file geo_tools.h.

Referenced by CSG_TIN::_Triangulate(), CSG_PRQuadTree::Create(), CSG_Grid_System::Create(), Inflate(), and CSG_Parameters_Grid_Target::Set_User_Defined().

◆ Get_YCenter()

double CSG_Rect::Get_YCenter ( void ) const

inline

Definition at line 518 of file geo_tools.h.

Referenced by CSG_TIN::_Triangulate(), CSG_Shape_Polygon_Part::_Update_Area(), CSG_PRQuadTree::Create(), CSG_PRQuadTree_Item::Set_Extent(), and CSG_Parameters_Grid_Target::Set_User_Defined().

◆ Get_YMax()

double CSG_Rect::Get_YMax ( void ) const

inline

Definition at line 505 of file geo_tools.h.

Referenced by CSG_Parameter_Grid_System::_Serialize(), CSG_Grid::Get_Histogram(), CSG_Grids::Get_Histogram(), CSG_Grid::Get_Statistics(), CSG_Grids::Get_Statistics(), Intersect(), Intersects(), CSG_TIN_Triangle::is_Containing(), CSG_PRQuadTree_Item::Set_Extent(), CSG_Parameters_Grid_Target::Set_User_Defined(), and Union().

◆ Get_YMin()

double CSG_Rect::Get_YMin ( void ) const

inline

Definition at line 504 of file geo_tools.h.

Referenced by CSG_Parameter_Grid_System::_Serialize(), CSG_Grid_System::Create(), CSG_Grid::Get_Histogram(), CSG_Grids::Get_Histogram(), CSG_Grid::Get_Statistics(), CSG_Grids::Get_Statistics(), Intersect(), Intersects(), CSG_TIN_Triangle::is_Containing(), CSG_PRQuadTree_Item::Set_Extent(), CSG_Parameters_Grid_Target::Set_User_Defined(), and Union().

◆ Get_YRange()

double CSG_Rect::Get_YRange ( void ) const

inline

Definition at line 508 of file geo_tools.h.

Referenced by CSG_TIN::_Triangulate(), CSG_PRQuadTree::Create(), CSG_Grid_System::Create(), Inflate(), and CSG_Parameters_Grid_Target::Set_User_Defined().

◆ Inflate() [1/2]

CSG_Rect & CSG_Rect::Inflate	(	double	d,
		bool	bPercent = `true`
	)

Definition at line 808 of file geo_classes.cpp.

Referenced by CSG_Grid_System::Create(), Deflate(), CSG_Parameters_Grid_Target::Set_User_Defined(), and SG_Shape_Get_Offset().

◆ Inflate() [2/2]

CSG_Rect & CSG_Rect::Inflate	(	double	dx,
		double	dy,
		bool	bPercent = `true`
	)

Definition at line 792 of file geo_classes.cpp.

References Assign(), Get_XRange(), Get_YRange(), SSG_Rect::xMax, SSG_Rect::xMin, SSG_Rect::yMax, and SSG_Rect::yMin.

◆ Intersect()

bool CSG_Rect::Intersect ( const CSG_Rect & Rect )

Definition at line 910 of file geo_classes.cpp.

References Get_XMax(), Get_XMin(), Get_YMax(), Get_YMin(), INTERSECTION_Contained, INTERSECTION_Contains, INTERSECTION_Identical, INTERSECTION_None, INTERSECTION_Overlaps, Intersects(), SSG_Rect::xMax, SSG_Rect::xMin, SSG_Rect::yMax, and SSG_Rect::yMin.

◆ Intersects()

TSG_Intersection CSG_Rect::Intersects ( const CSG_Rect & Rect ) const

Definition at line 881 of file geo_classes.cpp.

References Contains(), Get_XMax(), Get_XMin(), Get_YMax(), Get_YMin(), INTERSECTION_Contained, INTERSECTION_Contains, INTERSECTION_Identical, INTERSECTION_None, INTERSECTION_Overlaps, is_Equal(), SSG_Rect::xMax, SSG_Rect::xMin, SSG_Rect::yMax, and SSG_Rect::yMin.

Referenced by CSG_PointCloud::Get_Shape(), CSG_Shapes::Get_Shape(), Intersect(), CSG_Shape::Intersects(), CSG_Shape_Line::On_Intersects(), and CSG_Shape_Polygon::On_Intersects().

◆ is_Equal() [1/2]

bool CSG_Rect::is_Equal	(	const CSG_Rect &	Rect,
		double	epsilon = `0.`
	)		const

Definition at line 864 of file geo_classes.cpp.

References is_Equal(), SSG_Rect::xMax, SSG_Rect::xMin, SSG_Rect::yMax, and SSG_Rect::yMin.

◆ is_Equal() [2/2]

bool CSG_Rect::is_Equal	(	double	xMin,
		double	yMin,
		double	xMax,
		double	yMax,
		double	epsilon = `0.`
	)		const

Definition at line 858 of file geo_classes.cpp.

References SG_Is_Equal(), SSG_Rect::xMax, SSG_Rect::xMin, SSG_Rect::yMax, and SSG_Rect::yMin.

Referenced by Intersects(), and is_Equal().

◆ Move() [1/2]

CSG_Rect & CSG_Rect::Move ( const CSG_Point & Point )

Definition at line 786 of file geo_classes.cpp.

References Move(), SSG_Point::x, and SSG_Point::y.

◆ Move() [2/2]

CSG_Rect & CSG_Rect::Move	(	double	dx,
		double	dy
	)

Definition at line 778 of file geo_classes.cpp.

References SSG_Rect::xMax, SSG_Rect::xMin, SSG_Rect::yMax, and SSG_Rect::yMin.

Referenced by Move().

◆ operator!=()

bool CSG_Rect::operator!= ( const CSG_Rect & Rect ) const

inline

Definition at line 486 of file geo_tools.h.

◆ operator+=()

CSG_Rect& CSG_Rect::operator+= ( const CSG_Point & Point )

inline

Definition at line 490 of file geo_tools.h.

References SSG_Point::x, and SSG_Point::y.

◆ operator-=()

CSG_Rect& CSG_Rect::operator-= ( const CSG_Point & Point )

inline

Definition at line 491 of file geo_tools.h.

References SSG_Point::x, and SSG_Point::y.

◆ operator=()

CSG_Rect& CSG_Rect::operator= ( const CSG_Rect & Rect )

inline

Definition at line 488 of file geo_tools.h.

◆ operator==()

bool CSG_Rect::operator== ( const CSG_Rect & Rect ) const

inline

Definition at line 485 of file geo_tools.h.

◆ Set_BottomLeft() [1/2]

CSG_Rect & CSG_Rect::Set_BottomLeft ( const CSG_Point & Point )

Definition at line 756 of file geo_classes.cpp.

References Set_BottomLeft(), SSG_Point::x, and SSG_Point::y.

◆ Set_BottomLeft() [2/2]

CSG_Rect & CSG_Rect::Set_BottomLeft	(	double	x,
		double	y
	)

Definition at line 749 of file geo_classes.cpp.

References Assign(), SSG_Rect::xMax, and SSG_Rect::yMax.

Referenced by Set_BottomLeft().

◆ Set_TopRight() [1/2]

CSG_Rect & CSG_Rect::Set_TopRight ( const CSG_Point & Point )

Definition at line 770 of file geo_classes.cpp.

References Set_TopRight(), SSG_Point::x, and SSG_Point::y.

◆ Set_TopRight() [2/2]

CSG_Rect & CSG_Rect::Set_TopRight	(	double	x,
		double	y
	)

Definition at line 763 of file geo_classes.cpp.

References Assign(), SSG_Rect::xMin, and SSG_Rect::yMin.

Referenced by Set_TopRight().

◆ Union() [1/3]

CSG_Rect & CSG_Rect::Union ( const CSG_Point & Point )

Definition at line 833 of file geo_classes.cpp.

References SSG_Point::x, SSG_Rect::xMax, SSG_Rect::xMin, SSG_Point::y, SSG_Rect::yMax, and SSG_Rect::yMin.

◆ Union() [2/3]

CSG_Rect & CSG_Rect::Union ( const CSG_Rect & Rect )

Definition at line 842 of file geo_classes.cpp.

References Get_XMax(), Get_XMin(), Get_YMax(), Get_YMin(), SSG_Rect::xMax, SSG_Rect::xMin, SSG_Rect::yMax, and SSG_Rect::yMin.

◆ Union() [3/3]

CSG_Rect & CSG_Rect::Union	(	double	x,
		double	y
	)

Definition at line 824 of file geo_classes.cpp.

References SSG_Rect::xMax, SSG_Rect::xMin, SSG_Rect::yMax, and SSG_Rect::yMin.

Referenced by _SG_Polygon_Clip(), CSG_TIN::_Triangulate(), CSG_Shape_Points::_Update_Extent(), CSG_Shapes::Get_Selection_Extent(), CSG_Shapes::On_Update(), and CSG_TIN::On_Update().

The documentation for this class was generated from the following files:

CSG_Rect
Generated on Mon Sep 23 2024 14:13:05 for SAGA API by 1.8.19