Packageaway3d.materials.lightpickers
Classpublic class LightPickerBase
InheritanceLightPickerBase Inheritance NamedAssetBase Inheritance flash.events.EventDispatcher
Implements IAsset
Subclasses StaticLightPicker

LightPickerBase provides an abstract base clase for light picker classes. These classes are responsible for feeding materials with relevant lights. Usually, StaticLightPicker can be used, but LightPickerBase can be extended to provide more application-specific dynamic selection of lights.

See also

StaticLightPicker


Public Properties
 PropertyDefined By
  allPickedLights : Vector.<LightBase>
[read-only] A collection of all the collected lights.
LightPickerBase
 InheritedassetFullPath : Array
[read-only]
NamedAssetBase
 InheritedassetNamespace : String
[read-only]
NamedAssetBase
  assetType : String
[read-only] The type of the asset.
LightPickerBase
  castingDirectionalLights : Vector.<DirectionalLight>
[read-only] The collected directional lights that cast shadows to be used for shading.
LightPickerBase
  castingPointLights : Vector.<PointLight>
[read-only] The collected point lights that cast shadows to be used for shading.
LightPickerBase
  directionalLights : Vector.<DirectionalLight>
[read-only] The collected directional lights to be used for shading.
LightPickerBase
 Inheritedid : String
NamedAssetBase
  lightProbes : Vector.<LightProbe>
[read-only] The collected light probes to be used for shading.
LightPickerBase
  lightProbeWeights : Vector.<Number>
[read-only] The weights for each light probe, defining their influence on the object.
LightPickerBase
 Inheritedname : String
NamedAssetBase
  numCastingDirectionalLights : uint
[read-only] The maximum amount of directional lights that cast shadows.
LightPickerBase
  numCastingPointLights : uint
[read-only] The amount of point lights that cast shadows.
LightPickerBase
  numDirectionalLights : uint
[read-only] The maximum amount of directional lights that will be provided.
LightPickerBase
  numLightProbes : uint
[read-only] The maximum amount of light probes that will be provided.
LightPickerBase
  numPointLights : uint
[read-only] The maximum amount of point lights that will be provided.
LightPickerBase
 InheritedoriginalName : String
[read-only] The original name used for this asset in the resource (e.g.
NamedAssetBase
  pointLights : Vector.<PointLight>
[read-only] The collected point lights to be used for shading.
LightPickerBase
Protected Properties
 PropertyDefined By
  _allPickedLights : Vector.<LightBase>
LightPickerBase
  _castingDirectionalLights : Vector.<DirectionalLight>
LightPickerBase
  _castingPointLights : Vector.<PointLight>
LightPickerBase
  _directionalLights : Vector.<DirectionalLight>
LightPickerBase
  _lightProbes : Vector.<LightProbe>
LightPickerBase
  _lightProbeWeights : Vector.<Number>
LightPickerBase
  _numCastingDirectionalLights : uint
LightPickerBase
  _numCastingPointLights : uint
LightPickerBase
  _numDirectionalLights : uint
LightPickerBase
  _numLightProbes : uint
LightPickerBase
  _numPointLights : uint
LightPickerBase
  _pointLights : Vector.<PointLight>
LightPickerBase
Public Methods
 MethodDefined By
  
Creates a new LightPickerBase object.
LightPickerBase
 Inherited
assetPathEquals(name:String, ns:String):Boolean
NamedAssetBase
  
collectLights(renderable:IRenderable, entityCollector:EntityCollector):void
Updates set of lights for a given renderable and EntityCollector.
LightPickerBase
  
dispose():void
Disposes resources used by the light picker.
LightPickerBase
 Inherited
resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void
NamedAssetBase
Public Constants
 ConstantDefined By
 InheritedDEFAULT_NAMESPACE : String = default
[static]
NamedAssetBase
Property Detail
_allPickedLightsproperty
protected var _allPickedLights:Vector.<LightBase>

_castingDirectionalLightsproperty 
protected var _castingDirectionalLights:Vector.<DirectionalLight>

_castingPointLightsproperty 
protected var _castingPointLights:Vector.<PointLight>

_directionalLightsproperty 
protected var _directionalLights:Vector.<DirectionalLight>

_lightProbesproperty 
protected var _lightProbes:Vector.<LightProbe>

_lightProbeWeightsproperty 
protected var _lightProbeWeights:Vector.<Number>

_numCastingDirectionalLightsproperty 
protected var _numCastingDirectionalLights:uint

_numCastingPointLightsproperty 
protected var _numCastingPointLights:uint

_numDirectionalLightsproperty 
protected var _numDirectionalLights:uint

_numLightProbesproperty 
protected var _numLightProbes:uint

_numPointLightsproperty 
protected var _numPointLights:uint

_pointLightsproperty 
protected var _pointLights:Vector.<PointLight>

allPickedLightsproperty 
allPickedLights:Vector.<LightBase>  [read-only]

A collection of all the collected lights.


Implementation
    public function get allPickedLights():Vector.<LightBase>
assetTypeproperty 
assetType:String  [read-only]

The type of the asset.


Implementation
    public function get assetType():String
castingDirectionalLightsproperty 
castingDirectionalLights:Vector.<DirectionalLight>  [read-only]

The collected directional lights that cast shadows to be used for shading.


Implementation
    public function get castingDirectionalLights():Vector.<DirectionalLight>
castingPointLightsproperty 
castingPointLights:Vector.<PointLight>  [read-only]

The collected point lights that cast shadows to be used for shading.


Implementation
    public function get castingPointLights():Vector.<PointLight>
directionalLightsproperty 
directionalLights:Vector.<DirectionalLight>  [read-only]

The collected directional lights to be used for shading.


Implementation
    public function get directionalLights():Vector.<DirectionalLight>
lightProbesproperty 
lightProbes:Vector.<LightProbe>  [read-only]

The collected light probes to be used for shading.


Implementation
    public function get lightProbes():Vector.<LightProbe>
lightProbeWeightsproperty 
lightProbeWeights:Vector.<Number>  [read-only]

The weights for each light probe, defining their influence on the object.


Implementation
    public function get lightProbeWeights():Vector.<Number>
numCastingDirectionalLightsproperty 
numCastingDirectionalLights:uint  [read-only]

The maximum amount of directional lights that cast shadows.


Implementation
    public function get numCastingDirectionalLights():uint
numCastingPointLightsproperty 
numCastingPointLights:uint  [read-only]

The amount of point lights that cast shadows.


Implementation
    public function get numCastingPointLights():uint
numDirectionalLightsproperty 
numDirectionalLights:uint  [read-only]

The maximum amount of directional lights that will be provided.


Implementation
    public function get numDirectionalLights():uint
numLightProbesproperty 
numLightProbes:uint  [read-only]

The maximum amount of light probes that will be provided.


Implementation
    public function get numLightProbes():uint
numPointLightsproperty 
numPointLights:uint  [read-only]

The maximum amount of point lights that will be provided.


Implementation
    public function get numPointLights():uint
pointLightsproperty 
pointLights:Vector.<PointLight>  [read-only]

The collected point lights to be used for shading.


Implementation
    public function get pointLights():Vector.<PointLight>
Constructor Detail
LightPickerBase()Constructor
public function LightPickerBase()

Creates a new LightPickerBase object.

Method Detail
collectLights()method
public function collectLights(renderable:IRenderable, entityCollector:EntityCollector):void

Updates set of lights for a given renderable and EntityCollector. Always call super.collectLights() after custom overridden code.

Parameters

renderable:IRenderable
 
entityCollector:EntityCollector

dispose()method 
public function dispose():void

Disposes resources used by the light picker.