Package bpy :: Module types :: Class AreaLamp

[frames] | no frames]

Class AreaLamp

The Area Lamp Object

Directional area lamp.

(no references to this struct found)

Instance Methods

[hide private]

animation_data_clear()
Clear animation on this this ID. (Inherited from bpy.types.ID)

AnimData

animation_data_create()
Create animation data to this ID, note that not all ID types support this. (Inherited from bpy.types.ID)

copy()
Create a copy of this datablock (not supported for all datablocks). (Inherited from bpy.types.ID)

Instance Variables

[hide private]

Texture

active_texture
Active texture slot being displayed. (Inherited from bpy.types.Lamp)

int in [0, 17]

active_texture_index
Index of active texture slot. (Inherited from bpy.types.Lamp)

AnimData (readonly)

animation_data
Animation data for this datablock. (Inherited from bpy.types.Lamp)

float array of 3 items in [-inf, inf]

color
Light color. (Inherited from bpy.types.Lamp)

boolean

diffuse
Lamp does diffuse shading. (Inherited from bpy.types.Lamp)

float in [-inf, inf]

distance
Falloff distance - the light is at half the original intensity at this point. (Inherited from bpy.types.Lamp)

boolean

dither
Use 2x2 dithering for sampling (Constant Jittered sampling).

float in [-inf, inf]

energy
Amount of light that the lamp emits. (Inherited from bpy.types.Lamp)

boolean

fake_user
Saves this datablock even if it has no users (Inherited from bpy.types.ID)

float in [-inf, inf]

gamma
Light gamma correction value.

boolean

jitter
Use noise for sampling (Constant Jittered sampling).

boolean

layer
Illuminates objects only on the same layer the lamp is on. (Inherited from bpy.types.Lamp)

Library (readonly)

library
Library file the datablock is linked from. (Inherited from bpy.types.ID)

string

name
Unique datablock ID name. (Inherited from bpy.types.ID)

boolean

negative
Lamp casts negative light. (Inherited from bpy.types.Lamp)

boolean

only_shadow
Causes light to cast shadows only without illuminating objects.

float in [0, 1]

shadow_adaptive_threshold
Threshold for Adaptive Sampling (Raytraced shadows).

float array of 3 items in [-inf, inf]

shadow_color
Color of shadows cast by the lamp.

boolean

shadow_layer
Causes only objects on the same layer to cast shadows.

enum

shadow_method
Method to compute lamp shadow with.

int in [1, 64]

shadow_ray_samples_x
Amount of samples taken extra (samples x samples).

int in [1, 64]

shadow_ray_samples_y
Amount of samples taken extra (samples x samples).

enum

shadow_ray_sampling_method
Method for generating shadow samples: Adaptive QMC is fastest, Constant QMC is less noisy but slower.

float in [-inf, inf]

shadow_soft_size
Light size for ray shadow sampling (Raytraced shadows).

enum

shape
Shape of the area lamp.

float in [-inf, inf]

size
Size of the area of the area Lamp, X direction size for Rectangle shapes.

float in [-inf, inf]

size_y
Size of the area of the area Lamp in the Y direction for Rectangle shapes.

boolean

specular
Lamp creates specular highlights. (Inherited from bpy.types.Lamp)

boolean

tag
Tools can use this to tag data, (initial state is undefined). (Inherited from bpy.types.ID)

Collection of LampTextureSlot (readonly)

textures
Texture slots defining the mapping and influence of textures. (Inherited from bpy.types.Lamp)

enum

type
Type of Lamp. (Inherited from bpy.types.Lamp)

boolean

umbra
Emphasize parts that are fully shadowed (Constant Jittered sampling).

int (readonly) in [0, 32767]

users
Number of times this datablock is referenced. (Inherited from bpy.types.ID)

Instance Variable Details

[hide private]

shadow_method

Method to compute lamp shadow with. in...

NOSHADOW
RAY_SHADOW

Type:: enum

shadow_ray_sampling_method

Method for generating shadow samples: Adaptive QMC is fastest, Constant QMC is less noisy but slower. in...

ADAPTIVE_QMC
CONSTANT_QMC
CONSTANT_JITTERED

Type:: enum

shape

Shape of the area lamp. in...

SQUARE
RECTANGLE

Type:: enum