Provides script language access to C++ objects of this type.
Function members are as follows:
Return Type | Function Name | Documentation |
---|---|---|
int32 | GetModelViewMatrix | Retrieves the current shadow map camera matrix. This matrix defines the transform from world coordinate into the <Light> object's point of view. The <Light> faces towards the negative Z-axis, with the X-axis to the right, and the Y-axis up. |
int32 | GetProjectionMatrix | Retrieves the current shadow map projection matrix. This matrix defines the projection from the <Light> object's point of view and orientation into 2D shadow map coordinates. |
<Matrix> | GetTransform | Returns a matrix object containing the <Light> object's transformation matrix. |
int32 | SetDirection | Sets the light direction to the value of the <Vec> object submitted to this function. |
int32 | SetPosition | Sets the light position to the value of the <Vec> object submitted to this function. |
int32 | SetTransform | Sets the position and orientation for a <Light>, defined by a transformation matrix. |
Object members are as follows:
Type Name | Accessor Name | Documentation |
---|---|---|
<Color> | AmbientColor | Gets or sets the <Light> object's ambient color. |
<Color> | AmbientColorProp | Gets or sets the <Light> object's ambient color. |
<Color> | DiffuseColor | Gets or sets the <Light> object's diffuse color. |
<Color> | DiffuseColorProp | Gets or sets the <Light> object's diffuse color. |
<Vec> | Direction | Returns a pointer to the <Vec> object that contains the <Light> object's direction. |
<Color> | EmissiveColor | Gets or sets the emissive color of the <Light>. |
<Color> | EmissiveColorProp | Gets or sets the emissive color of the <Light>. |
<Vec> | Position | Gets or sets a <Light> object's position members X, Y, Z, and W. |
<Color> | SpecularColor | Gets or sets the <Light> object's specular color. |
<Color> | SpecularColorProp | Gets or sets the <Light> object's specular color. |
double | Aperture | This member stores the aperture limit along the X-axis of the <Light> object's coordinate system. For spot lights, this indicates the maximum field-of-view angle away from the direction vector of the <Light>. For directional lights, the value indicates the half-axis width of the volume of the <Light> object's projection, for shadow mapping. |
double | ApertureY | This member stores the aperture limit along the Y-axis of the <Light> object's coordinate system. For spot lights, this indicates the maximum field-of-view angle away from the direction vector of the <Light>. For directional lights, the value indicates the half-axis width of the volume of the <Light> object's projection along the Y-axis, for shadow mapping. |
double | ConstantAtten | Gets or sets a <Light> object's constant attenuation parameter. |
<uint8> | Dynamic | This attribute controls the extent of shadow map volumes. This attribute limits how close shadows come to the light source. For orthographic projections, this value may be positive or negative, but must be positive for perspective projections. |
double | FarZ | Gets or sets the <Light> object's far-z value. |
int32 | Global | Gets or sets a <Light> object's Global parameter. |
double | Intensity | Gets or sets a <Light> object's Intensity parameter. |
double | LinearAtten | Gets or sets a <Light> object's LinearAttenuation parameter. |
double | NearZ | Gets or sets the <Light> object's near-z value. |
int32 | On | Gets or sets a <Light> object's On parameter. |
double[] | Orientation[ index ] | Gets or sets a <Light> object's position members X, Y, and Z. |
double | PrimarySize | Gets or sets the primary size, in conjunction with the <Light> object's shape parameter. |
double | QuadraticAtten | Gets or sets a <Light> object's quadratic attenuation parameter. |
double | SecondarySize | Gets or sets the <Light> object's secondary size, in conjunction with the <Light> object's shape parameter. |
int64 | ShadowmapBuffer | This method is reserved. |
int32 | Shadows | Gets or sets the <Light> object's Shadow parameter. |
int32 | Shape | Gets or sets the <Light> object's shape parameter. Refers to the Light_Shape enumeration. Please see 'LS_Point' and similar in TYPE_SERVICE_ENUMERATION_UTIL.SSL for more information. |
double | SpotExponent | Gets or sets a <Light> object's SpotExponent parameter. |
int32 | Type | Gets or sets a <Light> object's Type parameter. |