• SceneLighting
  • class Esri::ArcGISRuntime::SceneLighting

    Information that controls how the scene is lit. More...

    Header: #include <SceneLighting.h>
    Since: Esri::ArcGISRuntime 300.0
    Inherits: Esri::ArcGISRuntime::Object
    Inherited By:

    Esri::ArcGISRuntime::SunLighting and Esri::ArcGISRuntime::VirtualLighting

    Public Functions

    virtual ~SceneLighting() override
    bool areDirectShadowsEnabled() const
    Esri::ArcGISRuntime::SceneLightingType sceneLightingType() const
    void setDirectShadowsEnabled(bool areDirectShadowsEnabled)

    Detailed Description

    Relevant samples:

    • Configure scene environment: Configure the environment settings in a local scene to change the lighting conditions and background appearance.

    See also SceneEnvironment.

    Member Function Documentation

    [override virtual noexcept] SceneLighting::~SceneLighting()

    Destructor.

    bool SceneLighting::areDirectShadowsEnabled() const

    Returns true if shadows cast by the main light source should be shown, false otherwise.

    Shadows are only displayed for real-world objects. Terrain doesn't cast shadows.

    The default value is false.

    Esri::ArcGISRuntime::SceneLightingType SceneLighting::sceneLightingType() const

    Returns the type of lighting used to light a scene.

    The default value is VirtualLighting.

    void SceneLighting::setDirectShadowsEnabled(bool areDirectShadowsEnabled)

    Sets the areDirectShadowsEnabled to areDirectShadowsEnabled.

    See also areDirectShadowsEnabled.