C4LArea Class Reference

#include <C4Sector.h>

Collaboration diagram for C4LArea:

Public Member Functions
	C4LArea ()
	C4LArea (C4LSectors *pSectors, int ix, int iy, int iwdt, int ihgt)
	C4LArea (C4LSectors *pSectors, const C4Rect &rect)
	C4LArea (C4LSectors *pSectors, C4Object *pObj)
void	Clear ()
bool	operator== (const C4LArea &Area) const
bool	IsNull () const
void	Set (C4LSectors *pSectors, const C4Rect &rect)
void	Set (C4LSectors *pSectors, C4Object *pObj)
C4LSector *	First () const
C4LSector *	Next (C4LSector *pPrev) const
bool	Contains (C4LSector *pSct) const
C4ObjectList *	FirstObjects (C4LSector **ppSct)
C4ObjectList *	NextObjects (C4ObjectList *pPrev, C4LSector **ppSct)
C4ObjectList *	FirstObjectShapes (C4LSector **ppSct)
C4ObjectList *	NextObjectShapes (C4ObjectList *pPrev, C4LSector **ppSct)
void	DebugRec (class C4Object *pObj, char cMarker)

Public Attributes
C4LSector *	pFirst
int	xL
int	yL
int	dpitch
C4LSector *	pOut

Detailed Description

Definition at line 86 of file C4Sector.h.

Constructor & Destructor Documentation

C4LArea() [1/4]

C4LArea::C4LArea ( )

inline

Definition at line 93 of file C4Sector.h.

{ Clear(); } // default constructor

References Clear().

Here is the call graph for this function:

C4LArea() [2/4]

C4LArea::C4LArea ( C4LSectors *  pSectors, int  ix, int  iy, int  iwdt, int  ihgt  )

inline

Definition at line 94 of file C4Sector.h.

    { Set(pSectors, C4Rect(ix, iy, iwdt, ihgt)); }

References Set().

Here is the call graph for this function:

C4LArea() [3/4]

C4LArea::C4LArea ( C4LSectors *  pSectors, const C4Rect &  rect  )

inline

Definition at line 96 of file C4Sector.h.

    { Set(pSectors, rect); }

References Set().

Here is the call graph for this function:

C4LArea() [4/4]

C4LArea::C4LArea ( C4LSectors *  pSectors, C4Object *  pObj  )

inline

Definition at line 99 of file C4Sector.h.

    { Set(pSectors, pObj); }

References Set().

Here is the call graph for this function:

Member Function Documentation

Clear()

void C4LArea::Clear ( )

inline

Definition at line 102 of file C4Sector.h.

{ pFirst=pOut=nullptr; } // zero sector

References pFirst, and pOut.

Referenced by C4LArea().

Here is the caller graph for this function:

Contains()

bool C4LArea::Contains

(

C4LSector *

pSct

)

const

Definition at line 291 of file C4Sector.cpp.

{
    assert(pSct);
    // no area
    if (!pFirst) return false;
    // outside?
    if (pSct == pOut) return true;
    if (pFirst == pOut) return false;
    // check bounds
    return (pSct->x>=pFirst->x && pSct->y>=pFirst->y && pSct->x<=xL && pSct->y<=yL);
}

References pFirst, pOut, C4LSector::x, xL, C4LSector::y, and yL.

Referenced by C4LSectors::Update().

Here is the caller graph for this function:

DebugRec()

void C4LArea::DebugRec	(	class C4Object *	pObj,
		char	cMarker
	)

Definition at line 331 of file C4Sector.cpp.

{
    C4RCArea rc;
    rc.op = cMarker;
    rc.obj = pObj ? pObj->Number : -1;
    rc.x1 = pFirst ? pFirst->x : -1;
    rc.y1 = pFirst ? pFirst->x /* 2do: y */ : -1;
    rc.xL = xL;
    rc.yL = yL;
    rc.dpitch = dpitch;
    rc.out = !!pOut;
    AddDbgRec(RCT_Area, &rc, sizeof(C4RCArea));
}

References AddDbgRec(), C4RCArea::dpitch, dpitch, C4PropListNumbered::Number, C4RCArea::obj, C4RCArea::op, C4RCArea::out, pFirst, pOut, RCT_Area, C4LSector::x, C4RCArea::x1, C4RCArea::xL, xL, C4RCArea::y1, C4RCArea::yL, and yL.

Referenced by C4LSectors::Add(), C4LSectors::Remove(), and C4LSectors::Update().

Here is the call graph for this function:

Here is the caller graph for this function:

First()

C4LSector* C4LArea::First ( ) const

inline

Definition at line 111 of file C4Sector.h.

{ return pFirst; } // get first sector

References pFirst.

Referenced by C4LSectors::Add(), NextObjects(), NextObjectShapes(), C4LSectors::Remove(), and C4LSectors::Update().

Here is the caller graph for this function:

FirstObjects()

C4ObjectList* C4LArea::FirstObjects ( C4LSector **  ppSct )

inline

Definition at line 118 of file C4Sector.h.

    { *ppSct=nullptr; return NextObjects(nullptr, ppSct); }

References NextObjects().

Referenced by C4FindObject::Count(), C4GameObjects::CrossCheck(), C4FindObject::Find(), and C4FindObject::FindMany().

Here is the call graph for this function:

Here is the caller graph for this function:

FirstObjectShapes()

C4ObjectList* C4LArea::FirstObjectShapes ( C4LSector **  ppSct )

inline

Definition at line 122 of file C4Sector.h.

    { *ppSct=nullptr; return NextObjectShapes(nullptr, ppSct); }

References NextObjectShapes().

Referenced by C4FindObject::Count(), C4FindObject::Find(), C4Game::FindConstuctionSiteBlock(), C4FindObject::FindMany(), and C4SolidMask::Remove().

Here is the call graph for this function:

Here is the caller graph for this function:

IsNull()

bool C4LArea::IsNull ( ) const

inline

Definition at line 106 of file C4Sector.h.

{ return !pFirst; }

References pFirst.

Referenced by C4LSectors::Update().

Here is the caller graph for this function:

Next()

C4LSector * C4LArea::Next

(

C4LSector *

pPrev

)

const

Definition at line 276 of file C4Sector.cpp.

{
    // the outside-sector is the last sector that is returned
    if (pPrev == pOut)
        return nullptr;
    // within one line?
    if (pPrev->x<xL)
        return pPrev+1;
    // within the area?
    if (pPrev->y<yL)
        return pPrev+dpitch;
    // end reached - return outside-sector if applicable
    return pOut;
}

References dpitch, pOut, C4LSector::x, xL, C4LSector::y, and yL.

Referenced by C4LSectors::Add(), C4FindObject::Count(), C4FindObject::FindMany(), NextObjects(), NextObjectShapes(), C4LSectors::Remove(), and C4LSectors::Update().

Here is the caller graph for this function:

NextObjects()

C4ObjectList * C4LArea::NextObjects	(	C4ObjectList *	pPrev,
		C4LSector **	ppSct
	)

Definition at line 303 of file C4Sector.cpp.

{
    // get next sector
    if (!*ppSct)
        *ppSct = First();
    else
        *ppSct = Next(*ppSct);
    // nothing left?
    if (!*ppSct)
        return nullptr;
    // return object list
    return &(*ppSct)->Objects;
}

References First(), and Next().

Referenced by C4FindObject::Count(), C4GameObjects::CrossCheck(), C4FindObject::Find(), C4FindObject::FindMany(), and FirstObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

NextObjectShapes()

C4ObjectList * C4LArea::NextObjectShapes	(	C4ObjectList *	pPrev,
		C4LSector **	ppSct
	)

Definition at line 317 of file C4Sector.cpp.

{
    // get next sector
    if (!*ppSct)
        *ppSct = First();
    else
        *ppSct = Next(*ppSct);
    // nothing left?
    if (!*ppSct)
        return nullptr;
    // return object list
    return &(*ppSct)->ObjectShapes;
}

References First(), and Next().

Referenced by C4FindObject::Count(), C4FindObject::Find(), C4Game::FindConstuctionSiteBlock(), C4FindObject::FindMany(), FirstObjectShapes(), and C4SolidMask::Remove().

Here is the call graph for this function:

Here is the caller graph for this function:

operator==()

bool C4LArea::operator==

(

const C4LArea &

Area

)

const

Definition at line 236 of file C4Sector.cpp.

{
    return pFirst == Area.pFirst &&
           xL == Area.xL &&
           yL == Area.yL &&
           pOut == Area.pOut;
}

References pFirst, pOut, xL, and yL.

Set() [1/2]

void C4LArea::Set	(	C4LSectors *	pSectors,
		C4Object *	pObj
	)

Definition at line 270 of file C4Sector.cpp.

{
    // set to object facet rect
    Set(pSectors, C4Rect(pObj->Left(), pObj->Top(), pObj->Width(), pObj->Height()));
}

References C4Object::Height(), C4Object::Left(), Set(), C4Object::Top(), and C4Object::Width().

Here is the call graph for this function:

Set() [2/2]

void C4LArea::Set	(	C4LSectors *	pSectors,
		const C4Rect &	rect
	)

Definition at line 244 of file C4Sector.cpp.

{
    // default: no area
    pFirst=nullptr; pOut=nullptr;
    // check bounds
    C4Rect ClippedRect(Rect),
    Bounds(0, 0, pSectors->PxWdt, pSectors->PxHgt);
    ClippedRect.Normalize();
    if (!Bounds.Contains(ClippedRect))
    {
        ClippedRect.Intersect(Bounds);
        pOut = &pSectors->SectorOut;
    }
    // calc first sector
    pFirst = pSectors->SectorAt(ClippedRect.x, ClippedRect.y);
    // assert the rect isn't degenerated for the following calculations
    // (note this will associate areas that are above landscape bounds with sectors inside)
    if (!ClippedRect.Wdt) ClippedRect.Wdt = 1;
    if (!ClippedRect.Hgt) ClippedRect.Hgt = 1;
    // calc bounds
    xL = (ClippedRect.x + ClippedRect.Wdt - 1) / C4LSectorWdt;
    yL = (ClippedRect.y + ClippedRect.Hgt - 1) / C4LSectorHgt;
    // calc pitch
    dpitch = pSectors->Wdt - (ClippedRect.x + ClippedRect.Wdt - 1) / C4LSectorWdt + ClippedRect.x / C4LSectorWdt;
}

References C4LSectorHgt, C4LSectorWdt, C4Rect::Contains(), dpitch, pFirst, pOut, C4LSectors::PxHgt, C4LSectors::PxWdt, C4LSectors::SectorAt(), C4LSectors::SectorOut, C4LSectors::Wdt, xL, and yL.

Referenced by C4LSectors::Add(), C4LArea(), and Set().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

dpitch

int C4LArea::dpitch

Definition at line 90 of file C4Sector.h.

Referenced by DebugRec(), Next(), and Set().

pFirst

C4LSector* C4LArea::pFirst

Definition at line 89 of file C4Sector.h.

Referenced by Clear(), Contains(), DebugRec(), First(), IsNull(), operator==(), and Set().

pOut

C4LSector* C4LArea::pOut

Definition at line 91 of file C4Sector.h.

Referenced by Clear(), Contains(), DebugRec(), Next(), operator==(), and Set().

xL

int C4LArea::xL

Definition at line 90 of file C4Sector.h.

Referenced by Contains(), DebugRec(), Next(), operator==(), and Set().

yL

int C4LArea::yL

Definition at line 90 of file C4Sector.h.

Referenced by Contains(), DebugRec(), Next(), operator==(), and Set().

---

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

• C4Sector.h
• C4Sector.cpp