Package foundry.veil.api.client.render.light.data

Class DirectionalLightData

java.lang.Object

foundry.veil.api.client.render.light.data.LightData

foundry.veil.api.client.render.light.data.DirectionalLightData

All Implemented Interfaces:

EditorAttributeProvider, DDALightData

public class DirectionalLightData
extends LightData
implements EditorAttributeProvider, DDALightData

Represents a light where all rays come from the same direction everywhere. (The sun)

Since:

2.0.0

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.joml.Vector3f	direction
protected boolean	occlusionEnabled

Fields inherited from class foundry.veil.api.client.render.light.data.LightData

brightness, color

Constructor Summary

Constructors

Constructor	Description
DirectionalLightData()

Method Summary

Modifier and Type	Method	Description
org.joml.Vector3f	getDirection()
org.joml.Vector3f	getDirectionMutable()	Allows the value to be safely modified.
LightTypeRegistry.LightType<?>	getType()
boolean	isOcclusionEnabled()
boolean	isVisible(CullFrustum frustum)	Checks if this light is visible to the camera.
void	renderImGuiAttributes()	Renders all ImGui attributes into the current editor panel.
DirectionalLightData	setBrightness(float brightness)	Sets the brightness of the light.
DirectionalLightData	setColor(float red, float green, float blue)	Sets the RGB color of this light.
DirectionalLightData	setColor(int color)	Sets the RGB color of this light.
DirectionalLightData	setColor(Colorc color)	Sets the RGB color of this light.
DirectionalLightData	setColor(org.joml.Vector3fc color)	Sets the RGB color of this light.
DirectionalLightData	setDirection(float x, float y, float z)	Sets the direction of this light.
DirectionalLightData	setDirection(org.joml.Vector3fc direction)	Sets the direction of this light.
DirectionalLightData	setOcclusionEnabled(boolean occlusionEnabled)
DirectionalLightData	setTo(net.minecraft.client.Camera camera)	Sets the light position/rotation to be the same as the specified camera.

Methods inherited from class foundry.veil.api.client.render.light.data.LightData

getBrightness, getColor, getColorMutable, getRevision, markDirty

Methods inherited from class java.lang.Object

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

Field Details

direction

protected final org.joml.Vector3f direction

occlusionEnabled

protected boolean occlusionEnabled

Constructor Details

DirectionalLightData

public DirectionalLightData()

Method Details

getDirection

public org.joml.Vector3f getDirection()

Returns:

The direction this light is facing

getDirectionMutable

public org.joml.Vector3f getDirectionMutable()

Allows the value to be safely modified.

Returns:

The direction this light is facing

Since:

4.3.0

setDirection

public DirectionalLightData setDirection(org.joml.Vector3fc direction)

Sets the direction of this light.

Parameters:

direction - The new direction

setDirection

public DirectionalLightData setDirection(float x,
 float y,
 float z)

Sets the direction of this light.

Parameters:

x - The new x direction

y - The new y direction

z - The new z direction

setColor

public DirectionalLightData setColor(org.joml.Vector3fc color)

Description copied from class: LightData

Sets the RGB color of this light.

Overrides:

setColor in class LightData

Parameters:

color - The new color values

setColor

public DirectionalLightData setColor(Colorc color)

Description copied from class: LightData

Sets the RGB color of this light.

Overrides:

setColor in class LightData

Parameters:

color - The new color values

setColor

public DirectionalLightData setColor(float red,
 float green,
 float blue)

Description copied from class: LightData

Sets the RGB color of this light.

Overrides:

setColor in class LightData

Parameters:

red - The new red

green - The new green

blue - The new blue

setColor

public DirectionalLightData setColor(int color)

Description copied from class: LightData

Sets the RGB color of this light.

Overrides:

setColor in class LightData

Parameters:

color - THe new RGB of this light

setBrightness

public DirectionalLightData setBrightness(float brightness)

Description copied from class: LightData

Sets the brightness of the light. This acts as a multiplier on the light's color.

Overrides:

setBrightness in class LightData

Parameters:

brightness - The new brightness of the light.

setOcclusionEnabled

public DirectionalLightData setOcclusionEnabled(boolean occlusionEnabled)

Since:

4.4.0

isVisible

public boolean isVisible(CullFrustum frustum)

Description copied from class: LightData

Checks if this light is visible to the camera.

Specified by:

isVisible in class LightData

Parameters:

frustum - The frustum to check against

Returns:

Whether this light is visible

setTo

public DirectionalLightData setTo(net.minecraft.client.Camera camera)

Description copied from class: LightData

Sets the light position/rotation to be the same as the specified camera.

Overrides:

setTo in class LightData

Parameters:

camera - The camera to set relative to

getType

public LightTypeRegistry.LightType<?> getType()

Specified by:

getType in class LightData

Returns:

The type of light this is

renderImGuiAttributes

public void renderImGuiAttributes()

Description copied from interface: EditorAttributeProvider

Renders all ImGui attributes into the current editor panel.

Specified by:

renderImGuiAttributes in interface EditorAttributeProvider

isOcclusionEnabled

public boolean isOcclusionEnabled()

Specified by:

isOcclusionEnabled in interface DDALightData

Returns:

Whether occlusion is enabled