Package org.boxutil.base

Class BaseRenderData

java.lang.Object

org.boxutil.base.BaseRenderData

All Implemented Interfaces:

RenderDataAPI

Direct Known Subclasses:

BaseInstanceRenderData, SegmentEntity, TextFieldEntity, TrailEntity

public abstract class BaseRenderData
extends Object
implements RenderDataAPI

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	autoSubmitDataBuffer
protected boolean	autoSubmitModelMat
protected boolean	autoSubmitPrimeMat
protected final int[]	blendConfig
protected byte	blendState
protected ControlDataAPI	controlData
protected Object	customData
protected final float[]	globalTimer
protected boolean	hasDelete
protected boolean	isTimerPaused
protected Object	layer
protected final FloatBuffer	modelMatBuffer
protected org.lwjgl.util.vector.Matrix4f	modelMatrix
protected final FloatBuffer	primeMatBuffer
protected org.lwjgl.util.vector.Matrix4f	primeMatrix
protected byte	primeMatrixState
protected final FloatBuffer	statePackageBuffer
protected final SpinLock	sync_lock
protected boolean	timingWhenPaused

Constructor Summary

Constructors

Constructor	Description
BaseRenderData()

Method Summary

Modifier and Type	Method	Description
protected void	_deleteExc()
protected void	_resetExc()
protected int	_StatePackageStack()
void	advanceGlobalTimer(float amount, boolean isPausedNow)	Automatic running, not required to call it.
void	appendToEntity(com.fs.starfarer.api.combat.CombatEntityAPI target)
void	appendToEntity(com.fs.starfarer.api.combat.CombatEntityAPI target, float offsetAngle)
void	appendToEntity(com.fs.starfarer.api.combat.CombatEntityAPI target, float offsetAngle, org.lwjgl.util.vector.Vector2f scale)
void	appendToEntity(com.fs.starfarer.api.combat.CombatEntityAPI target, float offsetAngle, org.lwjgl.util.vector.Vector3f scale)
void	delete()
Object	entityType()
int	getBlendAlphaDST()
int	getBlendAlphaSRC()
int	getBlendColorDST()
int	getBlendColorSRC()
int	getBlendEquation()
byte	getBlendState()
com.fs.starfarer.api.campaign.CampaignEngineLayers	getCampaignLayer()
com.fs.starfarer.api.combat.CombatEngineLayers	getCombatLayer()
ControlDataAPI	getControlData()
Object	getCustomData()
float[]	getGlobalTimer()
float	getGlobalTimerAlpha()
byte	getGlobalTimerState()
Object	getLayer()
org.lwjgl.util.vector.Matrix4f	getModelMatrix()
FloatBuffer	getModelMatrixBuffer()
org.lwjgl.util.vector.Matrix4f	getPrimeMatrix()
FloatBuffer	getPrimeMatrixBuffer()	When upload a custom prime matrix, call RenderDataAPI.setCustomPrimeMatrix() with this method.
byte	getPrimeMatrixState()
void	glDraw()
boolean	hasDelete()
void	initIdentityModelMatrix()
void	initIdentityPrimeMatrix()
boolean	isAutoSubmitEntityData()
boolean	isAutoSubmitModelMatrix()
boolean	isAutoSubmitPrimeMatrix()
boolean	isGlobalTimerOnce()
boolean	isGlobalTimerOver()
boolean	isTimerPaused()
boolean	isTimingWhenPaused()
FloatBuffer	pickDataPackage_vec4()	Only for system rendering calls, not applicable to developer.
FloatBuffer	pickModelMatrixPackage_mat4()	Only for system rendering calls, not applicable to developer.
FloatBuffer	pickPrimeMatrixPackage_mat4()	Only for system rendering calls, not applicable to developer.
void	reset()
void	setAdditiveBlend()
void	setAutoSubmitEntityData(boolean toggleAuto)	Enabling auto-submit incurs a slight memory copy overhead (default behavior, also with potential heap memory allocation).
void	setAutoSubmitModelMatrix(boolean toggleAuto)	Enabling auto-submit incurs a slight memory copy overhead (default behavior, also with potential heap memory allocation).
void	setAutoSubmitPrimeMatrix(boolean toggleAuto)	Enabling auto-submit incurs a slight memory copy overhead (default behavior, also with potential heap memory allocation).
void	setBlendEquation(int mode)
void	setBlendFunc(int srcFactor, int dstFactor)
void	setBlendFuncSeparate(int srcColorFactor, int dstColorFactor, int srcAlphaFactor, int dstAlphaFactor)
void	setControlData(ControlDataAPI data)	For custom your rendering entity.
Object	setCustomData(Object value)
void	setCustomPrimeMatrix()
void	setDefaultCampaignLayer()
void	setDefaultCombatLayer()
void	setDisableBlend()
void	setFacingScale(float facing, float scaleX, float scaleY)
void	setGlobalTimer(float fadeIn, float full, float fadeOut)
void	setGlobalTimerOnce()	For once frame rendering instance data, should use fixed type instance data.
void	setLayer(Object layer)
void	setLocation(float x, float y)
void	setLocation(float x, float y, float z)
void	setLocation(org.lwjgl.util.vector.Vector2f location)
void	setLocation(org.lwjgl.util.vector.Vector3f location)
void	setModelMatrix(org.lwjgl.util.vector.Matrix4f modelMatrix)
void	setNegativeBlend()	As custom blend mode.
void	setNonePrimeMatrix()
void	setNormalBlend()	Default blend mode.
void	setPerspectivePrimeMatrix()
void	setPrimeMatrix(org.lwjgl.util.vector.Matrix4f primeMatrix)	Generally, in there it is viewport and camera matrix(VP matrix, View and Projection in MVP), means 'main' not 'prime matrix'.
void	setRotateScale(org.lwjgl.util.vector.Vector3f rotate, org.lwjgl.util.vector.Vector3f scale)
void	setStateVanilla(org.lwjgl.util.vector.Vector2f location, float facing)
void	setStateVanilla(org.lwjgl.util.vector.Vector2f location, float facing, org.lwjgl.util.vector.Vector2f scale)
void	setTimerPaused(boolean paused)	Block timer even if not in paused.
void	setTimingWhenPaused(boolean timing)	Affects entity timer, and instance data.
void	setVanillaPrimeMatrix()
void	submitEntityData()	Without matrix data or timer settings.
void	submitModelMatrix()
void	submitPrimeMatrix()	Only required when use a custom prime matrix.

Methods inherited from class java.lang.Object

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

Field Details

primeMatrixState

protected byte primeMatrixState

blendState

protected byte blendState

timingWhenPaused

protected boolean timingWhenPaused

isTimerPaused

protected boolean isTimerPaused

autoSubmitPrimeMat

protected boolean autoSubmitPrimeMat

autoSubmitModelMat

protected boolean autoSubmitModelMat

autoSubmitDataBuffer

protected boolean autoSubmitDataBuffer

hasDelete

protected volatile boolean hasDelete

sync_lock

protected final SpinLock sync_lock

primeMatBuffer

protected final FloatBuffer primeMatBuffer

modelMatBuffer

protected final FloatBuffer modelMatBuffer

statePackageBuffer

protected final FloatBuffer statePackageBuffer

primeMatrix

protected org.lwjgl.util.vector.Matrix4f primeMatrix

modelMatrix

protected org.lwjgl.util.vector.Matrix4f modelMatrix

blendConfig

protected final int[] blendConfig

globalTimer

protected final float[] globalTimer

controlData

protected ControlDataAPI controlData

customData

protected Object customData

layer

protected Object layer

Constructor Details

BaseRenderData

public BaseRenderData()

Method Details

_StatePackageStack

protected int _StatePackageStack()

_deleteExc

protected void _deleteExc()

delete

public void delete()

Specified by:

delete in interface RenderDataAPI

hasDelete

public boolean hasDelete()

Specified by:

hasDelete in interface RenderDataAPI

Returns:

Should not use this entity when true.

glDraw

public void glDraw()

Specified by:

glDraw in interface RenderDataAPI

_resetExc

protected void _resetExc()

reset

public void reset()

Specified by:

reset in interface RenderDataAPI

isAutoSubmitEntityData

public boolean isAutoSubmitEntityData()

Specified by:

isAutoSubmitEntityData in interface RenderDataAPI

setAutoSubmitEntityData

public void setAutoSubmitEntityData(boolean toggleAuto)

Enabling auto-submit incurs a slight memory copy overhead (default behavior, also with potential heap memory allocation).

If data changes are infrequent, you may disable this feature and use RenderDataAPI.submitEntityData() for manual submits instead, which can reduce unnecessary memory copies to a certain extent.

Specified by:

setAutoSubmitEntityData in interface RenderDataAPI

submitEntityData

public void submitEntityData()

Without matrix data or timer settings.

Specified by:

submitEntityData in interface RenderDataAPI

getControlData

public ControlDataAPI getControlData()

Specified by:

getControlData in interface RenderDataAPI

setControlData

public void setControlData(@Nullable
 ControlDataAPI data)

For custom your rendering entity.

Always execute ControlDataAPI.controlInit(RenderDataAPI) when call this method.

More than one RenderDataAPI entities always can be using a same data entity.

Specified by:

setControlData in interface RenderDataAPI

getCustomData

public Object getCustomData()

Specified by:

getCustomData in interface RenderDataAPI

setCustomData

public Object setCustomData(Object value)

Specified by:

setCustomData in interface RenderDataAPI

getGlobalTimer

public float[] getGlobalTimer()

Specified by:

getGlobalTimer in interface RenderDataAPI

setGlobalTimer

public void setGlobalTimer(float fadeIn,
 float full,
 float fadeOut)

Specified by:

setGlobalTimer in interface RenderDataAPI

advanceGlobalTimer

public void advanceGlobalTimer(float amount,
 boolean isPausedNow)

Automatic running, not required to call it.

Specified by:

advanceGlobalTimer in interface RenderDataAPI

getGlobalTimerState

public byte getGlobalTimerState()

Specified by:

getGlobalTimerState in interface RenderDataAPI

getGlobalTimerAlpha

public float getGlobalTimerAlpha()

Specified by:

getGlobalTimerAlpha in interface RenderDataAPI

isGlobalTimerOver

public boolean isGlobalTimerOver()

Specified by:

isGlobalTimerOver in interface RenderDataAPI

isGlobalTimerOnce

public boolean isGlobalTimerOnce()

Specified by:

isGlobalTimerOnce in interface RenderDataAPI

setGlobalTimerOnce

public void setGlobalTimerOnce()

For once frame rendering instance data, should use fixed type instance data.

Specified by:

setGlobalTimerOnce in interface RenderDataAPI

isTimingWhenPaused

public boolean isTimingWhenPaused()

Specified by:

isTimingWhenPaused in interface RenderDataAPI

setTimingWhenPaused

public void setTimingWhenPaused(boolean timing)

Affects entity timer, and instance data.

Specified by:

setTimingWhenPaused in interface RenderDataAPI

isTimerPaused

public boolean isTimerPaused()

Specified by:

isTimerPaused in interface RenderDataAPI

setTimerPaused

public void setTimerPaused(boolean paused)

Block timer even if not in paused.

Specified by:

setTimerPaused in interface RenderDataAPI

getPrimeMatrix

public org.lwjgl.util.vector.Matrix4f getPrimeMatrix()

Specified by:

getPrimeMatrix in interface RenderDataAPI

getPrimeMatrixBuffer

public FloatBuffer getPrimeMatrixBuffer()

When upload a custom prime matrix, call RenderDataAPI.setCustomPrimeMatrix() with this method.

Specified by:

getPrimeMatrixBuffer in interface RenderDataAPI

Returns:

4x4 matrix in buffer with 16 capacity.

isAutoSubmitPrimeMatrix

public boolean isAutoSubmitPrimeMatrix()

Specified by:

isAutoSubmitPrimeMatrix in interface RenderDataAPI

setAutoSubmitPrimeMatrix

public void setAutoSubmitPrimeMatrix(boolean toggleAuto)

Enabling auto-submit incurs a slight memory copy overhead (default behavior, also with potential heap memory allocation).

If data changes are infrequent, you may disable this feature and use RenderDataAPI.submitPrimeMatrix() for manual submits instead, which can reduce unnecessary memory copies to a certain extent.

Alternatively, use RenderDataAPI.getPrimeMatrixBuffer() to directly operate on the corresponding buffer after this feature was disabled;

Specified by:

setAutoSubmitPrimeMatrix in interface RenderDataAPI

submitPrimeMatrix

public void submitPrimeMatrix()

Only required when use a custom prime matrix.

Specified by:

submitPrimeMatrix in interface RenderDataAPI

initIdentityPrimeMatrix

public void initIdentityPrimeMatrix()

Specified by:

initIdentityPrimeMatrix in interface RenderDataAPI

setPrimeMatrix

public void setPrimeMatrix(org.lwjgl.util.vector.Matrix4f primeMatrix)

Generally, in there it is viewport and camera matrix(VP matrix, View and Projection in MVP), means 'main' not 'prime matrix'.

In shader program: [this matrix * model matrix * vertex]

Must call RenderDataAPI.setCustomPrimeMatrix() if use it.

Specified by:

setPrimeMatrix in interface RenderDataAPI

Parameters:

primeMatrix - for usual, this is a matrix as [Projection * Look-at].

getPrimeMatrixState

public byte getPrimeMatrixState()

Specified by:

getPrimeMatrixState in interface RenderDataAPI

setVanillaPrimeMatrix

public void setVanillaPrimeMatrix()

Specified by:

setVanillaPrimeMatrix in interface RenderDataAPI

setPerspectivePrimeMatrix

public void setPerspectivePrimeMatrix()

Specified by:

setPerspectivePrimeMatrix in interface RenderDataAPI

setCustomPrimeMatrix

public void setCustomPrimeMatrix()

Specified by:

setCustomPrimeMatrix in interface RenderDataAPI

setNonePrimeMatrix

public void setNonePrimeMatrix()

Specified by:

setNonePrimeMatrix in interface RenderDataAPI

getModelMatrix

public org.lwjgl.util.vector.Matrix4f getModelMatrix()

Specified by:

getModelMatrix in interface RenderDataAPI

getModelMatrixBuffer

public FloatBuffer getModelMatrixBuffer()

Specified by:

getModelMatrixBuffer in interface RenderDataAPI

Returns:

4x4 matrix in buffer with 16 capacity.

isAutoSubmitModelMatrix

public boolean isAutoSubmitModelMatrix()

Specified by:

isAutoSubmitModelMatrix in interface RenderDataAPI

setAutoSubmitModelMatrix

public void setAutoSubmitModelMatrix(boolean toggleAuto)

Enabling auto-submit incurs a slight memory copy overhead (default behavior, also with potential heap memory allocation).

If data changes are infrequent, you may disable this feature and use RenderDataAPI.submitModelMatrix() for manual submits instead, which can reduce unnecessary memory copies to a certain extent.

Alternatively, use RenderDataAPI.getModelMatrixBuffer() to directly operate on the corresponding buffer after this feature was disabled;

Specified by:

setAutoSubmitModelMatrix in interface RenderDataAPI

submitModelMatrix

public void submitModelMatrix()

Specified by:

submitModelMatrix in interface RenderDataAPI

initIdentityModelMatrix

public void initIdentityModelMatrix()

Specified by:

initIdentityModelMatrix in interface RenderDataAPI

setModelMatrix

public void setModelMatrix(@NotNull
 org.lwjgl.util.vector.Matrix4f modelMatrix)

Specified by:

setModelMatrix in interface RenderDataAPI

Parameters:

modelMatrix - for usual, this is a model matrix.

setLocation

public void setLocation(float x,
 float y)

Specified by:

setLocation in interface RenderDataAPI

setLocation

public void setLocation(float x,
 float y,
 float z)

Specified by:

setLocation in interface RenderDataAPI

setLocation

public void setLocation(org.lwjgl.util.vector.Vector2f location)

Specified by:

setLocation in interface RenderDataAPI

setLocation

public void setLocation(org.lwjgl.util.vector.Vector3f location)

Specified by:

setLocation in interface RenderDataAPI

setFacingScale

public void setFacingScale(float facing,
 float scaleX,
 float scaleY)

Specified by:

setFacingScale in interface RenderDataAPI

setRotateScale

public void setRotateScale(org.lwjgl.util.vector.Vector3f rotate,
 org.lwjgl.util.vector.Vector3f scale)

Specified by:

setRotateScale in interface RenderDataAPI

setStateVanilla

public void setStateVanilla(org.lwjgl.util.vector.Vector2f location,
 float facing,
 org.lwjgl.util.vector.Vector2f scale)

Specified by:

setStateVanilla in interface RenderDataAPI

setStateVanilla

public void setStateVanilla(org.lwjgl.util.vector.Vector2f location,
 float facing)

Specified by:

setStateVanilla in interface RenderDataAPI

appendToEntity

public void appendToEntity(com.fs.starfarer.api.combat.CombatEntityAPI target,
 float offsetAngle,
 org.lwjgl.util.vector.Vector3f scale)

Specified by:

appendToEntity in interface RenderDataAPI

appendToEntity

public void appendToEntity(com.fs.starfarer.api.combat.CombatEntityAPI target,
 float offsetAngle,
 org.lwjgl.util.vector.Vector2f scale)

Specified by:

appendToEntity in interface RenderDataAPI

appendToEntity

public void appendToEntity(com.fs.starfarer.api.combat.CombatEntityAPI target,
 float offsetAngle)

Specified by:

appendToEntity in interface RenderDataAPI

appendToEntity

public void appendToEntity(com.fs.starfarer.api.combat.CombatEntityAPI target)

Specified by:

appendToEntity in interface RenderDataAPI

pickPrimeMatrixPackage_mat4

public FloatBuffer pickPrimeMatrixPackage_mat4()

Only for system rendering calls, not applicable to developer.

Specified by:

pickPrimeMatrixPackage_mat4 in interface RenderDataAPI

pickModelMatrixPackage_mat4

public FloatBuffer pickModelMatrixPackage_mat4()

Only for system rendering calls, not applicable to developer.

Specified by:

pickModelMatrixPackage_mat4 in interface RenderDataAPI

pickDataPackage_vec4

public FloatBuffer pickDataPackage_vec4()

Only for system rendering calls, not applicable to developer.

Specified by:

pickDataPackage_vec4 in interface RenderDataAPI

getBlendColorSRC

public int getBlendColorSRC()

Specified by:

getBlendColorSRC in interface RenderDataAPI

getBlendColorDST

public int getBlendColorDST()

Specified by:

getBlendColorDST in interface RenderDataAPI

getBlendAlphaSRC

public int getBlendAlphaSRC()

Specified by:

getBlendAlphaSRC in interface RenderDataAPI

getBlendAlphaDST

public int getBlendAlphaDST()

Specified by:

getBlendAlphaDST in interface RenderDataAPI

getBlendEquation

public int getBlendEquation()

Specified by:

getBlendEquation in interface RenderDataAPI

getBlendState

public byte getBlendState()

Specified by:

getBlendState in interface RenderDataAPI

setBlendFunc

public void setBlendFunc(int srcFactor,
 int dstFactor)

Specified by:

setBlendFunc in interface RenderDataAPI

See Also:

• GL11.glBlendFunc(int, int)

setBlendFuncSeparate

public void setBlendFuncSeparate(int srcColorFactor,
 int dstColorFactor,
 int srcAlphaFactor,
 int dstAlphaFactor)

Specified by:

setBlendFuncSeparate in interface RenderDataAPI

See Also:

• GL14.glBlendFuncSeparate(int, int, int, int)

setBlendEquation

public void setBlendEquation(int mode)

Specified by:

setBlendEquation in interface RenderDataAPI

See Also:

• GL14.glBlendEquation(int)

setAdditiveBlend

public void setAdditiveBlend()

Specified by:

setAdditiveBlend in interface RenderDataAPI

setNormalBlend

public void setNormalBlend()

Default blend mode.

Specified by:

setNormalBlend in interface RenderDataAPI

setNegativeBlend

public void setNegativeBlend()

As custom blend mode.

Specified by:

setNegativeBlend in interface RenderDataAPI

setDisableBlend

public void setDisableBlend()

Specified by:

setDisableBlend in interface RenderDataAPI

getLayer

public Object getLayer()

Specified by:

getLayer in interface RenderDataAPI

getCombatLayer

public com.fs.starfarer.api.combat.CombatEngineLayers getCombatLayer()

Specified by:

getCombatLayer in interface RenderDataAPI

getCampaignLayer

public com.fs.starfarer.api.campaign.CampaignEngineLayers getCampaignLayer()

Specified by:

getCampaignLayer in interface RenderDataAPI

setLayer

public void setLayer(Object layer)

Specified by:

setLayer in interface RenderDataAPI

setDefaultCombatLayer

public void setDefaultCombatLayer()

Specified by:

setDefaultCombatLayer in interface RenderDataAPI

setDefaultCampaignLayer

public void setDefaultCampaignLayer()

Specified by:

setDefaultCampaignLayer in interface RenderDataAPI

entityType

public Object entityType()

Specified by:

entityType in interface RenderDataAPI