- Sceneform SDK for Android
was open sourced and archived ( github.com/google-ar/sceneform-android-sdk
) with version 1.16.0.
- This site ( developers.google.com/sceneform
) serves as the documentation archive for the previous version, Sceneform SDK for Android
1.15.0.
- Do not use version 1.17.0 of the Sceneform Maven artifacts
.
- The 1.17.1 Maven artifacts can be used. Other than the version, however, the 1.17.1 artifacts are identical to the 1.15.0 artifacts.
Light
Stay organized with collections
Save and categorize content based on your preferences.
Nested Classes
enum
Type of Light Source
Public Methods
| static Light.Builder
|
|
| Color
|
|
| float |
|
| float |
|
| float |
|
| float |
|
| Light.Type
|
|
| boolean |
|
| void |
|
| void |
setColorTemperature
(float temperature) Sets the "RGB" color of the light based on the desired "color temperature."
|
| void |
setFalloffRadius
(float falloffRadius) Sets the range that the light intensity falls off to zero.
|
| void |
setInnerConeAngle
(float coneInner) Spotlights shine light in a cone, this value determines the size of the inner part of the cone.
|
| void |
setIntensity
(float intensity) Sets the light intensity which determines how bright the light is in Lux (lx) or Lumens (lm)
(depending on the light type).
|
| void |
setOuterConeAngle
(float coneOuter) Spotlights shine light in a cone, this value determines the size of the outer part of the cone.
|
Inherited Methods
From class
java.lang.Object
Public Methods
Constructs a default light, if nothing else is set
public Color
getColor
()
Get the RGB Color
of the light.
public
float
getFalloffRadius
()
Get the falloff radius of the light.
public
float
getInnerConeAngle
()
Get the inner cone angle for spotlights.
public
float
getIntensity
()
Get the intensity of the light.
public
float
getOuterConeAngle
()
Get the outer cone angle for spotlights.
public
boolean
isShadowCastingEnabled
()
Returns true if the light has shadow casting enabled.
public
void
setColor
( Color
color)
Sets the "RGB" color of the light. Note that intensity is a separate parameter, so you should
set the pure color (i.e. each channel is in the [0,1] range). However setting values outside
that range is valid.
Parameters
color
"RGB" color, the default is 0xffffffff
public
void
setColorTemperature
(float temperature)
Sets the "RGB" color of the light based on the desired "color temperature."
Parameters
temperature
color temperature in Kelvin on a scale from 1,000 to 10,000K. Typical
commercial and residential lighting falls somewhere in the 2000K to 6500K range.
public
void
setFalloffRadius
(float falloffRadius)
Sets the range that the light intensity falls off to zero. This has no affect on the DIRECTIONAL
type.
Parameters
falloffRadius
the light radius in world units, default is 10.0
public
void
setInnerConeAngle
(float coneInner)
Spotlights shine light in a cone, this value determines the size of the inner part of the cone.
The intensity is interpolated between the inner and outer cone angles - meaning if they are the
same than the cone is perfectly sharp. Generally you will want the inner cone to be smaller
than the outer cone to avoid aliasing.
Parameters
coneInner
inner cone angle in radians, default 0.5
public
void
setIntensity
(float intensity)
Sets the light intensity which determines how bright the light is in Lux (lx) or Lumens (lm)
(depending on the light type). Larger values produce brighter lights and near zero values
generate very little light. A household light bulb will generally have an intensity between 800
- 2500 lm whereas sunlight will be around 120,000 lx. There is no absolute upper bound but
values larger than sunlight (120,000 lx) are generally not needed.
Parameters
intensity
the intensity of the light, values greater than one are valid. The intensity
will be clamped and cannot be zero or negative. For directional lights the default is 420
lx. For other other lights the default is 2500 lm.
public
void
setOuterConeAngle
(float coneOuter)
Spotlights shine light in a cone, this value determines the size of the outer part of the cone.
The intensity is interpolated between the inner and outer cone angles - meaning if they are the
same than the cone is perfectly sharp. Generally you will want the inner cone to be smaller
than the outer cone to avoid aliasing.
Parameters
coneOuter
outer cone angle in radians, default is 0.6
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-06-26 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-06-26 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eLight\u003c/code\u003e class in Sceneform manages light properties for rendering in AR scenes.\u003c/p\u003e\n"],["\u003cp\u003eIt offers different light types like directional, point, and spot, configurable via a builder.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can control properties such as color, intensity, falloff radius, and cone angles.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eLight\u003c/code\u003e supports shadow casting, enhancing scene realism with dynamic shadows.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods to retrieve the current state of the light's properties.\u003c/p\u003e\n"]]],["The `Light` class manages light properties, offering a `Builder` for creating lights and `Light.Type` to define the light source. Core actions include setting light characteristics: color via RGB or temperature, intensity, and falloff radius. For spotlights, inner and outer cone angles can be defined. The class also allows retrieving these properties, determining if shadow casting is enabled, and constructing a default light via `builder`. It offers methods to retrieve the current values of light characteristics like `getFalloffRadius`.\n"],null,[]]
