SceneComponent

java.lang.Object
- ohos.agp.render.render3d.components.SceneComponent

所有已实现的接口:

Component
```
public class SceneComponent
extends Object
implements Component
```
Represent the scene component.
You can use this class to define component attributes, such as the diffuse and specular color.

从以下版本开始:

3

嵌套类概要

嵌套类
限定符和类型类说明

static class SceneComponent.BackgroundType
Defines the type of the background displayed in a scene.

嵌套类
限定符和类型	类	说明
`static class`	`SceneComponent.BackgroundType`	Defines the type of the background displayed in a scene.

构造器概要

构造器
构造器说明

SceneComponent()

构造器
构造器	说明
`SceneComponent()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`SceneComponent.BackgroundType`	`getBackgroundType()`	Obtains the background type for this scene.
`Entity`	`getCamera()`	Obtains the available camera in the current scene.
`Vector3`	`getEnvironmentDiffuseColor()`	Obtains the diffuse color of the environment.
`float`	`getEnvironmentDiffuseIntensity()`	Obtains the diffusion intensity multiplier of the environment.
`Quaternion`	`getEnvironmentRotation()`	Obtains the quaternion for IBL environment rotation.
`Vector3`	`getEnvironmentSpecularColor()`	Obtains the specular color of the environment.
`float`	`getEnvironmentSpecularIntensity()`	Obtains the multiplier for the specular reflection intensity of the environment.
`GpuResourceHandle`	`getEnvMap()`	Obtains the handle of the environment map image.
`Vector3[]`	`getIrradianceCoefficients()`	Obtains the irradiance lighting coefficients.
`GpuResourceHandle`	`getRadianceCubemap()`	Obtains the handle of the radiance cubemap used for image-based lighting (IBL).
`void`	`setBackgroundType(SceneComponent.BackgroundType backgroundType)`	Sets the background type for this scene.
`void`	`setCamera(Entity camera)`	Sets the camera available in the current scene.
`void`	`setEnvironmentDiffuseColor(Vector3 environmentDiffuseColor)`	Sets the diffuse color of the environment.
`void`	`setEnvironmentDiffuseIntensity(float environmentDiffuseIntensity)`	Sets the diffusion intensity multiplier of the environment.
`void`	`setEnvironmentRotation(Quaternion environmentRotation)`	Sets the quaternion for IBL environment rotation.
`void`	`setEnvironmentSpecularColor(Vector3 environmentSpecularColor)`	Set the specular color of the environment.
`void`	`setEnvironmentSpecularIntensity(float environmentSpecularIntensity)`	Sets the multiplier for specular reflection intensity of the environment.
`void`	`setEnvMap(GpuResourceHandle envMap)`	Sets the handle of the environment map image.
`void`	`setIrradianceCoefficients(Vector3[] irradianceCoefficients)`	Sets the irradiance lighting coefficients.
`void`	`setRadianceCubemap(GpuResourceHandle radianceCubemap)`	Sets the handle of the radiance cubemap used for IBL.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - SceneComponent
```
public SceneComponent()
```
- 方法详细资料
  - getEnvironmentDiffuseColor
```
public Vector3 getEnvironmentDiffuseColor()
```
    Obtains the diffuse color of the environment.
    
    返回:
    
    Returns the diffuse color of the environment.
  - setEnvironmentDiffuseColor
```
public void setEnvironmentDiffuseColor(Vector3 environmentDiffuseColor)
```
    Sets the diffuse color of the environment.
    
    参数:
    
    environmentDiffuseColor - Indicates the diffuse color to set. For details,see Vector3.
  - getEnvironmentSpecularColor
```
public Vector3 getEnvironmentSpecularColor()
```
    Obtains the specular color of the environment.
    
    返回:
    
    Returns the specular color of the environment.
  - setEnvironmentSpecularColor
```
public void setEnvironmentSpecularColor(Vector3 environmentSpecularColor)
```
    Set the specular color of the environment.
    
    参数:
    
    environmentSpecularColor - Indicates the specular color to set. For details, see Vector3.
  - getEnvironmentDiffuseIntensity
```
public float getEnvironmentDiffuseIntensity()
```
    Obtains the diffusion intensity multiplier of the environment.
    
    返回:
    
    Returns the diffusion intensity multiplier of the environment.
  - setEnvironmentDiffuseIntensity
```
public void setEnvironmentDiffuseIntensity(float environmentDiffuseIntensity)
```
    Sets the diffusion intensity multiplier of the environment.
    
    参数:
    
    environmentDiffuseIntensity - Indicates the diffusion intensity multiplier to set.
  - getEnvironmentSpecularIntensity
```
public float getEnvironmentSpecularIntensity()
```
    Obtains the multiplier for the specular reflection intensity of the environment.
    
    返回:
    
    Returns the multiplier.
  - setEnvironmentSpecularIntensity
```
public void setEnvironmentSpecularIntensity(float environmentSpecularIntensity)
```
    Sets the multiplier for specular reflection intensity of the environment.
    
    参数:
    
    environmentSpecularIntensity - Indicates the multiplier to set.
  - getCamera
```
public Entity getCamera()
```
    Obtains the available camera in the current scene.
    
    返回:
    
    Returns the available camera.
  - setCamera
```
public void setCamera(Entity camera)
```
    Sets the camera available in the current scene.
    
    参数:
    
    camera - Indicates the camera to be set available in this scene.
  - getRadianceCubemap
```
public GpuResourceHandle getRadianceCubemap()
```
    Obtains the handle of the radiance cubemap used for image-based lighting (IBL).
    
    返回:
    
    Returns the handle.
  - setRadianceCubemap
```
public void setRadianceCubemap(GpuResourceHandle radianceCubemap)
```
    Sets the handle of the radiance cubemap used for IBL.
    
    参数:
    
    radianceCubemap - Indicates the handle to set.
  - getEnvMap
```
public GpuResourceHandle getEnvMap()
```
    Obtains the handle of the environment map image.
    
    返回:
    
    Returns the handle of the environment map image.
  - setEnvMap
```
public void setEnvMap(GpuResourceHandle envMap)
```
    Sets the handle of the environment map image.
    
    参数:
    
    envMap - Indicates the handle to set.
  - getEnvironmentRotation
```
public Quaternion getEnvironmentRotation()
```
    Obtains the quaternion for IBL environment rotation.
    
    返回:
    
    Returns the quaternion representing the rotation direction.
  - setEnvironmentRotation
```
public void setEnvironmentRotation(Quaternion environmentRotation)
```
    Sets the quaternion for IBL environment rotation.
    
    参数:
    
    environmentRotation - Indicates the quaternion to set.
  - getBackgroundType
```
public SceneComponent.BackgroundType getBackgroundType()
```
    Obtains the background type for this scene.
    
    返回:
    
    Returns the background type.
  - setBackgroundType
```
public void setBackgroundType(SceneComponent.BackgroundType backgroundType)
```
    Sets the background type for this scene. The type is defined in BackgroundType.
    
    参数:
    
    backgroundType - Indicates the background type to set.
  - getIrradianceCoefficients
```
public Vector3[] getIrradianceCoefficients()
```
    Obtains the irradiance lighting coefficients.
    
    返回:
    
    Returns the irradiance lighting coefficients.
  - setIrradianceCoefficients
```
public void setIrradianceCoefficients(Vector3[] irradianceCoefficients)
```
    Sets the irradiance lighting coefficients. For Lambertian diffuse, you are advised to prescale the coefficients with 1.0/PI.
    
    参数:
    
    irradianceCoefficients - Indicates the irradiance lighting coefficients to set.

类 SceneComponent

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

SceneComponent

方法详细资料

getEnvironmentDiffuseColor

setEnvironmentDiffuseColor

getEnvironmentSpecularColor

setEnvironmentSpecularColor

getEnvironmentDiffuseIntensity

setEnvironmentDiffuseIntensity

getEnvironmentSpecularIntensity

setEnvironmentSpecularIntensity

getCamera

setCamera

getRadianceCubemap

setRadianceCubemap

getEnvMap

setEnvMap

getEnvironmentRotation

setEnvironmentRotation

getBackgroundType

setBackgroundType

getIrradianceCoefficients

setIrradianceCoefficients