LightFilter.Light

java.lang.Object
- com.jhlabs.image.LightFilter.Light

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

LightFilter.AmbientLight, LightFilter.DistantLight, LightFilter.PointLight, LightFilter.SpotLight

Enclosing class:

LightFilter
```
public static class LightFilter.Light
extends java.lang.Object
implements java.lang.Cloneable
```
A class representing a light.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) float`	`azimuth`
`(package private) float`	`centreX`
`(package private) float`	`centreY`
`(package private) int`	`color`
`(package private) float`	`coneAngle`
`(package private) float`	`cosConeAngle`
`(package private) Vector3f`	`direction`
`(package private) float`	`distance`
`(package private) float`	`elevation`
`(package private) float`	`focus`
`(package private) float`	`intensity`
`(package private) Vector3f`	`position`
`(package private) Color4f`	`realColor`
`(package private) int`	`type`

Constructor Summary

Constructors
Constructor and Description

Light()

Light(float azimuth, float elevation, float intensity)

Constructors
Constructor and Description
`Light()`
`Light(float azimuth, float elevation, float intensity)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()`
`float`	`getAzimuth()`
`float`	`getCentreX()` Get the centre of the light in the X direction as a proportion of the image size.
`float`	`getCentreY()` Get the centre of the light in the Y direction as a proportion of the image size.
`int`	`getColor()`
`float`	`getConeAngle()`
`float`	`getDistance()`
`float`	`getElevation()`
`float`	`getFocus()`
`float`	`getIntensity()`
`void`	`prepare(int width, int height)` Prepare the light for rendering.
`void`	`setAzimuth(float azimuth)`
`void`	`setCentreX(float x)` Set the centre of the light in the X direction as a proportion of the image size.
`void`	`setCentreY(float y)` Set the centre of the light in the Y direction as a proportion of the image size.
`void`	`setColor(int color)`
`void`	`setConeAngle(float coneAngle)`
`void`	`setDistance(float distance)`
`void`	`setElevation(float elevation)`
`void`	`setFocus(float focus)`
`void`	`setIntensity(float intensity)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - type
```
int type
```
  - position
```
Vector3f position
```
  - direction
```
Vector3f direction
```
  - realColor
```
Color4f realColor
```
  - color
```
int color
```
  - intensity
```
float intensity
```
  - azimuth
```
float azimuth
```
  - elevation
```
float elevation
```
  - focus
```
float focus
```
  - centreX
```
float centreX
```
  - centreY
```
float centreY
```
  - coneAngle
```
float coneAngle
```
  - cosConeAngle
```
float cosConeAngle
```
  - distance
```
float distance
```
- Constructor Detail
  - Light
```
public Light()
```
  - Light
```
public Light(float azimuth,
             float elevation,
             float intensity)
```
- Method Detail
  - setAzimuth
```
public void setAzimuth(float azimuth)
```
  - getAzimuth
```
public float getAzimuth()
```
  - setElevation
```
public void setElevation(float elevation)
```
  - getElevation
```
public float getElevation()
```
  - setDistance
```
public void setDistance(float distance)
```
  - getDistance
```
public float getDistance()
```
  - setIntensity
```
public void setIntensity(float intensity)
```
  - getIntensity
```
public float getIntensity()
```
  - setConeAngle
```
public void setConeAngle(float coneAngle)
```
  - getConeAngle
```
public float getConeAngle()
```
  - setFocus
```
public void setFocus(float focus)
```
  - getFocus
```
public float getFocus()
```
  - setColor
```
public void setColor(int color)
```
  - getColor
```
public int getColor()
```
  - setCentreX
```
public void setCentreX(float x)
```
    Set the centre of the light in the X direction as a proportion of the image size.
    
    Parameters:
    
    x - the center
    
    See Also:
    
    getCentreX()
  - getCentreX
```
public float getCentreX()
```
    Get the centre of the light in the X direction as a proportion of the image size.
    
    Returns:
    
    the center
    
    See Also:
    
    setCentreX(float)
  - setCentreY
```
public void setCentreY(float y)
```
    Set the centre of the light in the Y direction as a proportion of the image size.
    
    Parameters:
    
    y - the center
    
    See Also:
    
    getCentreY()
  - getCentreY
```
public float getCentreY()
```
    Get the centre of the light in the Y direction as a proportion of the image size.
    
    Returns:
    
    the center
    
    See Also:
    
    setCentreY(float)
  - prepare
```
public void prepare(int width,
                    int height)
```
    Prepare the light for rendering.
    
    Parameters:
    
    width - the output image width
    
    height - the output image height
  - clone
```
public java.lang.Object clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class LightFilter.Light

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

type

position

direction

realColor

color

intensity

azimuth

elevation

focus

centreX

centreY

coneAngle

cosConeAngle

distance

Constructor Detail

Light

Light

Method Detail

setAzimuth

getAzimuth

setElevation

getElevation

setDistance

getDistance

setIntensity

getIntensity

setConeAngle

getConeAngle

setFocus

getFocus

setColor

getColor

setCentreX

getCentreX

setCentreY

getCentreY

prepare

clone

toString