Light
Contents
[
Hide
]Light class
The light illuminates the scene. The formula to calculate the total attenuation of light is: A = ConstantAttenuation + (Dist LinearAttenuation) + ((Dist^2) QuadraticAttenuation)
Methods
constructor
| Name | Description |
|---|---|
| constructor() | Initializes a new instance of the Light class. |
Result:
constructor_overload
| Name | Description |
|---|---|
| constructor_overload(name) | Initializes a new instance of the Light class. |
Parameters:
| Name | Type | Description |
|---|---|---|
| name | String | Name |
Result:
constructor_overload$2{#constructor_overload$2}
| Name | Description |
|---|---|
| constructor_overload$2(name, type) | Initializes a new instance of the Light class. |
Parameters:
| Name | Type | Description |
|---|---|---|
| name | String | Name |
| type | LightType | LightType |
Result:
getColor
| Name | Description |
|---|---|
| getColor() | Gets or sets the light’s color |
Result:
setColor
| Name | Description |
|---|---|
| setColor(value) | Gets or sets the light’s color |
Result:
getLightType
| Name | Description |
|---|---|
| getLightType() | Gets or sets the light’s type The value of the property is LightType integer constant. |
Result:
setLightType
| Name | Description |
|---|---|
| setLightType(value) | Gets or sets the light’s type The value of the property is LightType integer constant. |
Result:
getCastLight
| Name | Description |
|---|---|
| getCastLight() | Gets or sets if the current light instance can illuminate other objects. |
Result:
setCastLight
| Name | Description |
|---|---|
| setCastLight(value) | Gets or sets if the current light instance can illuminate other objects. |
Result:
getIntensity
| Name | Description |
|---|---|
| getIntensity() | Gets or sets the light’s intensity, default value is 100 |
Result:
setIntensity
| Name | Description |
|---|---|
| setIntensity(value) | Gets or sets the light’s intensity, default value is 100 |
Result:
getHotSpot
| Name | Description |
|---|---|
| getHotSpot() | Gets or sets the hot spot cone angle(in degrees). |
Result:
setHotSpot
| Name | Description |
|---|---|
| setHotSpot(value) | Gets or sets the hot spot cone angle(in degrees). |
Result:
getFalloff
| Name | Description |
|---|---|
| getFalloff() | Gets or sets the falloff cone angle (in degrees). |
Result:
setFalloff
| Name | Description |
|---|---|
| setFalloff(value) | Gets or sets the falloff cone angle (in degrees). |
Result:
getConstantAttenuation
| Name | Description |
|---|---|
| getConstantAttenuation() | Gets or sets the constant attenuation to calculate the total attenuation of the light |
Result:
setConstantAttenuation
| Name | Description |
|---|---|
| setConstantAttenuation(value) | Gets or sets the constant attenuation to calculate the total attenuation of the light |
Result:
getLinearAttenuation
| Name | Description |
|---|---|
| getLinearAttenuation() | Gets or sets the linear attenuation to calculate the total attenuation of the light |
Result:
setLinearAttenuation
| Name | Description |
|---|---|
| setLinearAttenuation(value) | Gets or sets the linear attenuation to calculate the total attenuation of the light |
Result:
getQuadraticAttenuation
| Name | Description |
|---|---|
| getQuadraticAttenuation() | Gets or sets the quadratic attenuation to calculate the total attenuation of the light |
Result:
setQuadraticAttenuation
| Name | Description |
|---|---|
| setQuadraticAttenuation(value) | Gets or sets the quadratic attenuation to calculate the total attenuation of the light |
Result:
getCastShadows
| Name | Description |
|---|---|
| getCastShadows() | Gets or sets if the light can cast shadows on other objects. |
Result:
setCastShadows
| Name | Description |
|---|---|
| setCastShadows(value) | Gets or sets if the light can cast shadows on other objects. |
Result:
getShadowColor
| Name | Description |
|---|---|
| getShadowColor() | Gets or sets the shadow’s color. |
Result:
setShadowColor
| Name | Description |
|---|---|
| setShadowColor(value) | Gets or sets the shadow’s color. |
Result:
getRotationMode
| Name | Description |
|---|---|
| getRotationMode() | Gets or sets the frustum’s orientation mode This property only works when the Target is null. If the value is RotationMode.FIXED_TARGET, the direction is always calculated by the property LookAt Otherwise the LookAt is always calculated by the DirectionThe value of the property is RotationMode integer constant. |
Result:
setRotationMode
| Name | Description |
|---|---|
| setRotationMode(value) | Gets or sets the frustum’s orientation mode This property only works when the Target is null. If the value is RotationMode.FIXED_TARGET, the direction is always calculated by the property LookAt Otherwise the LookAt is always calculated by the DirectionThe value of the property is RotationMode integer constant. |
Result:
getNearPlane
| Name | Description |
|---|---|
| getNearPlane() | Gets or sets the frustum’s near plane distance. |
Result:
setNearPlane
| Name | Description |
|---|---|
| setNearPlane(value) | Gets or sets the frustum’s near plane distance. |
Result:
getFarPlane
| Name | Description |
|---|---|
| getFarPlane() | Gets or sets the frustum’s far plane distance. |
Result:
setFarPlane
| Name | Description |
|---|---|
| setFarPlane(value) | Gets or sets the frustum’s far plane distance. |
Result:
getAspect
| Name | Description |
|---|---|
| getAspect() | Gets or sets the aspect ratio of the frustum |
Result:
setAspect
| Name | Description |
|---|---|
| setAspect(value) | Gets or sets the aspect ratio of the frustum |
Result:
getOrthoHeight
| Name | Description |
|---|---|
| getOrthoHeight() | Gets or sets the height when frustum in orthographic projection. |
Result:
setOrthoHeight
| Name | Description |
|---|---|
| setOrthoHeight(value) | Gets or sets the height when frustum in orthographic projection. |
Result:
getUp
| Name | Description |
|---|---|
| getUp() | Gets or sets the up direction of the camera |
Result:
setUp
| Name | Description |
|---|---|
| setUp(value) | Gets or sets the up direction of the camera |
Result:
getLookAt
| Name | Description |
|---|---|
| getLookAt() | Gets or sets the the interested position that the camera is looking at. |
Result:
setLookAt
| Name | Description |
|---|---|
| setLookAt(value) | Gets or sets the the interested position that the camera is looking at. |
Result:
getDirection
| Name | Description |
|---|---|
| getDirection() | Gets or sets the direction that the camera is looking at. Changes on this property will also affects the LookAt and Target. |
Result:
setDirection
| Name | Description |
|---|---|
| setDirection(value) | Gets or sets the direction that the camera is looking at. Changes on this property will also affects the LookAt and Target. |
Result:
getTarget
| Name | Description |
|---|---|
| getTarget() | Gets or sets the target that the camera is looking at. If the user supports this property, it should be prior to LookAt property. |
Result:
setTarget
| Name | Description |
|---|---|
| setTarget(value) | Gets or sets the target that the camera is looking at. If the user supports this property, it should be prior to LookAt property. |
Result:
getParentNodes
| Name | Description |
|---|---|
| getParentNodes() | Gets all parent nodes, an entity can be attached to multiple parent nodes for geometry instancing The nodes. |
Result:
getExcluded
| Name | Description |
|---|---|
| getExcluded() | Gets or sets whether to exclude this entity during exporting. |
Result:
setExcluded
| Name | Description |
|---|---|
| setExcluded(value) | Gets or sets whether to exclude this entity during exporting. |
Result:
getParentNode
| Name | Description |
|---|---|
| getParentNode() | Gets or sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes. The parent node. |
Result:
setParentNode
| Name | Description |
|---|---|
| setParentNode(value) | Gets or sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes. The parent node. |
Result:
getScene
| Name | Description |
|---|---|
| getScene() | Gets the scene that this object belongs to |
Result:
getName
| Name | Description |
|---|---|
| getName() | Gets or sets the name. The name. |
Result:
setName
| Name | Description |
|---|---|
| setName(value) | Gets or sets the name. The name. |
Result:
getProperties
| Name | Description |
|---|---|
| getProperties() | Gets the collection of all properties. |
Result:
getBoundingBox
| Name | Description |
|---|---|
| getBoundingBox() | Gets the bounding box of current entity in its object space coordinate system. |
Result:
getEntityRendererKey
| Name | Description |
|---|---|
| getEntityRendererKey() | Gets the key of the entity renderer registered in the renderer |
Result: EntityRendererKey
removeProperty
| Name | Description |
|---|---|
| removeProperty(property) | Removes a dynamic property. |
Parameters:
| Name | Type | Description |
|---|---|---|
| property | Property | Which property to remove |
Result: boolean
removeProperty
| Name | Description |
|---|---|
| removeProperty(property) | Remove the specified property identified by name |
Parameters:
| Name | Type | Description |
|---|---|---|
| propert | String | null |
Result: boolean
getProperty
| Name | Description |
|---|---|
| getProperty(property) | Get the value of specified property |
Parameters:
| Name | Type | Description |
|---|---|---|
| property | String | Property name |
Result: Object
setProperty
| Name | Description |
|---|---|
| setProperty(property, value) | Sets the value of specified property |
Parameters:
| Name | Type | Description |
|---|---|---|
| property | String | Property name |
| value | Object | The value of the property |
Result: Object
findProperty
| Name | Description |
|---|---|
| findProperty(propertyName) | Finds the property. It can be a dynamic property (Created by CreateDynamicProperty/SetProperty) or native property(Identified by its name) |
Parameters:
| Name | Type | Description |
|---|---|---|
| propertyName | String | Property name. |
Result: Property