ATF_shadowedTowers.ih File Reference

Defines the inline interface needed to translate a list of tiles into a list of shadowed towers. More...

#include <ATF_shadowedTowersDef.h>
#include <PBI/FFS.ih>

Defines
#define	ATF_K_FACE_SIDE_CNT   15
	MSB number of an ACD side face -- internal use only.
#define	ATF_K_FACE_TOP_CNT   25
	MSB number of an ACD top face -- internal use only.
Functions
static __inline int	ATF__shadowedTowersGet (const unsigned short *twrsByTile, int tiles, int validCnt)
	Constructs a bit list of towers to which are shadowed by the specified list of tiles.
static __inline int	ATF__shadowedTowersByTop (const ATF_shadowedTowers *cfg, int tiles)
	Constructs a bit list of towers to which are shadowed by the specified list of top ACD tiles.
static __inline int	ATF__shadowedTowersByXM (const ATF_shadowedTowers *cfg, int tiles)
	Constructs a bit list of towers to which are shadowed by the specified list of side X- ACD tiles.
static __inline int	ATF__shadowedTowersByXP (const ATF_shadowedTowers *cfg, int tiles)
	Constructs a bit list of towers to which are shadowed by the specified list of side X+ ACD tiles.
static __inline int	ATF__shadowedTowersByYM (const ATF_shadowedTowers *cfg, int tiles)
	Constructs a bit list of towers to which are shadowed by the specified list of side Y- ACD tiles.
static __inline int	ATF__shadowedTowersByYP (const ATF_shadowedTowers *cfg, int tiles)
	Constructs a bit list of towers to which are shadowed by the specified list of side Y+ ACD tiles.

---

Detailed Description

Defines the inline interface needed to translate a list of tiles into a list of shadowed towers.

Author:

JJRussell - russell@slac.stanford.edu

    CVS $Id: ATF_shadowedTowers.ih,v 1.2 2011/03/27 04:55:30 russell Exp $

---

Function Documentation

static __inline int ATF__shadowedTowersByTop	(	const ATF_shadowedTowers *	cfg,
		int	tiles
	)			[static]

Constructs a bit list of towers to which are shadowed by the specified list of top ACD tiles.

Returns:

The bit list of towers shadowed by the struck tiles.

Parameters:

	cfg	Control structure containing the array which will translate top ACD tile numbers into a into a bit list of shadowing towers.
	tiles	A bit mask of the struck TOP tiles.

References ATF__shadowedTowersGet(), ATF_K_FACE_TOP_CNT, and _ATF_shadowedTowers::top.

Referenced by evaluateAtf().

static __inline int ATF__shadowedTowersByXM	(	const ATF_shadowedTowers *	cfg,
		int	tiles
	)			[static]

Constructs a bit list of towers to which are shadowed by the specified list of side X- ACD tiles.

Returns:

The bit list of towers shadowed by the struck tiles.

Parameters:

	cfg	Control structure containing the array which will translate X- ACD tile numbers into a into a bit list of shadowing towers.
	tiles	A bit mask of the X- struck tiles.

References ATF__shadowedTowersGet(), ATF_K_FACE_SIDE_CNT, and _ATF_shadowedTowers::x.

Referenced by evaluateAtf().

static __inline int ATF__shadowedTowersByXP	(	const ATF_shadowedTowers *	cfg,
		int	tiles
	)			[static]

Constructs a bit list of towers to which are shadowed by the specified list of side X+ ACD tiles.

Returns:

The bit list of towers shadowed by the struck tiles.

Parameters:

	cfg	Control structure containing the array which will translate X+ ACD tile numbers into a into a bit list of shadowing towers.
	tiles	A bit mask of the X+ struck tiles.

References ATF__shadowedTowersGet(), ATF_K_FACE_SIDE_CNT, and _ATF_shadowedTowers::x.

Referenced by evaluateAtf().

static __inline int ATF__shadowedTowersByYM	(	const ATF_shadowedTowers *	cfg,
		int	tiles
	)			[static]

Constructs a bit list of towers to which are shadowed by the specified list of side Y- ACD tiles.

Returns:

The bit list of towers shadowed by the struck tiles.

Parameters:

	cfg	Control structure containing the array which will translate Y- ACD tile numbers into a into a bit list of shadowing towers.
	tiles	A bit mask of the Y- struck tiles.

References ATF__shadowedTowersGet(), ATF_K_FACE_SIDE_CNT, and _ATF_shadowedTowers::y.

Referenced by evaluateAtf().

static __inline int ATF__shadowedTowersByYP	(	const ATF_shadowedTowers *	cfg,
		int	tiles
	)			[static]

Constructs a bit list of towers to which are shadowed by the specified list of side Y+ ACD tiles.

Returns:

The bit list of towers shadowed by the struck tiles.

Parameters:

	cfg	Control structure containing the array which will translate Y+ ACD tile numbers into a into a bit list of shadowing towers.
	tiles	A bit mask of the Y+ struck tiles.

References ATF__shadowedTowersGet(), ATF_K_FACE_SIDE_CNT, and _ATF_shadowedTowers::y.

Referenced by evaluateAtf().

static __inline int ATF__shadowedTowersGet	(	const unsigned short *	twrsByTile,
		int	tiles,
		int	validCnt
	)			[static]

Constructs a bit list of towers to which are shadowed by the specified list of tiles.

Returns:

The bit list of towers shadowed by the struck tiles.

Parameters:

	twrsByTile	Table containing arrays which will translate ATF tile numbers into a into a bit list of shadowing towers.
	tiles	A bit mask of the struck tiles in the face being considered.
	validCnt	Number of valid bits in the tiles bit array.

This routine is not part of the public interface. The user should call either ATF__shawdowedTowersSideGet or ATF__shadowedTowersTopGet.

Referenced by ATF__shadowedTowersByTop(), ATF__shadowedTowersByXM(), ATF__shadowedTowersByXP(), ATF__shadowedTowersByYM(), and ATF__shadowedTowersByYP().