SceneLight class

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name	SceneLight class
Class ID	106
Scope	Basic Development Environment
Class Inheritance	Scene SceneNode SceneLight
Class Children	This class has no children.

The SceneLight class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide SceneLight Properties Table

Legend
R/W	Readable/Writable Permissions
RTE	Available in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated

SceneLight Properties Table

Property ID	Long Name (English)	Description	R/W	RTE
276F0800	Light Number	Reads or writes the number you assign to the light. This property accepts values 0 to 7. The default is 0.	Read/Write	Yes
276F0801	Ambient Color	Reads or writes the RGBA color value of the ambient lighting. Ambient light comes from all directions equally and scatters in all directions equally after it encounters the objects in the scene, such that a source for the light cannot be distinguished.	Read/Write	Yes
276F0802	Diffuse Color	Reads or writes the RGBA color of the diffuse lighting. A diffuse light originates at a specific point and scatters equally across the surface of any 3D object it encounters.	Read/Write	Yes
276F0803	Specular Color	Reads or writes the RGBA color value of the specular light. The light comes from a specific point and bounces off the surface of a 3D object in a direction determined by the shape of the object. When specular light encounters an object, the object acts as a mirror off which the light bounces.	Read/Write	Yes
276F0804	Direction	Reads or writes the x, y, and z coordinates that define the direction of the light.	Read/Write	Yes
276F0806	Cutoff	Reads or writes the cutoff you apply to a spotlight to restrict the width of the light. The value you wire to this property is equivalent to half the angle of the actual spotlight. For example, if you want the spotlight to emit a 40 degree angle of light, set this property to 20. This property accepts values 0 to 90 and 180, where 180 represents no cutoff.	Read/Write	Yes
276F0807	Exponent	Reads or writes the intensity distribution of the light. The intensity of the light changes as the direction of the light and the direction of the object differ. This property accepts values 0 to 128, where 0 means uniform distribution.	Read/Write	Yes
276F0808	Attenuation	Reads or writes the factors of attenuation applied to the light. Attenuation mimics how the intensity of light diminishes as you increase distance from the light.	Read/Write	Yes
276F0809	Attenuation:Constant Attenuation	Indicates the constant factor of attenuation (kc) you apply to the light. The constant factor of attenuation does not change as distance from the light increases.	Read/Write	Yes
276F080A	Attenuation:Linear Attenuation	Indicates the linear factor of attenuation (kl) you apply to the light. The linear factor of attenuation drops in a linear manner as distance from the light increases.	Read/Write	Yes
276F080B	Attenuation:Quadratic Attenuation	Indicates the quadratic factor of attenuation (kq) you apply to the light. The quadratic factor of attenuation drops by the square of the distance from the light.	Read/Write	Yes
276F080C	At Infinity	Reads or writes whether the light is at an infinite distance from the scene. If TRUE, all light strikes the scene in parallel. Set this property to TRUE to create a directional light.	Read/Write	Yes
276F080D	Position	Reads or writes the x, y, and z coordinates that define the position of the light relative to its owning object.	Read/Write	Yes

Methods

This class has no methods or it inherits methods from its parent: SceneNode Class.

Events

This class has no events or it inherits events from its parent: SceneNode Class.

History

Version	Change(s)
	More info to come.

See Also

• VI Server Class Hierarchy
• VI Server