com.fs.starfarer.api.util.CollisionGridUtil Class Reference

Inheritance diagram for com.fs.starfarer.api.util.CollisionGridUtil:

Collaboration diagram for com.fs.starfarer.api.util.CollisionGridUtil:

Classes
class	BucketIterator

Public Member Functions
	CollisionGridUtil (float minX, float maxX, float minY, float maxY, float cellSize)
void	addObject (Object object, Vector2f loc, float objWidth, float objHeight)
void	removeObject (Object object, Vector2f loc, float objWidth, float objHeight)
Iterator< Object >	getCheckIterator (Vector2f loc, float objWidth, float objHeight)
Public Member Functions inherited from com.fs.starfarer.api.combat.CollisionGridAPI

Protected Member Functions
void	addToBucket (int cellX, int cellY, Object object)
void	removeFromBucket (int cellX, int cellY, Object object)

Protected Attributes
float	cellSize
List< Object >[][]	buckets
int	width
int	height
int	leftOf
int	rightOf
int	below
int	above

Detailed Description

Definition at line 13 of file CollisionGridUtil.java.

Constructor & Destructor Documentation

CollisionGridUtil()

com.fs.starfarer.api.util.CollisionGridUtil.CollisionGridUtil	(	float	minX,
		float	maxX,
		float	minY,
		float	maxY,
		float	cellSize )

Definition at line 59 of file CollisionGridUtil.java.

Member Function Documentation

addObject()

void com.fs.starfarer.api.util.CollisionGridUtil.addObject	(	Object	object,
		Vector2f	loc,
		float	objWidth,
		float	objHeight )

Adds the object to every bucket that the area overlaps.

Parameters

object
loc
objWidth
objHeight

Implements com.fs.starfarer.api.combat.CollisionGridAPI.

Definition at line 72 of file CollisionGridUtil.java.

addToBucket()

void com.fs.starfarer.api.util.CollisionGridUtil.addToBucket ( int cellX, int cellY, Object object )

protected

Definition at line 110 of file CollisionGridUtil.java.

getCheckIterator()

Iterator< Object > com.fs.starfarer.api.util.CollisionGridUtil.getCheckIterator	(	Vector2f	loc,
		float	checkWidth,
		float	checkHeight )

Returns an iterator for all the objects in this grid that are in the specified area.

Parameters

loc
checkWidth
checkHeight

Returns

Implements com.fs.starfarer.api.combat.CollisionGridAPI.

Definition at line 126 of file CollisionGridUtil.java.

removeFromBucket()

void com.fs.starfarer.api.util.CollisionGridUtil.removeFromBucket ( int cellX, int cellY, Object object )

protected

Definition at line 120 of file CollisionGridUtil.java.

removeObject()

void com.fs.starfarer.api.util.CollisionGridUtil.removeObject	(	Object	object,
		Vector2f	loc,
		float	objWidth,
		float	objHeight )

Removes the object from every bucket that the area overlaps.

Parameters

object
loc
objWidth
objHeight

Implements com.fs.starfarer.api.combat.CollisionGridAPI.

Definition at line 97 of file CollisionGridUtil.java.

Member Data Documentation

above

int com.fs.starfarer.api.util.CollisionGridUtil.above

protected

Definition at line 56 of file CollisionGridUtil.java.

below

int com.fs.starfarer.api.util.CollisionGridUtil.below

protected

Definition at line 56 of file CollisionGridUtil.java.

buckets

List<Object> [][] com.fs.starfarer.api.util.CollisionGridUtil.buckets

protected

Definition at line 54 of file CollisionGridUtil.java.

cellSize

float com.fs.starfarer.api.util.CollisionGridUtil.cellSize

protected

Definition at line 53 of file CollisionGridUtil.java.

height

int com.fs.starfarer.api.util.CollisionGridUtil.height

protected

Definition at line 56 of file CollisionGridUtil.java.

leftOf

int com.fs.starfarer.api.util.CollisionGridUtil.leftOf

protected

Definition at line 56 of file CollisionGridUtil.java.

rightOf

int com.fs.starfarer.api.util.CollisionGridUtil.rightOf

protected

Definition at line 56 of file CollisionGridUtil.java.

width

int com.fs.starfarer.api.util.CollisionGridUtil.width

protected

Definition at line 56 of file CollisionGridUtil.java.

---

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

• src/com/fs/starfarer/api/util/CollisionGridUtil.java