class ART::IAtlas
Interface over the planet atlas set by ART::IPlanet::SetAtlas. Configures the atmosphere.
#include <ARTIAtlas.h>Inherits: IREDObject.
Public functions:
| virtual float | GetAtmosphereHeight ( ) const = 0 |
| virtual float | GetAtmosphereMieScatteringAnisotropy ( ) const = 0 |
| virtual float | GetAtmosphereMieScatteringAnisotropyAttenuation ( ) const = 0 |
| virtual float | GetAtmosphereTurbidity ( ) const = 0 |
| virtual const RED::Color & | GetGroundAlbedo ( ) const = 0 |
| virtual float | GetSkyStrength ( ) const = 0 |
| virtual float | GetSunSaturation ( ) const = 0 |
| virtual float | GetSunStrength ( ) const = 0 |
| virtual float | GetVisibleSkyStrength ( ) const = 0 |
| virtual void | SetAtmosphereHeight ( float iAtmosphereHeight ) = 0 |
| virtual void | SetAtmosphereMieScatteringAnisotropy ( float iG ) = 0 |
| virtual void | SetAtmosphereMieScatteringAnisotropyAttenuation ( float iAtt ) = 0 |
| virtual void | SetAtmosphereTurbidity ( float iTurbidity ) = 0 |
| virtual void | SetGroundAlbedo ( const RED::Color & iGroundAlbedo ) = 0 |
| virtual void | SetSkyStrength ( float iSkyStrength ) = 0 |
| virtual void | SetSunSaturation ( float iSunSaturation ) = 0 |
| virtual void | SetSunStrength ( float iSunStrength ) = 0 |
| virtual void | SetVisibleSkyStrength ( float iVisibleSkyStrength ) = 0 |
Public static functions:
| static RED::CID | GetClassID ( ) |
Functions documentation
| public static RED::CID ART::IAtlas::GetClassID | ( | ) |
| public virtual float ART::IAtlas::GetAtmosphereHeight | ( | ) const = 0 |
Returns:
The atlas atmosphere height in meters.
| public virtual float ART::IAtlas::GetAtmosphereMieScatteringAnisotropy | ( | ) const = 0 |
Returns:
The atmospheric Mie layer scattering isotropy.
| public virtual float ART::IAtlas::GetAtmosphereMieScatteringAnisotropyAttenuation | ( | ) const = 0 |
Returns:
The direct attenuation term applied to the atmospheric Mie layer scattering isotropy.
| public virtual float ART::IAtlas::GetAtmosphereTurbidity | ( | ) const = 0 |
Returns:
The turbidity of the atmosphere in [ 0.0, 100.0 ].
| public virtual const RED::Color & ART::IAtlas::GetGroundAlbedo | ( | ) const = 0 |
Returns:
The ground albedo color value.
| public virtual float ART::IAtlas::GetSkyStrength | ( | ) const = 0 |
Returns:
The sky strength factor applied to the sky radiance.
| public virtual float ART::IAtlas::GetSunSaturation | ( | ) const = 0 |
Returns:
The sun saturation coefficient in [ 0.0, 1.0 ].
| public virtual float ART::IAtlas::GetSunStrength | ( | ) const = 0 |
Returns:
The sun strength factor applied to the sun radiance.
| public virtual float ART::IAtlas::GetVisibleSkyStrength | ( | ) const = 0 |
Returns:
The sky strength factor applied to the visible sky.
| public virtual void ART::IAtlas::SetAtmosphereHeight | ( | float | iAtmosphereHeight | ) = 0 |
Sets the atlas atmosphere height.
Parameters:
| iAtmosphereHeight: | Sets the atmosphere height of the atlas in meters. Negative values are silently clamped to zero. |
| public virtual void ART::IAtlas::SetAtmosphereMieScatteringAnisotropy | ( | float | iG | ) = 0 |
Sets the atmospheric Mie layer scattering isotropy.
Parameters:
| iG: | At 0.0, the Mie layer is isotropic and the sun has no halo. At 1.0, the Mie layer is at its greatest anisotropy and the sun has a strong halo around it. |
| public virtual void ART::IAtlas::SetAtmosphereMieScatteringAnisotropyAttenuation | ( | float | iAtt | ) = 0 |
Sets the direct attenuation term applied to the atmospheric Mie layer scattering isotropy.
Parameters:
| iAtt: | Percentage of the attenuation. |
| public virtual void ART::IAtlas::SetAtmosphereTurbidity | ( | float | iTurbidity | ) = 0 |
Sets the turbidity of the atmosphere.
Parameters:
| iTurbidity: | The turbidity is in [ 0.0, 100.0 ]. |
| public virtual void ART::IAtlas::SetGroundAlbedo | ( | const RED::Color & | iGroundAlbedo | ) = 0 |
Sets the ground albedo color value.
Parameters:
| iGroundAlbedo: | The ground albedo color. |
| public virtual void ART::IAtlas::SetSkyStrength | ( | float | iSkyStrength | ) = 0 |
Sets the strength factor applied to the sky radiance for lighting purposes only.
Parameters:
| iSkyStrength: | The sky strength factor. |
| public virtual void ART::IAtlas::SetSunSaturation | ( | float | iSunSaturation | ) = 0 |
Sets the saturation of the sun.
Parameters:
| iSunSaturation: | The saturation coefficient of the sun in [ 0.0, 1.0 ]. |
| public virtual void ART::IAtlas::SetSunStrength | ( | float | iSunStrength | ) = 0 |
Sets the strength factor applied to the sun radiance for lighting purposes only.
Parameters:
| iSunStrength: | The sun strength factor as a multiplier of the sun radiance. |
| public virtual void ART::IAtlas::SetVisibleSkyStrength | ( | float | iVisibleSkyStrength | ) = 0 |
Sets the strength factor applied to the visible sky.
Parameters:
| iVisibleSkyStrength: | The visible sky strength factor. |
