Adventure at Umalu  22nd March, 2013
Rogue-like Dungeon Crawler, written in Java
 All Classes Functions Variables Pages
Public Member Functions | Protected Member Functions | List of all members
jade.fov.ViewField Class Referenceabstract
Inheritance diagram for jade.fov.ViewField:
jade.fov.RayCaster jade.fov.ShadowCaster

Public Member Functions

final Collection< CoordinategetViewField (World world, int x, int y, int r)
 
final Collection< CoordinategetViewFieldplayer (World world, int x, int y, int r)
 
final Collection< CoordinategetViewField (World world, Coordinate coord, int r)
 

Protected Member Functions

abstract Collection< CoordinatecalcViewField (World world, int x, int y, int r)
 
abstract Collection< CoordinatecalcViewFieldplayer (World world, int x, int y, int r)
 

Detailed Description

Represents an algorithm for determining field of view on a

World

.

Member Function Documentation

abstract Collection<Coordinate> jade.fov.ViewField.calcViewField ( World  world,
int  x,
int  y,
int  r 
)
protectedpure virtual

Calculates the field of view on the given

World

from the given (x, y) coordinates with the specified radius.

Parameters
worldthe
World
on which field of view is being calculated
xthe x value of the coordinate being queried
ythe y value of the coordinate being queried
rthe radius of the field of view
Returns
the field of view on world from (x, y)

Implemented in jade.fov.RayCaster, and jade.fov.ShadowCaster.

final Collection<Coordinate> jade.fov.ViewField.getViewField ( World  world,
int  x,
int  y,
int  r 
)

Calculates the field of view on the given

World

from the given (x, y) coordinates with the specified radius.

Parameters
worldthe
World
on which field of view is being calculated
xthe x value of the coordinate being queried
ythe y value of the coordinate being queried
rthe radius of the field of view
Returns
the field of view on world from (x, y)
final Collection<Coordinate> jade.fov.ViewField.getViewField ( World  world,
Coordinate  coord,
int  r 
)

Calculates the field of view on the given

World

from the given

Coordinate

with the specified radius.

Parameters
worldthe
World
on which field of view is being calculated
coordthe value of the coordinate being queried
rthe radius of the field of view
Returns
the field of view on world from the given
Coordinate

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