Class LightSource

java.lang.Object

com.github.yellowstonegames.grid.LightSource

All Implemented Interfaces:

com.github.yellowstonegames.core.ISerializersNeeded

public class LightSource
extends Object
implements com.github.yellowstonegames.core.ISerializersNeeded

A tiny data wrapper around a radiance and a Coord position for that Radiance, as well as, optionally, an angle to project a cone of light in and a span for how wide of a cone to project.

Field Summary

Fields

Modifier and Type	Field	Description
float	direction	The angle the light source emits light towards, measured in turns (0-1, counterclockwise from right).
Coord	position
Radiance	radiance
float	span	How wide of an arc the light source covers, measured in turns (0-1).

Constructor Summary

Constructors

Constructor	Description
LightSource()
LightSource(Coord position, Radiance radiance)
LightSource(Coord position, Radiance radiance, float spanTurns, float directionTurns)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
float	getDirection()
Coord	getPosition()
Radiance	getRadiance()
List<Class<?>>	getSerializersNeeded()
float	getSpan()
int	hashCode()
static LightSource	recreateFromString(String data)
void	setDirection(float directionTurns)
void	setPosition(Coord position)
void	setRadiance(Radiance radiance)
void	setSpan(float spanTurns)
LightSource	stringDeserialize(String data)
String	stringSerialize()
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

radiance

public Radiance radiance

position

public Coord position

span

public float span

How wide of an arc the light source covers, measured in turns (0-1).

direction

public float direction

The angle the light source emits light towards, measured in turns (0-1, counterclockwise from right). If span is 1 or greater, this has no effect.

Constructor Details

LightSource

public LightSource()

LightSource

public LightSource(Coord position,
 Radiance radiance)

LightSource

public LightSource(Coord position,
 Radiance radiance,
 float spanTurns,
 float directionTurns)

Method Details

getRadiance

public Radiance getRadiance()

setRadiance

public void setRadiance(Radiance radiance)

getPosition

public Coord getPosition()

setPosition

public void setPosition(Coord position)

getSpan

public float getSpan()

setSpan

public void setSpan(float spanTurns)

Parameters:

spanTurns - how wide of an arc this should spread light into, measured in turns (0-1)

getDirection

public float getDirection()

setDirection

public void setDirection(float directionTurns)

Parameters:

directionTurns - what angle the light should project in, measured in turns (0-1, counterclockwise from right)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

stringSerialize

public String stringSerialize()

stringDeserialize

public LightSource stringDeserialize(String data)

recreateFromString

public static LightSource recreateFromString(String data)

getSerializersNeeded

public List<Class<?>> getSerializersNeeded()

Specified by:

getSerializersNeeded in interface com.github.yellowstonegames.core.ISerializersNeeded