CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

csBox2 Class Reference
[Geometry utilities]

A bounding box in 2D space. More...

#include <box.h>

List of all members.

Public Methods

float MinX () const
 Get the minimum X value of the box.

float MinY () const
 Get the minimum Y value of the box.

float MaxX () const
 Get the maximum X value of the box.

float MaxY () const
 Get the maximum Y value of the box.

float Min (int idx) const
 Get Min component for 0 (x) or 1 (y).

float Max (int idx) const
 Get Max component for 0 (x) or 1 (y).

const csVector2Min () const
 Get the 2d vector of minimum (x, y) values.

const csVector2Max () const
 Get the 2d vector of maximum (x, y) values.

csVector2 GetCorner (int corner) const
 Return every corner of this bounding box from 0 to 3.

csVector2 GetCenter () const
 Get the center of this box.

void SetCenter (const csVector2 &c)
 Set the center of this box.

void SetSize (const csVector2 &s)
 Set the size of the box but keep the center intact.

void GetEdgeInfo (int edge, int &v1, int &v2) const
 Given an edge index (CS_BOX_EDGE_xy_Xy etc.) return the two vertices (index CS_BOX_CORNER_xy etc.).

csSegment2 GetEdge (int edge) const
 Return every edge (segment) of this bounding box from 0 to 7 (CS_BOX_EDGE_xy_Xy etc.).

void GetEdge (int edge, csSegment2 &e) const
 Return every edge (segment) of this bounding box from 0 to 7 (CS_BOX_EDGE_xy_Xy etc.).

bool Intersect (csVector2 *poly, int num_poly) const
 Test if a polygon if visible in the box.

bool In (float x, float y) const
 Test if the given coordinate is in this box.

bool In (const csVector2 &v) const
 Test if the given coordinate is in this box.

bool Overlap (const csBox2 &box) const
 Test if this box overlaps with the given box.

bool Contains (const csBox2 &box) const
 Test if this box contains the other box.

bool Empty () const
 Test if this box is empty.

float SquaredOriginDist () const
 Calculate the squared distance between (0,0) and the box This routine is extremely efficient.

float SquaredOriginMaxDist () const
 Calculate the squared distance between (0,0) and the point on the box which is furthest away from (0,0).

void StartBoundingBox ()
 Initialize this box to empty.

void StartBoundingBox (const csVector2 &v)
 Initialize this box to one vertex.

void StartBoundingBox (float x, float y)
 Same but given some coordinates.

void AddBoundingVertex (float x, float y)
 Add a new vertex and recalculate the bounding box.

void AddBoundingVertex (const csVector2 &v)
 Add a new vertex and recalculate the bounding box.

void AddBoundingVertexSmart (float x, float y)
 Add a new vertex and recalculate the bounding box.

void AddBoundingVertexSmart (const csVector2 &v)
 Add a new vertex and recalculate the bounding box.

bool AddBoundingVertexTest (float x, float y)
 Add a new vertex and recalculate the bounding box.

bool AddBoundingVertexTest (const csVector2 &v)
 Add a new vertex and recalculate the bounding box.

bool AddBoundingVertexSmartTest (float x, float y)
 Add a new vertex and recalculate the bounding box.

bool AddBoundingVertexSmartTest (const csVector2 &v)
 Add a new vertex and recalculate the bounding box.

 csBox2 ()
 Initialize this box to empty.

 csBox2 (const csVector2 &v)
 Initialize this box with one point.

 csBox2 (float x1, float y1, float x2, float y2)
 Initialize this box with the given values.

 csBox2 (const csRect &r)
 Initialize this box from the given csRect.

void Set (const csVector2 &bmin, const csVector2 &bmax)
 Sets the bounds of the box with the given values.

void Set (float x1, float y1, float x2, float y2)
 Sets the bounds of the box with the given values.

void SetMin (int idx, float val)
 Set Min component for 0 (x) or 1 (y).

void SetMax (int idx, float val)
 Set Max component for 0 (x) or 1 (y).

csBox2 & operator+= (const csBox2 &box)
 Compute the union of two bounding boxes.

csBox2 & operator+= (const csVector2 &point)
 Compute the union of a point with this bounding box.

csBox2 & operator *= (const csBox2 &box)
 Compute the intersection of two bounding boxes.

bool TestIntersect (const csBox2 &box) const
 Test if the two boxes have an intersection.


Static Public Methods

bool Intersect (float minx, float miny, float maxx, float maxy, csVector2 *poly, int num_poly)
 Test if a polygon if visible in the box.

bool Intersect (const csVector2 &minbox, const csVector2 &maxbox, csVector2 *poly, int num_poly)
 Test if a polygon if visible in the box.


Protected Attributes

csVector2 minbox
 The top-left coordinate of the bounding box.

csVector2 maxbox
 The bottom-right coordinate of the bounding box.


Friends

csBox2 operator+ (const csBox2 &box1, const csBox2 &box2)
 Compute the union of two bounding boxes.

csBox2 operator+ (const csBox2 &box, const csVector2 &point)
 Compute the union of a bounding box and a point.

csBox2 operator * (const csBox2 &box1, const csBox2 &box2)
 Compute the intersection of two bounding boxes.

bool operator== (const csBox2 &box1, const csBox2 &box2)
 Tests if two bounding boxes are equal.

bool operator!= (const csBox2 &box1, const csBox2 &box2)
 Tests if two bounding boxes are unequal.

bool operator< (const csBox2 &box1, const csBox2 &box2)
 Tests if box1 is a subset of box2.

bool operator> (const csBox2 &box1, const csBox2 &box2)
 Tests if box1 is a superset of box2.

bool operator< (const csVector2 &point, const csBox2 &box)
 Tests if a point is contained in a box.


Detailed Description

A bounding box in 2D space.

In order to operate correctly, this bounding box assumes that all values entered or compared against lie within the range (-CS_BOUNDINGBOX_MAXVALUE, CS_BOUNDINGBOX_MAXVALUE). It is not recommended to use points outside of this range.

Definition at line 92 of file box.h.


Constructor & Destructor Documentation

csBox2::csBox2   [inline]
 

Initialize this box to empty.

Definition at line 384 of file box.h.

References CS_BOUNDINGBOX_MAXVALUE.

csBox2::csBox2 const csVector2   v [inline]
 

Initialize this box with one point.

Definition at line 388 of file box.h.

csBox2::csBox2 float    x1,
float    y1,
float    x2,
float    y2
[inline]
 

Initialize this box with the given values.

Definition at line 391 of file box.h.

csBox2::csBox2 const csRect   r [inline]
 

Initialize this box from the given csRect.

Definition at line 396 of file box.h.


Member Function Documentation

void csBox2::AddBoundingVertex const csVector2   v [inline]
 

Add a new vertex and recalculate the bounding box.

Definition at line 293 of file box.h.

References csVector2::x, and csVector2::y.

void csBox2::AddBoundingVertex float    x,
float    y
[inline]
 

Add a new vertex and recalculate the bounding box.

Definition at line 286 of file box.h.

References csVector2::x, and csVector2::y.

void csBox2::AddBoundingVertexSmart const csVector2   v [inline]
 

Add a new vertex and recalculate the bounding box.

This version is a little more optimal. It assumes however that at least one point has been added to the bounding box.

Definition at line 314 of file box.h.

References csVector2::x, and csVector2::y.

void csBox2::AddBoundingVertexSmart float    x,
float    y
[inline]
 

Add a new vertex and recalculate the bounding box.

This version is a little more optimal. It assumes however that at least one point has been added to the bounding box.

Definition at line 303 of file box.h.

References csVector2::x, and csVector2::y.

bool csBox2::AddBoundingVertexSmartTest const csVector2   v [inline]
 

Add a new vertex and recalculate the bounding box.

This version is a little more optimal. It assumes however that at least one point has been added to the bounding box. Return true if the box was modified.

Definition at line 364 of file box.h.

References csVector2::x, and csVector2::y.

bool csBox2::AddBoundingVertexSmartTest float    x,
float    y
[inline]
 

Add a new vertex and recalculate the bounding box.

This version is a little more optimal. It assumes however that at least one point has been added to the bounding box. Return true if the box was modified.

Definition at line 348 of file box.h.

References csVector2::x, and csVector2::y.

bool csBox2::AddBoundingVertexTest const csVector2   v [inline]
 

Add a new vertex and recalculate the bounding box.

Return true if the box was modified.

Definition at line 337 of file box.h.

References csVector2::x, and csVector2::y.

bool csBox2::AddBoundingVertexTest float    x,
float    y
[inline]
 

Add a new vertex and recalculate the bounding box.

Return true if the box was modified.

Definition at line 323 of file box.h.

References csVector2::x, and csVector2::y.

bool csBox2::Contains const csBox2 &    box const [inline]
 

Test if this box contains the other box.

Definition at line 237 of file box.h.

References maxbox, minbox, csVector2::x, and csVector2::y.

bool csBox2::Empty   const [inline]
 

Test if this box is empty.

Definition at line 244 of file box.h.

References csVector2::x, and csVector2::y.

csVector2 csBox2::GetCenter   const [inline]
 

Get the center of this box.

Definition at line 140 of file box.h.

csVector2 csBox2::GetCorner int    corner const
 

Return every corner of this bounding box from 0 to 3.

This contrasts with Min() and Max() because those are only the min and max corners. Corner 0 = xy, 1 = xY, 2 = Xy, 3 = XY. Use CS_BOX_CORNER_xy etc. defines. CS_BOX_CENTER2 also works.

void csBox2::GetEdge int    edge,
csSegment2   e
const [inline]
 

Return every edge (segment) of this bounding box from 0 to 7 (CS_BOX_EDGE_xy_Xy etc.).

Definition at line 176 of file box.h.

References csSegment2::SetEnd(), and csSegment2::SetStart().

csSegment2 csBox2::GetEdge int    edge const [inline]
 

Return every edge (segment) of this bounding box from 0 to 7 (CS_BOX_EDGE_xy_Xy etc.).

Definition at line 167 of file box.h.

void csBox2::GetEdgeInfo int    edge,
int &    v1,
int &    v2
const [inline]
 

Given an edge index (CS_BOX_EDGE_xy_Xy etc.) return the two vertices (index CS_BOX_CORNER_xy etc.).

Definition at line 157 of file box.h.

bool csBox2::In const csVector2   v const [inline]
 

Test if the given coordinate is in this box.

Definition at line 223 of file box.h.

References csVector2::x, and csVector2::y.

bool csBox2::In float    x,
float    y
const [inline]
 

Test if the given coordinate is in this box.

Definition at line 215 of file box.h.

References csVector2::x, and csVector2::y.

bool csBox2::Intersect csVector2   poly,
int    num_poly
const [inline]
 

Test if a polygon if visible in the box.

This function does not test the case where the box is fully contained in the polygon. But all other cases are tested.

Definition at line 209 of file box.h.

bool csBox2::Intersect const csVector2   minbox,
const csVector2   maxbox,
csVector2   poly,
int    num_poly
[inline, static]
 

Test if a polygon if visible in the box.

This function does not test the case where the box is fully contained in the polygon. But all other cases are tested.

Definition at line 197 of file box.h.

References csVector2::x, and csVector2::y.

bool csBox2::Intersect float    minx,
float    miny,
float    maxx,
float    maxy,
csVector2   poly,
int    num_poly
[static]
 

Test if a polygon if visible in the box.

This function does not test the case where the box is fully contained in the polygon. But all other cases are tested.

const csVector2& csBox2::Max   const [inline]
 

Get the 2d vector of maximum (x, y) values.

Definition at line 125 of file box.h.

float csBox2::Max int    idx const [inline]
 

Get Max component for 0 (x) or 1 (y).

Definition at line 121 of file box.h.

References csVector2::x, and csVector2::y.

float csBox2::MaxX   const [inline]
 

Get the maximum X value of the box.

Definition at line 115 of file box.h.

References csVector2::x.

float csBox2::MaxY   const [inline]
 

Get the maximum Y value of the box.

Definition at line 117 of file box.h.

References csVector2::y.

const csVector2& csBox2::Min   const [inline]
 

Get the 2d vector of minimum (x, y) values.

Definition at line 123 of file box.h.

float csBox2::Min int    idx const [inline]
 

Get Min component for 0 (x) or 1 (y).

Definition at line 119 of file box.h.

References csVector2::x, and csVector2::y.

float csBox2::MinX   const [inline]
 

Get the minimum X value of the box.

Definition at line 111 of file box.h.

References csVector2::x.

float csBox2::MinY   const [inline]
 

Get the minimum Y value of the box.

Definition at line 113 of file box.h.

References csVector2::y.

csBox2& csBox2::operator *= const csBox2 &    box
 

Compute the intersection of two bounding boxes.

csBox2& csBox2::operator+= const csVector2   point
 

Compute the union of a point with this bounding box.

csBox2& csBox2::operator+= const csBox2 &    box
 

Compute the union of two bounding boxes.

bool csBox2::Overlap const csBox2 &    box const [inline]
 

Test if this box overlaps with the given box.

Definition at line 229 of file box.h.

References maxbox, minbox, csVector2::x, and csVector2::y.

void csBox2::Set float    x1,
float    y1,
float    x2,
float    y2
[inline]
 

Sets the bounds of the box with the given values.

Definition at line 407 of file box.h.

References csVector2::x, and csVector2::y.

void csBox2::Set const csVector2   bmin,
const csVector2   bmax
[inline]
 

Sets the bounds of the box with the given values.

Definition at line 400 of file box.h.

void csBox2::SetCenter const csVector2   c
 

Set the center of this box.

This will not change the size of the box but just relocate the center.

void csBox2::SetMax int    idx,
float    val
[inline]
 

Set Max component for 0 (x) or 1 (y).

Definition at line 421 of file box.h.

References csVector2::x, and csVector2::y.

void csBox2::SetMin int    idx,
float    val
[inline]
 

Set Min component for 0 (x) or 1 (y).

Definition at line 414 of file box.h.

References csVector2::x, and csVector2::y.

void csBox2::SetSize const csVector2   s
 

Set the size of the box but keep the center intact.

float csBox2::SquaredOriginDist  
 

Calculate the squared distance between (0,0) and the box This routine is extremely efficient.

float csBox2::SquaredOriginMaxDist  
 

Calculate the squared distance between (0,0) and the point on the box which is furthest away from (0,0).

This routine is extremely efficient.

void csBox2::StartBoundingBox float    x,
float    y
[inline]
 

Same but given some coordinates.

Definition at line 279 of file box.h.

References csVector2::x, and csVector2::y.

void csBox2::StartBoundingBox const csVector2   v [inline]
 

Initialize this box to one vertex.

Definition at line 272 of file box.h.

void csBox2::StartBoundingBox   [inline]
 

Initialize this box to empty.

Definition at line 265 of file box.h.

References CS_BOUNDINGBOX_MAXVALUE, csVector2::x, and csVector2::y.

bool csBox2::TestIntersect const csBox2 &    box const
 

Test if the two boxes have an intersection.


Friends And Related Function Documentation

csBox2 operator * const csBox2 &    box1,
const csBox2 &    box2
[friend]
 

Compute the intersection of two bounding boxes.

bool operator!= const csBox2 &    box1,
const csBox2 &    box2
[friend]
 

Tests if two bounding boxes are unequal.

csBox2 operator+ const csBox2 &    box,
const csVector2   point
[friend]
 

Compute the union of a bounding box and a point.

csBox2 operator+ const csBox2 &    box1,
const csBox2 &    box2
[friend]
 

Compute the union of two bounding boxes.

bool operator< const csVector2   point,
const csBox2 &    box
[friend]
 

Tests if a point is contained in a box.

bool operator< const csBox2 &    box1,
const csBox2 &    box2
[friend]
 

Tests if box1 is a subset of box2.

bool operator== const csBox2 &    box1,
const csBox2 &    box2
[friend]
 

Tests if two bounding boxes are equal.

bool operator> const csBox2 &    box1,
const csBox2 &    box2
[friend]
 

Tests if box1 is a superset of box2.


Member Data Documentation

csVector2 csBox2::maxbox [protected]
 

The bottom-right coordinate of the bounding box.

Definition at line 107 of file box.h.

Referenced by Contains(), and Overlap().

csVector2 csBox2::minbox [protected]
 

The top-left coordinate of the bounding box.

Definition at line 105 of file box.h.

Referenced by Contains(), and Overlap().


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18