Photometric Lights Common Properties, Operators, and Methods

General Parameters Rollout

<Photometric_Light>.on Boolean default: true -- boolean 		  

<Photometric_Light>.targetDistance Float default: 240.0 -- animatable; float; Target_Distance 		

<Photometric_Light>.castShadows BooleanClass default: false -- boolean; Cast_Shadows 	 

<Photometric_Light>.useGlobalShadowSettings BooleanClass default: false -- boolean; Use_Global_Params   

<Photometric_Light>.shadowGenerator shadowMap default: shadowMap:shadowMap -- value; SubAnim 

<Photometric_Light>.shadowGeneratorByName String default: "Shadow Map" -- value 

<Photometric_Light>.raytracedShadows BooleanClass default: false -- value 

<Photometric_Light>.excludeList Array default: #() -- value 

<Photometric_Light>.includeList UndefinedClass default: undefined -- value; !error setting value! 

<Photometric_Light>.distribution Integer default: 0 -- value 

Intensity/Color/Attenuation Rollout

<Photometric_Light>.color Color default:(color 265.933 250.885 263.562)-- color by value 

<Photometric_Light>.useKelvin BooleanClass default: false -- boolean; Use_Kelvin 

<Photometric_Light>.kelvin Float default: 3600.0 -- animatable; float 

<Photometric_Light>.rgbFilter Color default: (color 255 255 255) -- animatable; RGB color; Filter_Color; Controller Scaling: ([1,1,1] : (color 255 255 255)) ) 

<Photometric_Light>.intensityType Integer default: 1 -- integer; Intensity_Type 

<Photometric_Light>.intensityFloat default: 1500.0 -- animatable; float 

<Photometric_Light>.intensityAt Float default: 39.3701 -- float; Intensity_At 

<Photometric_Light>.flux Float default: 0.0 -- float 

<Photometric_Light>.originalFlux Float default: 0.0 -- float 

<Photometric_Light>.originalIntensity Float default: 0.0 -- float; Shape_Area_Shadows 

<Photometric_Light>.useMultiplier BooleanClass default: false -- boolean; Use_Dimmer 

<Photometric_Light>.Multiplier Float default: 100.0 -- animatable; float 

<Photometric_Light>.shiftColorWhenDimming BooleanClass default: false -- boolean; Shift_Color_When_Dimming 

<Photometric_Light>.useFarAttenuation BooleanClass default: false -- boolean; Use_Far_Attenuation 

<Photometric_Light>.displayFarAttenuationGizmo BooleanClass default: false -- boolean; Display_Far_Attenuation_Gizmo 

<Photometric_Light>.startFarAttenuation Float default: 80.0 -- animatable; worldUnits; Start_Far_Attenuation 

<Photometric_Light>.endFarAttenuation Float default: 200.0 -- animatable; worldUnits;Vertical_Circle_Facing_Photometric_Horizontal 

Shape / Area Shadows Rollout

<Photometric_Light>.type Name default: #Free_Point -- value 

Get/Set the Type of the Photometric Light.

Possible values are:

#Free_Point

#Free_Line

#Free_Rectangle

#Free_Disc

#Free_Sphere

#Free_Cylinder

#Target_Point

#Target_Line

#Target_Rectangle

#Target_Disc

#Target_Sphere

#Target_Cylinder

Exposed by LightProperties interface .

<Photometric_Light>.light_length Float default:122.0 -- animatable; worldUnits 

Get/set the length of the Area light where applicable.

<Photometric_Light>.light_width Float default:61.0 -- animatable; worldUnits 

Get/set the width of the Area light where applicable.

<Photometric_Area>.light_radius Float default: 13.0 -- animatable; worldUnits 

Get/set the radius of the Area light where applicable.

<Photometric_Light>.length Float default:122.0 --float 

Get/set the length of the Area light.

<Photometric_Light>.width Float default: 61.0 -- float 

Get/set the width of the Area light.

Distribution (Spotlight) Rollout

<Photometric_Light>.showCone BooleanClass default: false -- boolean; Cone_Display 

Get/set the state of the "Cone visible in viewport when unselected" checkbox.

<Photometric_Light>.hotSpot Float default: 30.0 -- animatable; float; Beam_Angle 

Get/set the Hotspot/Beam angle. Used only when .distribution is set to 1 - Spotlight.

<Photometric_Light>.falloff Float default: 60.0 -- animatable; float; Field_Angle 

Get/set the Hotspot/Beam angle. Used only when .distribution is set to 1 - Spotlight.

Distribution (Photometric File) Rollout

<Photometric_Light>.webFile String default: "" -- filename; Web_Filename 

The Web file used when .distribution is set to 0 - Web.

<Photometric_Light>.xRotation Float default: 0.0 -- float; X_Rotation 

The Photometric Web X rotation value. Used only when .distribution is set to 0 - Web.

<Photometric_Light>.yRotation Float default: 0.0 -- float; Y_Rotation 

The Photometric Web Y rotation value.Used only when .distribution is set to 0 - Web.

<Photometric_Light>.zRotation Float default: 0.0 -- float; Z_Rotation 

ThePhotometric WebZrotation value.Used only when .distribution is set to 0 - Web.

Shadow Parameters Rollout

<Photometric_Light>.shadowColor Color default: (color 0 0 0) -- animatable; RGB color; Shadow_Color; Controller Scaling: ([1,1,1] : (color 255 255 255)) 

<Photometric_Light>.shadowMultiplier Float default: 1.0 -- animatable; float; Shadow_Density

<Photometric_Light>.shadowColorMapEnable BooleanClass default: false -- boolean; Use_Shadow_Color_Map 

<Photometric_Light>.shadowProjectorMap UndefinedClass default: undefined -- texturemap; Shadow_Projector_Map 

<Photometric_Light>.lightAffectsShadow BooleanClass default: false -- boolean; Light_Affects_Shadow 

<Photometric_Light>.atmosShadows BooleanClass default: false -- boolean; Atmospheric_Shadows_On 

<Photometric_Light>.atmosColorAmt Float default: 100.0 -- animatable; float; Atmospheric_Color_Amount 

<Photometric_Light>.atmosOpacity Float default: 100.0 -- animatable; float; Atmospheric_Opacity 

Advanced Effects Rollout

<Photometric_Light>.contrast Float default: 0.0 -- animatable; float; Light_Contrast 

Get/Set the Light Contrast value.

<Photometric_Light>.softenDiffuseEdge Float default: 0.0 -- animatable; float; Diffuse_Soften 

Get/Set the Soften Diff. Edge value.

<Photometric_Light>.affectDiffuse BooleanClass default: true -- boolean; Affect_Diffuse 

When true , the light affects the diffuse color.

<Photometric_Light>.affectSpecular BooleanClass default: true -- boolean; Affect_Diffuse 

When true , the light affects the specular color.

<Photometric_Light>.ambientOnly BooleanClass default: false -- boolean; Ambient_Only 

When set to true, the light affects the Ambient color only. 

<Photometric_Light>.projector BooleanClass default: false -- boolean 

Toggle the projector map on/off.

<Photometric_Light>.projectorMap UndefinedClass default: undefined -- texturemap; Projector_Map 

Get/Set the projector map.

The following interface is explosed by all Photometric Lights:

Interface:LightProperties 

Properties:

.type: value : Read|Write 

Get/Set the Type of the Photometric Light.

Possible values are:

#Free_Point

#Free_Line

#Free_Rectangle

#Free_Disc

#Free_Sphere

#Free_Cylinder

#Target_Point

#Target_Line

#Target_Rectangle

#Target_Disc

#Target_Sphere

#Target_Cylinder

.distribution: value : Read|Write 

Get/Set thedistribution type.

Possible values are:

0 -Uniform Sphereical

1 -Spotlight (not valid for Sphere and Cylinder types)

2 -Uniform Hemispherical (not valid for Sphere and Cylinder types)

3 -Photometric Web File (not valid for Sphere and Cylinder types)

.excludeList: value : Read|Write 

Get/Set the exclusion list as an array on objects. When setting the value, the Include/Exlude option will be set to Exclude.

.includeList: value : Read|Write 

Get/Set an array of objects to be included in the illumination by the light. When setting the value, the Include/Exlude option will be set to Include.

.shadowGenerator: value : Read|Write 

Get/Set the Shadow Generator as class instance.

.shadowGeneratorByName: value : Read|Write 

Get/Set the Shadow Generator by name.

.raytracedShadows: value : Read|Write 

Get/Set use of raytraced shadows.

.color: color by value : Read|Write 

Get/Set the color.

.enabled: bool : Read|Write 

Get/Set the enabled state.