com.fs.starfarer.api.impl.campaign.terrain

Class WavefrontTerrainPlugin

java.lang.Object

com.fs.starfarer.api.impl.campaign.terrain.BaseTerrain

com.fs.starfarer.api.impl.campaign.terrain.WavefrontTerrainPlugin

All Implemented Interfaces:

CampaignTerrainPlugin

public class WavefrontTerrainPlugin
extends BaseTerrain

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WavefrontTerrainPlugin.WavefrontParams

Field Summary

Fields

Modifier and Type	Field and Description
protected org.lwjgl.util.vector.Vector2f	arcOrigin
protected float	currentArc
protected float	currentThickness
protected float	currentWidth
protected float	distanceTravelled
protected FaderUtil	fader
protected int	numSegments
protected org.lwjgl.util.vector.Vector2f	p1
protected org.lwjgl.util.vector.Vector2f	p2
protected WavefrontTerrainPlugin.WavefrontParams	params
protected float	phaseAngle
protected SpriteAPI	texture
protected org.lwjgl.util.vector.Vector2f	velDir

Fields inherited from class com.fs.starfarer.api.impl.campaign.terrain.BaseTerrain

entity, EXTRA_SOUND_RADIUS, name, TERRAIN_LOCK_KEY, terrainId

Constructor Summary

Constructors

Constructor and Description
WavefrontTerrainPlugin()

Method Summary

Modifier and Type	Method and Description
void	advance(float amount)
void	applyEffect(SectorEntityToken entity, float days)
boolean	canPlayerHoldStationIn()
boolean	containsPoint(org.lwjgl.util.vector.Vector2f point, float radius)
void	createTooltip(TooltipMakerAPI tooltip, boolean expanded)
java.util.EnumSet<CampaignEngineLayers>	getActiveLayers() Set of layers can not change.
java.lang.String	getEffectCategory()
protected float	getFadeDist()
float	getForceDirAtPoint(org.lwjgl.util.vector.Vector2f point)
float	getIntensityAtPoint(org.lwjgl.util.vector.Vector2f point)
float	getMaxEffectRadius(org.lwjgl.util.vector.Vector2f locFrom) Mainly intended for AI use.
float	getMinEffectRadius(org.lwjgl.util.vector.Vector2f locFrom) Mainly intended for AI use.
java.awt.Color	getNameColor()
java.lang.String	getNameForTooltip()
float	getOptimalEffectRadius(org.lwjgl.util.vector.Vector2f locFrom) Mainly intended for AI use.
WavefrontTerrainPlugin.WavefrontParams	getParams()
protected float	getPixelsPerSegment()
float	getRenderRange() How far away from the viewport the center of this entity can be before it stops being rendered.
java.lang.String	getTerrainName()
float	getTooltipWidth()
boolean	hasMapIcon()
boolean	hasTooltip()
void	init(java.lang.String terrainId, SectorEntityToken entity, java.lang.Object param)
boolean	isTooltipExpandable()
void	render(CampaignEngineLayers layer, ViewportAPI viewport)
protected void	updateArcOfCurrWidth()
protected void	updateArcOrigin()

Methods inherited from class com.fs.starfarer.api.impl.campaign.terrain.BaseTerrain

containsEntity, createCombatSection, createFirstSection, createTravelSection, getEntity, getExtraSoundRadius, getIconSpriteName, getLoopFourPitch, getLoopFourVolume, getLoopOnePitch, getLoopOneVolume, getLoopThreePitch, getLoopThreeVolume, getLoopTwoPitch, getLoopTwoVolume, getModId, getNameAOrAn, getProximitySoundFactor, getRelatedEntity, getSpec, getTerrainId, hasAIFlag, hasAIFlag, isPreventedFromAffecting, preventOtherTerrainFromAffecting, preventOtherTerrainFromAffecting, renderOnMap, renderOnMapAbove, renderOnRadar, setEntity, setTerrainId, setTerrainName, shouldCheckFleetsToApplyEffect, shouldPlayLoopFour, shouldPlayLoopOne, shouldPlayLoopThree, shouldPlayLoopTwo, stacksWithSelf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

texture

protected transient SpriteAPI texture

params

protected WavefrontTerrainPlugin.WavefrontParams params

arcOrigin

protected org.lwjgl.util.vector.Vector2f arcOrigin

velDir

protected org.lwjgl.util.vector.Vector2f velDir

p1

protected org.lwjgl.util.vector.Vector2f p1

p2

protected org.lwjgl.util.vector.Vector2f p2

distanceTravelled

protected float distanceTravelled

currentWidth

protected float currentWidth

currentThickness

protected float currentThickness

currentArc

protected float currentArc

phaseAngle

protected float phaseAngle

numSegments

protected int numSegments

fader

protected FaderUtil fader

Constructor Detail

WavefrontTerrainPlugin

public WavefrontTerrainPlugin()

Method Detail

init

public void init(java.lang.String terrainId,
                 SectorEntityToken entity,
                 java.lang.Object param)

Specified by:

init in interface CampaignTerrainPlugin

Overrides:

init in class BaseTerrain

getPixelsPerSegment

protected float getPixelsPerSegment()

getActiveLayers

public java.util.EnumSet<CampaignEngineLayers> getActiveLayers()

Description copied from interface: CampaignTerrainPlugin

Set of layers can not change.

Specified by:

getActiveLayers in interface CampaignTerrainPlugin

Overrides:

getActiveLayers in class BaseTerrain

Returns:

getParams

public WavefrontTerrainPlugin.WavefrontParams getParams()

updateArcOrigin

protected void updateArcOrigin()

advance

public void advance(float amount)

Specified by:

advance in interface CampaignTerrainPlugin

Overrides:

advance in class BaseTerrain

render

public void render(CampaignEngineLayers layer,
                   ViewportAPI viewport)

Specified by:

render in interface CampaignTerrainPlugin

Overrides:

render in class BaseTerrain

getRenderRange

public float getRenderRange()

Description copied from interface: CampaignTerrainPlugin

How far away from the viewport the center of this entity can be before it stops being rendered. Should at least be the radius of the entity; sometimes more may be necessary depending on the visual effect desired.

Specified by:

getRenderRange in interface CampaignTerrainPlugin

Overrides:

getRenderRange in class BaseTerrain

Returns:

updateArcOfCurrWidth

protected void updateArcOfCurrWidth()

getFadeDist

protected float getFadeDist()

containsPoint

public boolean containsPoint(org.lwjgl.util.vector.Vector2f point,
                             float radius)

Specified by:

containsPoint in interface CampaignTerrainPlugin

Overrides:

containsPoint in class BaseTerrain

applyEffect

public void applyEffect(SectorEntityToken entity,
                        float days)

Overrides:

applyEffect in class BaseTerrain

getForceDirAtPoint

public float getForceDirAtPoint(org.lwjgl.util.vector.Vector2f point)

getIntensityAtPoint

public float getIntensityAtPoint(org.lwjgl.util.vector.Vector2f point)

getNameColor

public java.awt.Color getNameColor()

Specified by:

getNameColor in interface CampaignTerrainPlugin

Overrides:

getNameColor in class BaseTerrain

hasTooltip

public boolean hasTooltip()

Specified by:

hasTooltip in interface CampaignTerrainPlugin

Overrides:

hasTooltip in class BaseTerrain

createTooltip

public void createTooltip(TooltipMakerAPI tooltip,
                          boolean expanded)

Specified by:

createTooltip in interface CampaignTerrainPlugin

Overrides:

createTooltip in class BaseTerrain

isTooltipExpandable

public boolean isTooltipExpandable()

Specified by:

isTooltipExpandable in interface CampaignTerrainPlugin

Overrides:

isTooltipExpandable in class BaseTerrain

getTooltipWidth

public float getTooltipWidth()

Specified by:

getTooltipWidth in interface CampaignTerrainPlugin

Overrides:

getTooltipWidth in class BaseTerrain

getTerrainName

public java.lang.String getTerrainName()

Specified by:

getTerrainName in interface CampaignTerrainPlugin

Overrides:

getTerrainName in class BaseTerrain

getNameForTooltip

public java.lang.String getNameForTooltip()

Specified by:

getNameForTooltip in interface CampaignTerrainPlugin

Overrides:

getNameForTooltip in class BaseTerrain

getEffectCategory

public java.lang.String getEffectCategory()

Overrides:

getEffectCategory in class BaseTerrain

getMaxEffectRadius

public float getMaxEffectRadius(org.lwjgl.util.vector.Vector2f locFrom)

Description copied from interface: CampaignTerrainPlugin

Mainly intended for AI use.

Specified by:

getMaxEffectRadius in interface CampaignTerrainPlugin

Overrides:

getMaxEffectRadius in class BaseTerrain

Returns:

getMinEffectRadius

public float getMinEffectRadius(org.lwjgl.util.vector.Vector2f locFrom)

Description copied from interface: CampaignTerrainPlugin

Mainly intended for AI use.

Specified by:

getMinEffectRadius in interface CampaignTerrainPlugin

Overrides:

getMinEffectRadius in class BaseTerrain

Returns:

getOptimalEffectRadius

public float getOptimalEffectRadius(org.lwjgl.util.vector.Vector2f locFrom)

Description copied from interface: CampaignTerrainPlugin

Mainly intended for AI use.

Specified by:

getOptimalEffectRadius in interface CampaignTerrainPlugin

Overrides:

getOptimalEffectRadius in class BaseTerrain

Returns:

hasMapIcon

public boolean hasMapIcon()

Specified by:

hasMapIcon in interface CampaignTerrainPlugin

Overrides:

hasMapIcon in class BaseTerrain

canPlayerHoldStationIn

public boolean canPlayerHoldStationIn()

Specified by:

canPlayerHoldStationIn in interface CampaignTerrainPlugin

Overrides:

canPlayerHoldStationIn in class BaseTerrain