com.xj.anylogic.engine.presentation
Class Light3DDirectional

java.lang.Object
  com.xj.anylogic.engine.presentation.Light3D
      com.xj.anylogic.engine.presentation.Light3DDirectional

All Implemented Interfaces:

com.xj.anylogic.engine.internal.Child, com.xj.anylogic.engine.internal.presentation.Accessor3D_xjal, com.xj.anylogic.engine.internal.presentation.WorldObject3D_xjal, java.io.Serializable, java.lang.Cloneable

public class Light3DDirectional
extends Light3D

3D directional light, may be added to 3D groups for scene lighting
Directional source of light is located in some infinitely distant point. It shines in the specified direction. You can think of a directional source of light as the Sun.
Lighting is performed along the given direction which is specified using 2 angles: orientation around X and Z axes.

Author:

XJ Technologies Company Ltd. www.anylogic.com

See Also:

Light3D, Serialized Form

Constructor Summary

Light3DDirectional(boolean ispublic, double angleX, double angleZ, java.awt.Color diffuseColor, java.awt.Color specularColor, java.awt.Color ambientColor, boolean global)
Creates new 3D directional light

Method Summary

Light3DDirectional	clone() Creates and returns a copy of this light (i.e. new light instance).
Element3D_xjal	get3DElement_xjal() This method is internal and shouldn't be accessed by user.
float	getAngleX() Returns the orientation of the light around X axis (CW, from +Y to +Z).
float	getAngleZ() Returns the orientation of the light around Z axis (CW, from +X to +Y).
void	restoreOwner(java.lang.Object owner) This method normally should not be called by user This method restores owner of this object The method is used in snapshot saving/loading
void	set3DElement_xjal(Element3D_xjal element3D) This method is internal and shouldn't be accessed by user.
void	setAngleX(double angleX) Sets the orientation of the light around X axis (CW, from +Y to +Z).
void	setAngleZ(double angleZ) Sets the orientation of the light around Z axis (CW, from +X to +Y).
void	setContextReference_xjal(Presentable contextReference) This method is internal and shouldn't be accessed by user.

Methods inherited from class com.xj.anylogic.engine.presentation.Light3D

getAmbientColor, getDiffuseColor, getGroup, getName, getPresentable, getSpecularColor, isEnabled, isGlobal, setAmbientColor, setDiffuseColor, setEnabled, setGlobal, setSpecularColor, update

Methods inherited from class java.lang.Object

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

Constructor Detail

Light3DDirectional

public Light3DDirectional(boolean ispublic,
                          double angleX,
                          double angleZ,
                          java.awt.Color diffuseColor,
                          java.awt.Color specularColor,
                          java.awt.Color ambientColor,
                          boolean global)

Creates new 3D directional light

Parameters:

ispublic - if true, the light persists on container's presentation

angleX - the orientation around X axis (CW, from +Y to +Z), in radians

angleZ - the orientation around Z axis (CW, from +X to +Y), in radians

diffuseColor - the diffuse color component

specularColor - the specular color component

ambientColor - the ambient color component

global - if true, the light affects shapes outside the group the light is placed in

Method Detail

getAngleZ

public float getAngleZ()

Returns the orientation of the light around Z axis (CW, from +X to +Y).
Zero angle value corresponds to orientation of the light towards -Y direction (to the North).

Returns:

the orientation around Z axis (CW, from +X to +Y), in radians

setAngleZ

public void setAngleZ(double angleZ)

Sets the orientation of the light around Z axis (CW, from +X to +Y).
Zero angle value corresponds to orientation of the light towards -Y direction (to the North).

Parameters:

angleZ - the new value of orientation around Z axis (CW, from +X to +Y), in radians

getAngleX

public float getAngleX()

Returns the orientation of the light around X axis (CW, from +Y to +Z).
Zero angle value corresponds to horizontal orientation of the light (parallel with XY-plane).

Returns:

orientation around X axis (CW, from +Y to +Z), in radians

setAngleX

public void setAngleX(double angleX)

Sets the orientation of the light around X axis (CW, from +Y to +Z).
Zero angle value corresponds to horizontal orientation of the light (parallel with XY-plane).

Parameters:

angleX - the new value of orientation around X axis (CW, from +Y to +Z), in radians

clone

public final Light3DDirectional clone()

Description copied from class: Light3D

Creates and returns a copy of this light (i.e. new light instance).
The returned light has the same type and parameters
The returned copy isn't automatically added to the group this light belongs to.
The clone is created in the context of the same active object

Overrides:

clone in class Light3D

restoreOwner

public final void restoreOwner(java.lang.Object owner)

This method normally should not be called by user
This method restores owner of this object
The method is used in snapshot saving/loading

Specified by:

restoreOwner in interface com.xj.anylogic.engine.internal.Child

Parameters:

owner - owner of this object, usually ActiveObject, Experiment or ShapeGroup

setContextReference_xjal

public void setContextReference_xjal(Presentable contextReference)

Description copied from interface: com.xj.anylogic.engine.internal.presentation.WorldObject3D_xjal

This method is internal and shouldn't be accessed by user.
It is public due to technical reasons.

Specified by:

setContextReference_xjal in interface com.xj.anylogic.engine.internal.presentation.WorldObject3D_xjal

set3DElement_xjal

public void set3DElement_xjal(Element3D_xjal element3D)

Description copied from interface: com.xj.anylogic.engine.internal.presentation.Accessor3D_xjal

This method is internal and shouldn't be accessed by user.
It is public due to technical reasons.

Specified by:

set3DElement_xjal in interface com.xj.anylogic.engine.internal.presentation.Accessor3D_xjal

get3DElement_xjal

public Element3D_xjal get3DElement_xjal()

Description copied from interface: com.xj.anylogic.engine.internal.presentation.Accessor3D_xjal

This method is internal and shouldn't be accessed by user.
It is public due to technical reasons.

Specified by:

get3DElement_xjal in interface com.xj.anylogic.engine.internal.presentation.Accessor3D_xjal