<Light> Data Interface

Provides script language access to C++ objects of this type.

Class HierarchyType » Node » Light

Function Members

Function members are as follows:

Return Type Function Name Documentation
int32GetModelViewMatrixRetrieves 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.
int32GetProjectionMatrixRetrieves 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>GetTransformReturns a matrix object containing the <Light> object's transformation matrix.
int32SetDirectionSets the light direction to the value of the <Vec> object submitted to this function.
int32SetPositionSets the light position to the value of the <Vec> object submitted to this function.
int32SetTransformSets the position and orientation for a <Light>, defined by a transformation matrix.

Object Members

Object members are as follows:

Type Name Accessor Name Documentation
<Color>AmbientColorGets or sets the <Light> object's ambient color.
<Color>AmbientColorPropGets or sets the <Light> object's ambient color.
<Color>DiffuseColorGets or sets the <Light> object's diffuse color.
<Color>DiffuseColorPropGets or sets the <Light> object's diffuse color.
<Vec>DirectionReturns a pointer to the <Vec> object that contains the <Light> object's direction.
<Color>EmissiveColorGets or sets the emissive color of the <Light>.
<Color>EmissiveColorPropGets or sets the emissive color of the <Light>.
<Vec>PositionGets or sets a <Light> object's position members X, Y, Z, and W.
<Color>SpecularColorGets or sets the <Light> object's specular color.
<Color>SpecularColorPropGets or sets the <Light> object's specular color.
doubleApertureThis 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.
doubleApertureYThis 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.
doubleConstantAttenGets or sets a <Light> object's constant attenuation parameter.
<uint8>DynamicThis 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.
doubleFarZGets or sets the <Light> object's far-z value.
int32GlobalGets or sets a <Light> object's Global parameter.
doubleIntensityGets or sets a <Light> object's Intensity parameter.
doubleLinearAttenGets or sets a <Light> object's LinearAttenuation parameter.
doubleNearZGets or sets the <Light> object's near-z value.
int32OnGets or sets a <Light> object's On parameter.
double[]Orientation[ index ]Gets or sets a <Light> object's position members X, Y, and Z.
doublePrimarySizeGets or sets the primary size, in conjunction with the <Light> object's shape parameter.
doubleQuadraticAttenGets or sets a <Light> object's quadratic attenuation parameter.
doubleSecondarySizeGets or sets the <Light> object's secondary size, in conjunction with the <Light> object's shape parameter.
int64ShadowmapBufferThis method is reserved.
int32ShadowsGets or sets the <Light> object's Shadow parameter.
int32ShapeGets 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.
doubleSpotExponentGets or sets a <Light> object's SpotExponent parameter.
int32TypeGets or sets a <Light> object's Type parameter.