IAtlas

Functions

	`SET_CID`
void	`SetAtmosphereHeight`
float	`GetAtmosphereHeight`
void	`SetSunSaturation`
float	`GetSunSaturation`
void	`SetSunStrength`
float	`GetSunStrength`
void	`SetSkyStrength`
float	`GetSkyStrength`
void	`SetVisibleSkyStrength`
float	`GetVisibleSkyStrength`
void	`SetGroundAlbedo`
const Color &	`GetGroundAlbedo`
void	`SetAtmosphereTurbidity`
float	`GetAtmosphereTurbidity`
void	`SetAtmosphereMieScatteringAnisotropy`
float	`GetAtmosphereMieScatteringAnisotropy`
void	`SetAtmosphereMieScatteringAnisotropyAttenuation`
float	`GetAtmosphereMieScatteringAnisotropyAttenuation`

Detailed Description

class IAtlas : public RED::IREDObject 

Interface over the planet atlas set by ART::IPlanet::SetAtlas. Configures the atmosphere.

Public Functions

SET_CID(CID_class_ARTIAtlas)

virtual void 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.

virtual float GetAtmosphereHeight() const = 0

Returns: The atlas atmosphere height in meters.

virtual void SetSunSaturation(float iSunSaturation) = 0

Sets the saturation of the sun.

Parameters: iSunSaturation – The saturation coefficient of the sun in [ 0.0, 1.0 ].

virtual float GetSunSaturation() const = 0

Returns: The sun saturation coefficient in [ 0.0, 1.0 ].

virtual void 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.

virtual float GetSunStrength() const = 0

Returns: The sun strength factor applied to the sun radiance.

virtual void SetSkyStrength(float iSkyStrength) = 0

Sets the strength factor applied to the sky radiance for lighting purposes only.

Parameters: iSkyStrength – The sky strength factor.

virtual float GetSkyStrength() const = 0

Returns: The sky strength factor applied to the sky radiance.

virtual void SetVisibleSkyStrength(float iVisibleSkyStrength) = 0

Sets the strength factor applied to the visible sky.

Parameters: iVisibleSkyStrength – The visible sky strength factor.

virtual float GetVisibleSkyStrength() const = 0

Returns: The sky strength factor applied to the visible sky.

virtual void SetGroundAlbedo(const RED::Color &iGroundAlbedo) = 0

Sets the ground albedo color value.

Parameters: iGroundAlbedo – The ground albedo color.

virtual const RED::Color &GetGroundAlbedo() const = 0

Returns: The ground albedo color value.

virtual void SetAtmosphereTurbidity(float iTurbidity) = 0

Sets the turbidity of the atmosphere.

Parameters: iTurbidity – The turbidity is in [ 0.0, 100.0 ].

virtual float GetAtmosphereTurbidity() const = 0

Returns: The turbidity of the atmosphere in [ 0.0, 100.0 ].

virtual void 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.

virtual float GetAtmosphereMieScatteringAnisotropy() const = 0

Returns: The atmospheric Mie layer scattering isotropy.

virtual void SetAtmosphereMieScatteringAnisotropyAttenuation(float iAtt) = 0

Sets the direct attenuation term applied to the atmospheric Mie layer scattering isotropy.

Parameters: iAtt – Percentage of the attenuation.

virtual float GetAtmosphereMieScatteringAnisotropyAttenuation() const = 0

Returns: The direct attenuation term applied to the atmospheric Mie layer scattering isotropy.