vcanim.gif (8357 bytes)Light Attributes
Home ] Sales ] Products ] Services ] Support ] Downloads ]

 

 


Attributes Specific to Lights

AttributeName Get Set Fcrvs AttributeType Description
AreaFlag Y Y N Boolean TRUE for area lights. You must set AreaFlag to TRUE before setting the other Area attributes.
AreaRelative Y Y N Boolean If TRUE, the geometry area rotates relative to the light's local coordinate system. If FALSE, rotates relative to the global coordinate system.
AreaRotation Y Y larotx

laroty

larotz

float X

float Y

float Z

rotation of the geometry area icon.

SW returns this as a list: (X Y Z)

AreaSample Y Y N int Number of times the light is sampled in the U and V directions.

SW returns this as a list: (U V)

AreaScaling Y Y lasclx

lascly

lasclz

float

float

float

Scaling of the geometry area icon.

SW returns this as a list: (X Y Z)

AreaType Y Y N one of:

SAA_LA_RECTANGLE

SAA_LA_SPHERE

SAA_LA_DISK

SAA_LA_NONE

The type of geometry area around the light source:
Color Y Y lgr

lgr

lgb

float R

float G

float B

Color of the light.

SW returns a list: (R G B)

Element-Name Y Y N string Name of the light.
Element-Pointer Y Y N string Name of the Element structure for this light.This name may be passed to any SAA routine which requires a light
End Y Y lgend float (End Falloff)

Distance (in system units) at which the light intensity is not visible.

Include Y Y N SAA_Boolean If TRUE, associated elements are included in a selective light. If FALSE, associated elements are excluded.
Position Y Y lgetnx

lgetny

lgetnz

float

float

float

Position of the light.

SW returns this as a list

Selective Y Y N Boolean If TRUE, associated elements are either included or excluded in the light (see the Include attribute).

In SOFTIMAGE 3D, you use the Light -> Associate command to associate elements with a selective light.

Shadow Y Y lgumbr float Umbra intensity level for shadows (0 = black shadow, 1 = no shadow).
ShadowType Y Y N one of:

SAA_LS_NONE

SAA_LS_RAY_TRACED

SAA_LS_DEPTH_MAP

SAA_LS_SOFT_SHADOW

The type of shadow the light casts
Start Y Y lgstrt float (Start Falloff)

Distance (in system units) at which the light intensity starts to decrease in all directions.

Type Y N N one of:

SAA_LPOINT

SAA_LSPOT

SAA_LINFINITE

SAA_LSUN

What type of light this is
 
The following attributes are available ONLY to Sunlight, i.e. lights of type SAA_LSUN
 
sunlight_Time Y Y suntim float Time and date (the hours, minutes, day, month, and year used to calculate the exact position of the sun).
 
End of attributes are available only to Sunlight
 
The following attributes are available ONLY to Spotlights i.e. lights of type SAA_LSPOT
spotlight_Cone Y Y lgcone float Cone angle in degrees.
spotlight_FilterSize Y Y N int Size (in pixels) of a box filter used to soften penumbra shadow edges.
spotlight_FilterStep Y Y N int Pixel offset of the box filter from where it was previously applied.
spotlight_Interest Y Y lgietx

lgiety

lgietz

float x

float y

float z

Position of the spotlight interest.

SW returns this as a list: (X Y Z)

spotlight_MapResolution Y Y N int Resolution of the computed shadow map.
spotlight_Penumbra Y Y N float Penumbra factor of Soft shadows (see the lShadowType attribute).
spotlight_Spread Y Y lgsprd float Angle in degrees of decreasing light around the cone.
 
End of attributes are available only to Spotlights
 

See Also

SW_set


 

Behaviors Overview ] Behavior Evaluate ] Behavior Edit ] Debugger ] Console ] Find ] SAA Library ] SW library ] SWC library ] SWN library index ] SWU library ] Attributes Index ] Scripting Examples ]

copyright Video-Collage Inc.