APIdia Launch Partner
Top Description Fields Constructors Methods
com.badlogic.gdx.graphics.g3d.environment

public Class SpotLight

extends BaseLight<SpotLight>
Class Inheritance
Imports
com.badlogic.gdx.graphics.Color, com.badlogic.gdx.math.MathUtils, .Vector3

Note that the default shader doesn't support spot lights, you'll have to supply your own shader to use this class.
Author
realitix

Field Summary

Modifier and TypeField and Description
public float
public final Vector3
public float
public float
public final Vector3
Inherited from com.badlogic.gdx.graphics.g3d.environment.BaseLight:
color

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public boolean
public SpotLight
set(final SpotLight copyFrom)

public SpotLight
set(final Color color, final Vector3 position, final Vector3 direction, final float intensity, final float cutoffAngle, final float exponent)

public SpotLight
set(final float r, final float g, final float b, final Vector3 position, final Vector3 direction, final float intensity, final float cutoffAngle, final float exponent)

public SpotLight
set(final Color color, final float posX, final float posY, final float posZ, final float dirX, final float dirY, final float dirZ, final float intensity, final float cutoffAngle, final float exponent)

public SpotLight
set(final float r, final float g, final float b, final float posX, final float posY, final float posZ, final float dirX, final float dirY, final float dirZ, final float intensity, final float cutoffAngle, final float exponent)

public SpotLight
setCutoffAngle(float cutoffAngle)

public SpotLight
setDirection(float directionX, float directionY, float directionZ)

public SpotLight
setDirection(Vector3 direction)

public SpotLight
setExponent(float exponent)

public SpotLight
setIntensity(float intensity)

public SpotLight
setPosition(float positionX, float positionY, float positionZ)

public SpotLight
setPosition(Vector3 position)

public SpotLight
setTarget(final Vector3 target)

Inherited from com.badlogic.gdx.graphics.g3d.environment.BaseLight:
setColorsetColor

Field Detail

cutoffAngleback to summary
public float cutoffAngle
directionback to summary
public final Vector3 direction
exponentback to summary
public float exponent
intensityback to summary
public float intensity
positionback to summary
public final Vector3 position

Constructor Detail

SpotLightback to summary
public SpotLight()

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@Override
equalsback to summary
public boolean equals(SpotLight other)
setback to summary
public SpotLight set(final SpotLight copyFrom)
setback to summary
public SpotLight set(final Color color, final Vector3 position, final Vector3 direction, final float intensity, final float cutoffAngle, final float exponent)
setback to summary
public SpotLight set(final float r, final float g, final float b, final Vector3 position, final Vector3 direction, final float intensity, final float cutoffAngle, final float exponent)
setback to summary
public SpotLight set(final Color color, final float posX, final float posY, final float posZ, final float dirX, final float dirY, final float dirZ, final float intensity, final float cutoffAngle, final float exponent)
setback to summary
public SpotLight set(final float r, final float g, final float b, final float posX, final float posY, final float posZ, final float dirX, final float dirY, final float dirZ, final float intensity, final float cutoffAngle, final float exponent)
setCutoffAngleback to summary
public SpotLight setCutoffAngle(float cutoffAngle)
setDirectionback to summary
public SpotLight setDirection(float directionX, float directionY, float directionZ)
setDirectionback to summary
public SpotLight setDirection(Vector3 direction)
setExponentback to summary
public SpotLight setExponent(float exponent)
setIntensityback to summary
public SpotLight setIntensity(float intensity)
setPositionback to summary
public SpotLight setPosition(float positionX, float positionY, float positionZ)
setPositionback to summary
public SpotLight setPosition(Vector3 position)
setTargetback to summary
public SpotLight setTarget(final Vector3 target)