DirectionalLight class / three Library / Dart Documentation

DirectionalLight class

@author mr.doob / http://mrdoob.com/ @author alteredq / http://alteredqualia.com/

Ported to Dart from JS by: @author rob silverton / http://www.unwrong.com/ @author Nelson Silva

rev: r56

class DirectionalLight extends ShadowCaster {
 Vector3 position;
 Object3D target;
 num intensity, distance;

 num shadowCameraLeft, shadowCameraRight, shadowCameraTop, shadowCameraBottom;

 bool shadowCascade;

 Vector3 shadowCascadeOffset;
 num shadowCascadeCount;

 List shadowCascadeBias,
     shadowCascadeWidth,
     shadowCascadeHeight,
     shadowCascadeNearZ,
     shadowCascadeFarZ,
     shadowCascadeArray;

 DirectionalLight( num hex, [this.intensity = 1, this.distance = 0]) : super( hex ) {

   position = new Vector3( 0.0, 1.0, 0.0 );
   target = new Object3D();

   shadowCameraLeft = -500;
   shadowCameraRight = 500;
   shadowCameraTop = 500;
   shadowCameraBottom = -500;

   //

   shadowCascade = false;

   shadowCascadeOffset = new Vector3( 0.0, 0.0, -1000.0 );
   shadowCascadeCount = 2;

   shadowCascadeBias = [ 0, 0, 0 ];
   shadowCascadeWidth = [ 512, 512, 512 ];
   shadowCascadeHeight = [ 512, 512, 512 ];

   shadowCascadeNearZ = [ -1.000, 0.990, 0.998 ];
   shadowCascadeFarZ  = [  0.990, 0.998, 1.000 ];

   shadowCascadeArray = [];

 }
}

Extends

Object3D > Light > ShadowCaster > DirectionalLight

Subclasses

VirtualLight

Constructors

new DirectionalLight(num hex, [num intensity = 1, num distance = 0]) #

Creates a new Object instance.

Object instances have no meaningful state, and are only useful through their identity. An Object instance is equal to itself only.

docs inherited from Object

DirectionalLight( num hex, [this.intensity = 1, this.distance = 0]) : super( hex ) {

 position = new Vector3( 0.0, 1.0, 0.0 );
 target = new Object3D();

 shadowCameraLeft = -500;
 shadowCameraRight = 500;
 shadowCameraTop = 500;
 shadowCameraBottom = -500;

 //

 shadowCascade = false;

 shadowCascadeOffset = new Vector3( 0.0, 0.0, -1000.0 );
 shadowCascadeCount = 2;

 shadowCascadeBias = [ 0, 0, 0 ];
 shadowCascadeWidth = [ 512, 512, 512 ];
 shadowCascadeHeight = [ 512, 512, 512 ];

 shadowCascadeNearZ = [ -1.000, 0.990, 0.998 ];
 shadowCascadeFarZ  = [  0.990, 0.998, 1.000 ];

 shadowCascadeArray = [];

}

Properties

num boundRadius #

inherited from Object3D

num boundRadius

num boundRadiusScale #

inherited from Object3D

num boundRadius, boundRadiusScale

var cameraHelper #

inherited from ShadowCaster

var cameraHelper

bool castShadow #

inherited from ShadowCaster

bool castShadow

List children #

inherited from Object3D

List children

Color color #

inherited from Light

Color color

var customDepthMaterial #

inherited from Object3D

var customDepthMaterial

num distance #

num intensity, distance

bool doubleSided #

inherited from Object3D

bool _dynamic, doubleSided

String eulerOrder #

inherited from Object3D

String eulerOrder

bool flipSided #

inherited from Object3D

bool _dynamic, doubleSided, flipSided

bool frustumCulled #

inherited from Object3D

bool visible = false, castShadow = false, receiveShadow = false, frustumCulled = false

int id #

inherited from Object3D

int id

num intensity #

num intensity

bool isDynamic #

inherited from Object3D

bool get isDynamic => _dynamic;

set isDynamic(bool flag) => _dynamic = flag;

Matrix4 matrix #

inherited from Object3D

Matrix4 matrix

bool matrixAutoUpdate #

inherited from Object3D

bool matrixAutoUpdate = false

Matrix4 matrixRotationWorld #

inherited from Object3D

Matrix4 matrix, matrixWorld, matrixRotationWorld

Matrix4 matrixWorld #

inherited from Object3D

Matrix4 matrix, matrixWorld

bool matrixWorldNeedsUpdate #

inherited from Object3D

bool matrixAutoUpdate = false, matrixWorldNeedsUpdate = false

String name #

inherited from Object3D

String name

bool onlyShadow #

inherited from ShadowCaster

bool onlyShadow

Object3D parent #

inherited from Object3D

Object3D parent

Vector3 position #

Vector3 position

Map properties #

inherited from Object3D

Map properties

var quaternion #

inherited from Object3D

var quaternion

bool receiveShadow #

inherited from Object3D

bool visible = false, castShadow = false, receiveShadow = false

int renderDepth #

inherited from Object3D

int renderDepth

Vector3 rotation #

inherited from Object3D

Vector3 up, position, rotation

bool rotationAutoUpdate #

inherited from Object3D

bool _dynamic, doubleSided, flipSided, rotationAutoUpdate

Vector3 scale #

inherited from Object3D

Vector3 up, position, rotation, scale

num shadowBias #

inherited from ShadowCaster

num shadowBias

var shadowCamera #

inherited from ShadowCaster

var shadowCamera

num shadowCameraBottom #

num shadowCameraLeft, shadowCameraRight, shadowCameraTop, shadowCameraBottom

num shadowCameraFar #

inherited from ShadowCaster

num shadowCameraNear,
   shadowCameraFar

num shadowCameraFov #

inherited from ShadowCaster

num shadowCameraNear,
   shadowCameraFar,
   shadowCameraFov

num shadowCameraLeft #

num shadowCameraLeft

num shadowCameraNear #

inherited from ShadowCaster

num shadowCameraNear

num shadowCameraRight #

num shadowCameraLeft, shadowCameraRight

num shadowCameraTop #

num shadowCameraLeft, shadowCameraRight, shadowCameraTop

bool shadowCameraVisible #

inherited from ShadowCaster

bool shadowCameraVisible

bool shadowCascade #

bool shadowCascade

List shadowCascadeArray #

List shadowCascadeBias,
   shadowCascadeWidth,
   shadowCascadeHeight,
   shadowCascadeNearZ,
   shadowCascadeFarZ,
   shadowCascadeArray

List shadowCascadeBias #

List shadowCascadeBias

num shadowCascadeCount #

num shadowCascadeCount

List shadowCascadeFarZ #

List shadowCascadeBias,
   shadowCascadeWidth,
   shadowCascadeHeight,
   shadowCascadeNearZ,
   shadowCascadeFarZ

List shadowCascadeHeight #

List shadowCascadeBias,
   shadowCascadeWidth,
   shadowCascadeHeight

List shadowCascadeNearZ #

List shadowCascadeBias,
   shadowCascadeWidth,
   shadowCascadeHeight,
   shadowCascadeNearZ

Vector3 shadowCascadeOffset #

Vector3 shadowCascadeOffset

List shadowCascadeWidth #

List shadowCascadeBias,
   shadowCascadeWidth

num shadowDarkness #

inherited from ShadowCaster

num shadowDarkness

var shadowMap #

inherited from ShadowCaster

var shadowMap

num shadowMapHeight #

inherited from ShadowCaster

num shadowMapWidth,
   shadowMapHeight

var shadowMapSize #

inherited from ShadowCaster

var shadowMapSize

num shadowMapWidth #

inherited from ShadowCaster

num shadowMapWidth

var shadowMatrix #

inherited from ShadowCaster

var shadowMatrix

Object3D target #

Object3D target

Vector3 up #

inherited from Object3D

Vector3 up

bool useQuaternion #

inherited from Object3D

bool useQuaternion

bool visible #

inherited from Object3D

bool visible = false

Operators

dynamic operator [](String key) #

inherited from Object3D

operator [] (String key) => _data[key];

dynamic operator []=(String key, value) #

inherited from Object3D

operator []= (String key, value) => _data[key] = value;

Methods

void add(Object3D object) #

inherited from Object3D

void add( Object3D object ) {
 if ( object == this ) {
   print( 'THREE.Object3D.add: An object can\'t be added as a child of itself.' );
   return;
 }


 if ( object.parent != null ) {
   object.parent.remove( object );
 }

 object.parent = this;
 children.add( object );

 // add to scene
 Object3D scene = this;

 while ( scene.parent != null ) {
   scene = scene.parent;
 }

 if ( scene is Scene ) {
   scene.addObject( object );
 }

}

void applyMatrix(Matrix4 matrix) #

inherited from Object3D

void applyMatrix ( Matrix4 matrix ) {
 this.matrix = matrix * this.matrix;

 this.scale = getScaleFromMatrix( this.matrix );

 Matrix4 mat = extractRotation(new Matrix4.identity(), this.matrix );
 this.rotation = calcEulerFromRotationMatrix( mat, this.eulerOrder );

 this.position = this.matrix.getTranslation();
}

dynamic clone() #

inherited from Object3D

clone() {

 // TODO

}

Object3D getChildByName(String name, bool doRecurse) #

inherited from Object3D

Object3D getChildByName( String name, bool doRecurse ) {
 int c;
 int cl = children.length;
 Object3D child, recurseResult;

 children.forEach((child){

   if ( child.name == name ) {
     return child;
   }

   if ( doRecurse ) {
     recurseResult = child.getChildByName( name, doRecurse );

     if ( recurseResult != null ) {
       return recurseResult;
     }
   }
 });

 return null;
}

dynamic localToWorld(Vector3 vector) #

inherited from Object3D

localToWorld(Vector3 vector) => vector.applyProjection(matrixWorld);

void lookAt(Vector3 vector) #

inherited from Object3D

void lookAt( Vector3 vector ) {
 // TODO: Add hierarchy support.

 makeLookAt( matrix, vector, position, up );

 if ( rotationAutoUpdate ) {
   if(useQuaternion)
     quaternion.setFromRotationMatrix(matrix);
   else
     rotation = calcEulerFromRotationMatrix( matrix, eulerOrder );
 }
}

void remove(Object3D object) #

inherited from Object3D

void remove( Object3D object ) {

 int index = children.indexOf( object );

 if ( index != - 1 ){

   object.parent = null;
   children.removeAt(index);

   // remove from scene
   Object3D scene = this;

   while ( scene.parent != null ) {
     scene = scene.parent;
   }

   if (scene is Scene ) {
     scene.removeObject( object );
   }
 }
}

void translate(num distance, Vector3 axis) #

inherited from Object3D

void translate( num distance, Vector3 axis ) {
 matrix.rotate3( axis );
 axis.normalize();
 position.add( axis.scale( distance ) );
}

void translateX(num distance) #

inherited from Object3D

void translateX( num distance ) => translate( distance, _vector.setValues( 1.0, 0.0, 0.0 ) );

void translateY(num distance) #

inherited from Object3D

void translateY( num distance ) => translate( distance, _vector.setValues( 0.0, 1.0, 0.0 ) );

void translateZ(num distance) #

inherited from Object3D

void translateZ( num distance ) => translate( distance, _vector.setValues( 0.0, 0.0, 1.0 ) );

void updateMatrix() #

inherited from Object3D

void updateMatrix() {

 if ( useQuaternion ) {
   setRotationFromQuaternion( matrix, quaternion );
 } else {
   setRotationFromEuler( matrix, rotation, eulerOrder );
 }

 matrix.setTranslation( position );

 if ( scale.x != 1.0 || scale.y != 1.0 || scale.z != 1.0 ) {
   matrix.scale( scale );
   boundRadiusScale = Math.max( scale.x, Math.max( scale.y, scale.z ) );
 }

 matrixWorldNeedsUpdate = true;
}

void updateMatrixWorld({bool force: false}) #

inherited from Object3D

void updateMatrixWorld( {bool force: false} ) {

if (matrixAutoUpdate) updateMatrix();

 // update matrixWorld
 if ( matrixWorldNeedsUpdate || force ) {
   if ( parent != null ) {
     matrixWorld = parent.matrixWorld * matrix;
   } else {
     matrixWorld = matrix.clone();
   }

   matrixWorldNeedsUpdate = false;

   force = true;
 }

 // update children
 children.forEach((c) => c.updateMatrixWorld( force: force ) );

}

dynamic worldToLocal(Vector3 vector) #

inherited from Object3D

worldToLocal(Vector3 vector) {
 Matrix4 m = this.matrixWorld.clone();
 m.invert();
 m.transform3( vector );
}

DirectionalLight class

Extends

Subclasses

Constructors

Code new DirectionalLight(num hex, [num intensity = 1, num distance = 0]) #

Properties

Code num boundRadius #

Code num boundRadiusScale #

Code var cameraHelper #

Code bool castShadow #

Code List children #

Code Color color #

Code var customDepthMaterial #

Code num distance #

Code bool doubleSided #

Code String eulerOrder #

Code bool flipSided #

Code bool frustumCulled #

Code int id #

Code num intensity #

Code bool isDynamic #

Code Matrix4 matrix #

Code bool matrixAutoUpdate #

Code Matrix4 matrixRotationWorld #

Code Matrix4 matrixWorld #

Code bool matrixWorldNeedsUpdate #

Code String name #

Code bool onlyShadow #

Code Object3D parent #

Code Vector3 position #

Code Map properties #

Code var quaternion #

Code bool receiveShadow #

Code int renderDepth #

Code Vector3 rotation #

Code bool rotationAutoUpdate #

Code Vector3 scale #

Code num shadowBias #

Code var shadowCamera #

Code num shadowCameraBottom #

Code num shadowCameraFar #

Code num shadowCameraFov #

Code num shadowCameraLeft #

Code num shadowCameraNear #

Code num shadowCameraRight #

Code num shadowCameraTop #

Code bool shadowCameraVisible #

Code bool shadowCascade #

Code List shadowCascadeArray #

Code List shadowCascadeBias #

Code num shadowCascadeCount #

Code List shadowCascadeFarZ #

Code List shadowCascadeHeight #

Code List shadowCascadeNearZ #

Code Vector3 shadowCascadeOffset #

Code List shadowCascadeWidth #

Code num shadowDarkness #

Code var shadowMap #

Code num shadowMapHeight #

Code var shadowMapSize #

Code num shadowMapWidth #

Code var shadowMatrix #

Code Object3D target #

Code Vector3 up #

Code bool useQuaternion #

Code bool visible #

Operators

Code dynamic operator [](String key) #

Code dynamic operator []=(String key, value) #

Methods

Code void add(Object3D object) #

Code void applyMatrix(Matrix4 matrix) #

Code dynamic clone() #

Code Object3D getChildByName(String name, bool doRecurse) #

Code dynamic localToWorld(Vector3 vector) #

Code void lookAt(Vector3 vector) #

Code void remove(Object3D object) #

Code void translate(num distance, Vector3 axis) #

Code void translateX(num distance) #

Code void translateY(num distance) #

new DirectionalLight(num hex, [num intensity = 1, num distance = 0]) #

num boundRadius #

num boundRadiusScale #

var cameraHelper #

bool castShadow #

List children #

Color color #

var customDepthMaterial #

num distance #

bool doubleSided #

String eulerOrder #

bool flipSided #

bool frustumCulled #

int id #

num intensity #

bool isDynamic #

Matrix4 matrix #

bool matrixAutoUpdate #

Matrix4 matrixRotationWorld #

Matrix4 matrixWorld #

bool matrixWorldNeedsUpdate #

String name #

bool onlyShadow #

Object3D parent #

Vector3 position #

Map properties #

var quaternion #

bool receiveShadow #

int renderDepth #

Vector3 rotation #

bool rotationAutoUpdate #

Vector3 scale #

num shadowBias #

var shadowCamera #

num shadowCameraBottom #

num shadowCameraFar #

num shadowCameraFov #

num shadowCameraLeft #

num shadowCameraNear #

num shadowCameraRight #

num shadowCameraTop #

bool shadowCameraVisible #

bool shadowCascade #

List shadowCascadeArray #

List shadowCascadeBias #

num shadowCascadeCount #

List shadowCascadeFarZ #

List shadowCascadeHeight #

List shadowCascadeNearZ #

Vector3 shadowCascadeOffset #

List shadowCascadeWidth #

num shadowDarkness #

var shadowMap #

num shadowMapHeight #

var shadowMapSize #

num shadowMapWidth #

var shadowMatrix #

Object3D target #

Vector3 up #

bool useQuaternion #

bool visible #

dynamic operator [](String key) #

dynamic operator []=(String key, value) #

void add(Object3D object) #

void applyMatrix(Matrix4 matrix) #

dynamic clone() #

Object3D getChildByName(String name, bool doRecurse) #

dynamic localToWorld(Vector3 vector) #

void lookAt(Vector3 vector) #

void remove(Object3D object) #

void translate(num distance, Vector3 axis) #

void translateX(num distance) #

void translateY(num distance) #

void translateZ(num distance) #

void updateMatrix() #

void updateMatrixWorld({bool force: false}) #

dynamic worldToLocal(Vector3 vector) #