PvLightIf ("JavaView Reference Manual")

All Superinterfaces:

PgGeometryIf, PsUpdateIf

All Known Implementing Classes:

PvLight
```
public interface PvLightIf
extends PgGeometryIf
```
Interface for lights used in the JavaView display. Additional to the built-in lights of JavaView a user may add third-party lights fulfilling this interface to any JavaView display.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`LIGHT_AMBIENT` Non-directional global illumination of scene.
`static int`	`LIGHT_DIRECTION` Directional global illumination of scene with parallel light.
`static int`	`LIGHT_HEAD` Headlight always shines from the position of the camera, i.e. observer, on the scene.
`static int`	`LIGHT_POINT` Point light source shines in all direction from point in space.
`static int`	`LIGHT_SHADOW` Shadow light simply produces a shadow on other geometries.
`static int`	`LIGHT_SKY` Vertical light shines from north pole of the sky dome on the scene.
`static int`	`LIGHT_SPOT` Directional illumination of a part of scene which lies within the spot cone.
`static int`	`MODEL_LIGHT` Additionally to surface material use lighting information obtained from lights.
`static int`	`MODEL_SURFACE` Use surface color and global material properties of a geometry.
`static int`	`REFERENCE_CAMERA` Light position is given relative to the camera coordinate system.
`static int`	`REFERENCE_SCENE` Light position is given relative to the scene coordinate system (default).
`static int`	`SHADING_FULLSPHERE` Shading function illuminates full of sphere with decay towards opposite pole.
`static int`	`SHADING_HALFSPHERE` Shading function illuminates visible half of sphere with decay towards equator.
`static int`	`SHADING_SYMMETRIC` Shading function illuminates full sphere with symmetric half sphere shading.

Fields inherited from interface jv.project.PgGeometryIf
AMBIENT_H2_HYPERBOLIC, AMBIENT_H3_HYPERBOLIC, AMBIENT_H4_HYPERBOLIC, AMBIENT_PROJECTIONS, AMBIENT_R1_EUCLIDEAN, AMBIENT_R2_EUCLIDEAN, AMBIENT_R3_EUCLIDEAN, AMBIENT_R4_EUCLIDEAN, AMBIENT_R5_EUCLIDEAN, AMBIENT_S1_SPHERE, AMBIENT_S2_SPHERE, AMBIENT_S3_SPHERE, AMBIENT_S4_SPHERE, AMBIENT_SPACES, BLEND_ALPHA, BLEND_MATERIAL, BLEND_REPLACE, FILTER_DIRECT, FILTER_LINEAR, FILTER_QUADRATIC, HAS_METHOD_MENU, INSPECTOR_CONTROL, INSPECTOR_CONTROL_EXT, INSPECTOR_MATERIAL, INSPECTOR_MATERIAL_EXT, INSPECTOR_TEXTURE, INSPECTOR_TEXTURE_EXT, LABEL_BASE, LABEL_CENTER, LABEL_HEAD, LABEL_MIDDLE, LABEL_TAIL, LABEL_TOP, m_numLabelTypes, METHOD_EXT, PERIODIC_BOTH, PERIODIC_HEIGHT, PERIODIC_NONE, PERIODIC_WIDTH, PROJ_KLEIN_BALL, PROJ_PARALLEL, PROJ_POINCARE_BALL, PROJ_STEREOGRAPHIC, PROJ_UPPER_HALFSPACE, SIDE_BACK, SIDE_BOTH, SIDE_FRONT, SIDE_NONE

Method Summary

Methods
Modifier and Type	Method and Description
`double`	`getAngle()` Get angle of spot cone of light.
`java.awt.Color`	`getColor()` Get color of light.
`double`	`getCorona()` Get angle of corona of spot cone.
`double`	`getExponent()` Get exponent which determines the size of a highlight.
`double`	`getFalloff()` Get fall off angle of spot cone.
`double`	`getIntensity()` Get intensity of light.
`PdVector`	`getInterest()` Get interest of light.
`int`	`getLightType()` Get type of the light among public variables like `LIGHT_AMBIENT`.
`PdVector`	`getPosition()` Get position of light.
`int`	`getReference()` Get reference coordinate system of the light among public variables like `REFERENCE_SCENE`.
`int`	`getShading()` Get shading type of the light among public variables like `SHADING_SYMMETRIC`.
`boolean`	`isHighlight()` Determines if light throughs a highlight.
`boolean`	`isSwitchedOn()` Get flag if light is currently switched on within the scene, i.e. whether is contributes to the total light.
`void`	`setAngle(double angle)` Set angle of spot cone of light.
`void`	`setColor(java.awt.Color color)` Set color of light.
`void`	`setCorona(double corona)` Set angle of corona of spot cone.
`void`	`setExponent(double exponent)` Set exponent which determines the size of a highlight.
`void`	`setFalloff(double falloff)` Set fall off angle of spot cone.
`void`	`setHighlight(boolean bHighlight)` Enables if light throughs a highlight.
`void`	`setIntensity(double intensity)` Set intensity of light.
`void`	`setInterest(double x, double y, double z)` Set interest of light.
`void`	`setInterest(PdVector interest)` Set interest of light.
`void`	`setLightType(int lightType)` Set type of the light among public variables like `LIGHT_AMBIENT`.
`void`	`setName(java.lang.String name)` Set name of instance.
`void`	`setPosition(double x, double y, double z)` Set position of light.
`void`	`setPosition(PdVector position)` Set position of light.
`void`	`setReference(int reference)` Set reference coordinate system of the light among public variables like `REFERENCE_SCENE`.
`void`	`setShading(int shading)` Set shading type of the light among public variables like `SHADING_SYMMETRIC`.
`void`	`setSwitchedOn(boolean flag)` Set flag if light is currently switched on within the scene, i.e. whether is contributes to the total light.

Methods inherited from interface jv.project.PgGeometryIf
addDisplay, addElement, addPolygon, addVertex, assureInspector, blend, clearTagElement, clearTagPolygon, clearTagVertex, clone, fillMethodMenu, fillMethodMenu, getAmbientInvMatrix, getAmbientMatrix, getAmbientProjection, getAmbientSpace, getAuthorInfo, getControlPanel, getDimOfSimplex, getDimOfVertices, getDisplays, getElement, getGeometryInfo, getInfoPanel, getJvx, getMaterialPanel, getModelMatrix, getName, getPolygon, getTextureImage, getTextureImageName, getTitle, getType, getVertex, hasAmbientMatrix, hasDisplay, hasModelMatrix, hasTag, hasTagElement, hasTagPolygon, hasTagVertex, intersectionWithLine, isConfigurable, isVisible, merge, paint, reflect, removeDisplay, removeElement, removeMethodMenus, removePolygon, removeVertex, setAmbientMatrix, setAmbientProjection, setAmbientSpace, setAuthorInfo, setElement, setGeometryInfo, setJvx, setModelMatrix, setPolygon, setState, setTagElement, setTagPolygon, setTagVertex, setTextureImage, setTextureImageName, setTitle, setVertex, setVisible, toString

Methods inherited from interface jv.object.PsUpdateIf
getFather, setParent, update

- Field Detail
  - MODEL_SURFACE
```
static final int MODEL_SURFACE
```
    Use surface color and global material properties of a geometry.
    
    See Also:
    Constant Field Values
  - MODEL_LIGHT
```
static final int MODEL_LIGHT
```
    Additionally to surface material use lighting information obtained from lights.
    
    See Also:
    Constant Field Values
  - REFERENCE_SCENE
```
static final int REFERENCE_SCENE
```
    Light position is given relative to the scene coordinate system (default).
    
    Since:
    
    JavaView 3.90.021
    
    See Also:
    Constant Field Values
  - REFERENCE_CAMERA
```
static final int REFERENCE_CAMERA
```
    Light position is given relative to the camera coordinate system. In this case a light does not react on any viewing transformation.
    
    Since:
    
    JavaView 3.90.021
    
    See Also:
    Constant Field Values
  - LIGHT_AMBIENT
```
static final int LIGHT_AMBIENT
```
    Non-directional global illumination of scene.
    
    See Also:
    Constant Field Values
  - LIGHT_DIRECTION
```
static final int LIGHT_DIRECTION
```
    Directional global illumination of scene with parallel light.
    
    See Also:
    Constant Field Values
  - LIGHT_POINT
```
static final int LIGHT_POINT
```
    Point light source shines in all direction from point in space.
    
    See Also:
    Constant Field Values
  - LIGHT_SPOT
```
static final int LIGHT_SPOT
```
    Directional illumination of a part of scene which lies within the spot cone.
    
    See Also:
    Constant Field Values
  - LIGHT_SHADOW
```
static final int LIGHT_SHADOW
```
    Shadow light simply produces a shadow on other geometries.
    
    See Also:
    Constant Field Values
  - LIGHT_HEAD
```
static final int LIGHT_HEAD
```
    Headlight always shines from the position of the camera, i.e. observer, on the scene.
    
    See Also:
    Constant Field Values
  - LIGHT_SKY
```
static final int LIGHT_SKY
```
    Vertical light shines from north pole of the sky dome on the scene.
    
    See Also:
    Constant Field Values
  - SHADING_SYMMETRIC
```
static final int SHADING_SYMMETRIC
```
    Shading function illuminates full sphere with symmetric half sphere shading. HACK: value must correspond to ordering of items in PvLight_IP.
    
    Since:
    
    JavaView 3.90.022
    
    See Also:
    Constant Field Values
  - SHADING_HALFSPHERE
```
static final int SHADING_HALFSPHERE
```
    Shading function illuminates visible half of sphere with decay towards equator. Light illuminates only the front side of a sphere while leaving the back side black. HACK: value must correspond to ordering of items in PvLight_IP.
    
    Since:
    
    JavaView 3.90.022
    
    See Also:
    Constant Field Values
  - SHADING_FULLSPHERE
```
static final int SHADING_FULLSPHERE
```
    Shading function illuminates full of sphere with decay towards opposite pole. HACK: value must correspond to ordering of items in PvLight_IP.
    
    Since:
    
    JavaView 3.90.022
    
    See Also:
    Constant Field Values
- Method Detail
  - setName
```
void setName(java.lang.String name)
```
    Set name of instance. since JavaView 2.31
    
    Specified by:
    
    setName in interface PgGeometryIf
    
    See Also:
    PgGeometryIf.getName(), PgGeometryIf.setTitle(String)
  - getReference
```
int getReference()
```
    Get reference coordinate system of the light among public variables like REFERENCE_SCENE.
    
    Returns:
    reference coordinate system of this light source
    Since:
    
    JavaView 3.90.021
  - setReference
```
void setReference(int reference)
```
    Set reference coordinate system of the light among public variables like REFERENCE_SCENE.
    
    Parameters:
    reference - new reference coordinate system
    Since:
    
    JavaView 3.90.021
  - getShading
```
int getShading()
```
    Get shading type of the light among public variables like SHADING_SYMMETRIC.
    
    Returns:
    shading type of this light
    Since:
    
    JavaView 3.90.022
  - setShading
```
void setShading(int shading)
```
    Set shading type of the light among public variables like SHADING_SYMMETRIC.
    
    Parameters:
    shading - new shading type of this light
    Since:
    
    JavaView 3.90.022
  - getLightType
```
int getLightType()
```
    Get type of the light among public variables like LIGHT_AMBIENT.
    
    Returns:
    type of this light source
  - setLightType
```
void setLightType(int lightType)
```
    Set type of the light among public variables like LIGHT_AMBIENT.
    
    Parameters:
    lightType - new type of this light source
  - isSwitchedOn
```
boolean isSwitchedOn()
```
    Get flag if light is currently switched on within the scene, i.e. whether is contributes to the total light.
  - setSwitchedOn
```
void setSwitchedOn(boolean flag)
```
    Set flag if light is currently switched on within the scene, i.e. whether is contributes to the total light.
  - getPosition
```
PdVector getPosition()
```
    Get position of light.
    
    Returns:
    position is a 3d vector
  - setPosition
```
void setPosition(PdVector position)
```
    Set position of light.
    
    Parameters:
    position - position is a 3d vector
  - setPosition
```
void setPosition(double x,
               double y,
               double z)
```
    Set position of light.
    
    Parameters:
    x - x coordinate of position of light
    y - y coordinate of position of light
    z - z coordinate of position of light
  - getInterest
```
PdVector getInterest()
```
    Get interest of light.
    
    Returns:
    interest is a 3d position.
  - setInterest
```
void setInterest(PdVector interest)
```
    Set interest of light.
    
    Parameters:
    interest - interest is a 3d position.
  - setInterest
```
void setInterest(double x,
               double y,
               double z)
```
    Set interest of light.
    
    Parameters:
    x - x coordinate of interest of light
    y - y coordinate of interest of light
    z - z coordinate of interest of light
  - getColor
```
java.awt.Color getColor()
```
    Get color of light.
    
    Returns:
    color of light
  - setColor
```
void setColor(java.awt.Color color)
```
    Set color of light.
    
    Parameters:
    color - new color of light
  - getIntensity
```
double getIntensity()
```
    Get intensity of light.
    
    Returns:
    intensity of light
  - setIntensity
```
void setIntensity(double intensity)
```
    Set intensity of light.
    
    Parameters:
    intensity - intensity of light
  - getAngle
```
double getAngle()
```
    Get angle of spot cone of light.
    
    Returns:
    angle of spot cone of light
  - setAngle
```
void setAngle(double angle)
```
    Set angle of spot cone of light.
    
    Parameters:
    angle - angle of spot cone of light
  - getCorona
```
double getCorona()
```
    Get angle of corona of spot cone.
    
    Returns:
    angle of corona of spot cone
  - setCorona
```
void setCorona(double corona)
```
    Set angle of corona of spot cone.
    
    Parameters:
    corona - angle of corona of spot cone
  - getFalloff
```
double getFalloff()
```
    Get fall off angle of spot cone.
    
    Returns:
    fall off angle of spot cone
  - setFalloff
```
void setFalloff(double falloff)
```
    Set fall off angle of spot cone.
    
    Parameters:
    falloff - fall off angle of spot cone
  - getExponent
```
double getExponent()
```
    Get exponent which determines the size of a highlight.
    
    Returns:
    specular exponent
  - setExponent
```
void setExponent(double exponent)
```
    Set exponent which determines the size of a highlight.
    
    Parameters:
    exponent - specular exponent
  - isHighlight
```
boolean isHighlight()
```
    Determines if light throughs a highlight.
    
    Returns:
    flag if light throughs a highlight
    Since:
    
    JavaView 3.90.021
  - setHighlight
```
void setHighlight(boolean bHighlight)
```
    Enables if light throughs a highlight.
    
    Parameters:
    bHighlight - flag
    Since:
    
    JavaView 3.90.021

Interface PvLightIf

Field Summary

Fields inherited from interface jv.project.PgGeometryIf

Method Summary

Methods inherited from interface jv.project.PgGeometryIf

Methods inherited from interface jv.object.PsUpdateIf

Field Detail

MODEL_SURFACE

MODEL_LIGHT

REFERENCE_SCENE

REFERENCE_CAMERA

LIGHT_AMBIENT

LIGHT_DIRECTION

LIGHT_POINT

LIGHT_SPOT

LIGHT_SHADOW

LIGHT_HEAD

LIGHT_SKY

SHADING_SYMMETRIC

SHADING_HALFSPHERE

SHADING_FULLSPHERE

Method Detail

setName

getReference

setReference

getShading

setShading

getLightType

setLightType

isSwitchedOn

setSwitchedOn

getPosition

setPosition

setPosition

getInterest

setInterest

setInterest

getColor

setColor

getIntensity

setIntensity

getAngle

setAngle

getCorona

setCorona

getFalloff

setFalloff

getExponent

setExponent

isHighlight

setHighlight