Light class

Light class

The light illuminates the scene.

The formula to calculate the total attenuation of light is: A = ConstantAttenuation + (Dist * LinearAttenuation) + ((Dist^2) * QuadraticAttenuation)

Inheritance: LightFrustumEntitySceneObjectA3DObject

The Light type exposes the following members:

Constructors

ConstructorDescription
initInitializes a new instance of the Light class.
initInitializes a new instance of the Light class.
initInitializes a new instance of the Light class.

Properties

PropertyDescription
nameGets or sets the name.
propertiesGets the collection of all properties.
sceneGets the scene that this object belongs to
parent_nodesGets all parent nodes, an entity can be attached to multiple parent nodes for geometry instancing
excludedGets or sets whether to exclude this entity during exporting.
parent_nodeGets or sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes.
rotation_modeGets or sets the frustum’s orientation mode
This property only works when the Frustum.target is null.
If the value is RotationMode.FIXED_TARGET, the direction is always calculated by the property Frustum.look_at
Otherwise the Frustum.look_at is always calculated by the Frustum.direction
near_planeGets or sets the frustum’s near plane distance.
far_planeGets or sets the frustum’s far plane distance.
aspectGets or sets the aspect ratio of the frustum
ortho_heightGets or sets the height when frustum in orthographic projection.
upGets or sets the up direction of the camera
look_atGets or sets the the interested position that the camera is looking at.
directionGets or sets the direction that the camera is looking at.
Changes on this property will also affects the Frustum.look_at and Frustum.target.
targetGets or sets the target that the camera is looking at.
If the user supports this property, it should be prior to Frustum.look_at property.
colorGets or sets the light’s color
light_typeGets or sets the light’s type
cast_lightGets or sets if the current light instance can illuminate other objects.
intensityGets or sets the light’s intensity, default value is 100
hot_spotGets or sets the hot spot cone angle(in degrees).
falloffGets or sets the falloff cone angle (in degrees).
constant_attenuationGets or sets the constant attenuation to calculate the total attenuation of the light
linear_attenuationGets or sets the linear attenuation to calculate the total attenuation of the light
quadratic_attenuationGets or sets the quadratic attenuation to calculate the total attenuation of the light
cast_shadowsGets or sets if the light can cast shadows on other objects.
shadow_colorGets or sets the shadow’s color.

Methods

MethodDescription
remove_propertyRemoves a dynamic property.
remove_propertyRemove the specified property identified by name
get_propertyGet the value of specified property
set_propertySets the value of specified property
find_propertyFinds the property.
It can be a dynamic property (Created by CreateDynamicProperty/SetProperty)
or native property(Identified by its name)
get_bounding_boxGets the bounding box of current entity in its object space coordinate system.
get_entity_renderer_keyGets the key of the entity renderer registered in the renderer

See Also