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: Light →
Frustum →
Entity →
SceneObject →
A3DObject
The Light type exposes the following members:
Constructors
| Constructor | Description |
|---|---|
__init__(self) | Initializes a new instance of the Light class. |
__init__(self, name) | Initializes a new instance of the Light class. |
__init__(self, name, type) | Initializes a new instance of the Light class. |
Properties
| Property | Description |
|---|---|
| name | Gets or sets the name. |
| properties | Gets the collection of all properties. |
| scene | Gets the scene that this object belongs to |
| parent_nodes | Gets all parent nodes, an entity can be attached to multiple parent nodes for geometry instancing |
| excluded | Gets or sets whether to exclude this entity during exporting. |
| parent_node | Gets or sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes. |
| rotation_mode | Gets 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_atOtherwise the Frustum.look_at is always calculated by the Frustum.direction |
| near_plane | Gets or sets the frustum’s near plane distance. |
| far_plane | Gets or sets the frustum’s far plane distance. |
| aspect | Gets or sets the aspect ratio of the frustum |
| ortho_height | Gets or sets the height when frustum in orthographic projection. |
| up | Gets or sets the up direction of the camera |
| look_at | Gets or sets the the interested position that the camera is looking at. |
| direction | Gets or sets the direction that the camera is looking at. Changes on this property will also affects the Frustum.look_at and Frustum.target. |
| target | Gets 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. |
| color | Gets or sets the light’s color |
| light_type | Gets or sets the light’s type |
| cast_light | Gets or sets if the current light instance can illuminate other objects. |
| intensity | Gets or sets the light’s intensity, default value is 100 |
| hot_spot | Gets or sets the hot spot cone angle(in degrees). |
| falloff | Gets or sets the falloff cone angle (in degrees). |
| constant_attenuation | Gets or sets the constant attenuation to calculate the total attenuation of the light |
| linear_attenuation | Gets or sets the linear attenuation to calculate the total attenuation of the light |
| quadratic_attenuation | Gets or sets the quadratic attenuation to calculate the total attenuation of the light |
| cast_shadows | Gets or sets if the light can cast shadows on other objects. |
| shadow_color | Gets or sets the shadow’s color. |
Methods
| Method | Description |
|---|---|
remove_property(self, property) | Removes a dynamic property. |
remove_property(self, property) | Remove the specified property identified by name |
get_property(self, property) | Get the value of specified property |
set_property(self, property, value) | Sets the value of specified property |
find_property(self, property_name) | Finds the property. It can be a dynamic property (Created by CreateDynamicProperty/SetProperty) or native property(Identified by its name) |
get_bounding_box(self) | Gets the bounding box of current entity in its object space coordinate system. |
get_entity_renderer_key(self) | Gets the key of the entity renderer registered in the renderer |
See Also
- module
aspose.threed.entities - class
A3DObject - class
Entity - class
Frustum - class
Light - class
SceneObject