Order in parameters changed

This commit is contained in:
sergi-e 2020-06-03 14:31:09 +02:00 committed by Marc Garcia Puig
parent 9b6e9fc2b0
commit 06375cc866
2 changed files with 24 additions and 18 deletions

View File

@ -2352,21 +2352,21 @@ Rain intensity values range from 0 to 100, being 0 none at all and 100 a heavy r
Determines the creation of puddles. Values range from 0 to 100, being 0 none at all and 100 a road completely capped with water. Puddles are created with static noise, meaning that they will always appear at the same locations. Determines the creation of puddles. Values range from 0 to 100, being 0 none at all and 100 a road completely capped with water. Puddles are created with static noise, meaning that they will always appear at the same locations.
- <a name="carla.WeatherParameters.wind_intensity"></a>**<font color="#f8805a">wind_intensity</font>** (_float_) - <a name="carla.WeatherParameters.wind_intensity"></a>**<font color="#f8805a">wind_intensity</font>** (_float_)
Controls the strenght of the wind with values from 0, no wind at all, to 100, a strong wind. The wind does affect rain direction and leaves from trees, so this value is restricted to avoid animation issues. Controls the strenght of the wind with values from 0, no wind at all, to 100, a strong wind. The wind does affect rain direction and leaves from trees, so this value is restricted to avoid animation issues.
- <a name="carla.WeatherParameters.falloff"></a>**<font color="#f8805a">falloff</font>** (_float_) - <a name="carla.WeatherParameters.sun_azimuth_angle"></a>**<font color="#f8805a">sun_azimuth_angle</font>** (_float_)
Density of the fog (as in specific mass). The bigger the value, the more dense and heavy it will be, and the fog will reach smaller heights. Corresponds to <a href="https://docs.unrealengine.com/en-US/Engine/Actors/FogEffects/HeightFog/index.html#:~:text=Using%20Exponential%20Height%20Fog%20Features,-The%20sections%20below&text=Add%20a%20second%20fog%20layer,height%20falloff%2C%20and%20height%20offset">Fog Height Falloff</a> in the UE docs. <br> If the value is 0, the fog will be lighter than air, and will cover the whole scene. <br> A value of 1 is approximately as dense as the air, and reaches normal-sized buildings. <br> For values greater than 5, the air will be so dense that it will be compressed on ground level. The azimuth angle of the sun in degrees. Values range from 0 to 360. Zero is an origin point in a sphere determined by Unreal Engine.
- <a name="carla.WeatherParameters.sun_altitude_angle"></a>**<font color="#f8805a">sun_altitude_angle</font>** (_float_)
Altitude angle of the sun in degrees. Values range from -90 to 90 corresponding to midnight and midday each.
- <a name="carla.WeatherParameters.fog_density"></a>**<font color="#f8805a">fog_density</font>** (_float_) - <a name="carla.WeatherParameters.fog_density"></a>**<font color="#f8805a">fog_density</font>** (_float_)
Fog concentration or thickness. It only affects the RGB camera sensor. Values range from 0 to 100. Fog concentration or thickness. It only affects the RGB camera sensor. Values range from 0 to 100.
- <a name="carla.WeatherParameters.fog_distance"></a>**<font color="#f8805a">fog_distance</font>** (_float_) - <a name="carla.WeatherParameters.fog_distance"></a>**<font color="#f8805a">fog_distance</font>** (_float_)
Fog start distance (in meters). Values range from 0 to infinite. Fog start distance (in meters). Values range from 0 to infinite.
- <a name="carla.WeatherParameters.wetness"></a>**<font color="#f8805a">wetness</font>** (_float_) - <a name="carla.WeatherParameters.wetness"></a>**<font color="#f8805a">wetness</font>** (_float_)
Wetness intensity. It only affects the RGB camera sensor. Values range from 0 to 100. Wetness intensity. It only affects the RGB camera sensor. Values range from 0 to 100.
- <a name="carla.WeatherParameters.sun_azimuth_angle"></a>**<font color="#f8805a">sun_azimuth_angle</font>** (_float_) - <a name="carla.WeatherParameters.falloff"></a>**<font color="#f8805a">falloff</font>** (_float_)
The azimuth angle of the sun in degrees. Values range from 0 to 360. Zero is an origin point in a sphere determined by Unreal Engine. Density of the fog (as in specific mass) from 0 to infinity. The bigger the value, the more dense and heavy it will be, and the fog will reach smaller heights. Corresponds to <a href="https://docs.unrealengine.com/en-US/Engine/Actors/FogEffects/HeightFog/index.html#:~:text=Using%20Exponential%20Height%20Fog%20Features,-The%20sections%20below&text=Add%20a%20second%20fog%20layer,height%20falloff%2C%20and%20height%20offset">Fog Height Falloff</a> in the UE docs. <br> If the value is 0, the fog will be lighter than air, and will cover the whole scene. <br> A value of 1 is approximately as dense as the air, and reaches normal-sized buildings. <br> For values greater than 5, the air will be so dense that it will be compressed on ground level.
- <a name="carla.WeatherParameters.sun_altitude_angle"></a>**<font color="#f8805a">sun_altitude_angle</font>** (_float_)
Altitude angle of the sun in degrees. Values range from -90 to 90 corresponding to midnight and midday each.
<h3>Methods</h3> <h3>Methods</h3>
- <a name="carla.WeatherParameters.__init__"></a>**<font color="#7fb800">\__init__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**cloudiness**=0.0</font>, <font color="#00a6ed">**precipitation**=0.0</font>, <font color="#00a6ed">**precipitation_deposits**=0.0</font>, <font color="#00a6ed">**wind_intensity**=0.0</font>, <font color="#00a6ed">**sun_azimuth_angle**=0.0</font>, <font color="#00a6ed">**sun_altitude_angle**=0.0</font>, <font color="#00a6ed">**fog_density**=0.0</font>, <font color="#00a6ed">**fog_distance**=0.0</font>, <font color="#00a6ed">**wetness**=0.0</font>) - <a name="carla.WeatherParameters.__init__"></a>**<font color="#7fb800">\__init__</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**cloudiness**=0.0</font>, <font color="#00a6ed">**precipitation**=0.0</font>, <font color="#00a6ed">**precipitation_deposits**=0.0</font>, <font color="#00a6ed">**wind_intensity**=0.0</font>, <font color="#00a6ed">**sun_azimuth_angle**=0.0</font>, <font color="#00a6ed">**sun_altitude_angle**=0.0</font>, <font color="#00a6ed">**fog_density**=0.0</font>, <font color="#00a6ed">**fog_distance**=0.0</font>, <font color="#00a6ed">**wetness**=0.0</font>, <font color="#00a6ed">**falloff**=0.2</font>)
Method to initialize an object defining weather conditions. This class has some presets for different noon and sunset conditions listed in a note below. Method to initialize an object defining weather conditions. This class has some presets for different noon and sunset conditions listed in a note below.
- **Parameters:** - **Parameters:**
- `cloudiness` (_float_) 0 is a clear sky, 100 complete overcast. - `cloudiness` (_float_) 0 is a clear sky, 100 complete overcast.
@ -2375,9 +2375,10 @@ Method to initialize an object defining weather conditions. This class has some
- `wind_intensity` (_float_) 0 is calm, 100 a strong wind. - `wind_intensity` (_float_) 0 is calm, 100 a strong wind.
- `sun_azimuth_angle` (_float_) 0 is an arbitrary North, 180 its corresponding South. - `sun_azimuth_angle` (_float_) 0 is an arbitrary North, 180 its corresponding South.
- `sun_altitude_angle` (_float_) 90 is midday, -90 is midnight. - `sun_altitude_angle` (_float_) 90 is midday, -90 is midnight.
- `fog_density` (_float_) Density of the fog, from 0 to 100. - `fog_density` (_float_) Concentration or thickness of the fog, from 0 to 100.
- `fog_distance` (_float_) Distance where the fog starts in meters. - `fog_distance` (_float_) Distance where the fog starts in meters.
- `wetness` (_float_) Humidity percentages of the road, from 0 to 100. - `wetness` (_float_) Humidity percentages of the road, from 0 to 100.
- `falloff` (_float_) Density (specific mass) of the fog, from 0 to infinity.
- **Note:** <font color="#8E8E8E">_ClearNoon, CloudyNoon, WetNoon, WetCloudyNoon, SoftRainNoon, MidRainyNoon, HardRainNoon, ClearSunset, CloudySunset, WetSunset, WetCloudySunset, SoftRainSunset, MidRainSunset, HardRainSunset. - **Note:** <font color="#8E8E8E">_ClearNoon, CloudyNoon, WetNoon, WetCloudyNoon, SoftRainNoon, MidRainyNoon, HardRainNoon, ClearSunset, CloudySunset, WetSunset, WetCloudySunset, SoftRainSunset, MidRainSunset, HardRainSunset.
_</font> _</font>

View File

@ -30,10 +30,15 @@
doc: > doc: >
Controls the strenght of the wind with values from 0, no wind at all, to 100, a strong wind. The wind does affect rain direction and leaves from trees, so this value is restricted to avoid animation issues. Controls the strenght of the wind with values from 0, no wind at all, to 100, a strong wind. The wind does affect rain direction and leaves from trees, so this value is restricted to avoid animation issues.
# -------------------------------------- # --------------------------------------
- var_name: falloff - var_name: sun_azimuth_angle
type: float type: float
doc: > doc: >
Density of the fog (as in specific mass). The bigger the value, the more dense and heavy it will be, and the fog will reach smaller heights. Corresponds to <a href="https://docs.unrealengine.com/en-US/Engine/Actors/FogEffects/HeightFog/index.html#:~:text=Using%20Exponential%20Height%20Fog%20Features,-The%20sections%20below&text=Add%20a%20second%20fog%20layer,height%20falloff%2C%20and%20height%20offset">Fog Height Falloff</a> in the UE docs. <br> If the value is 0, the fog will be lighter than air, and will cover the whole scene. <br> A value of 1 is approximately as dense as the air, and reaches normal-sized buildings. <br> For values greater than 5, the air will be so dense that it will be compressed on ground level. The azimuth angle of the sun in degrees. Values range from 0 to 360. Zero is an origin point in a sphere determined by Unreal Engine.
# --------------------------------------
- var_name: sun_altitude_angle
type: float
doc: >
Altitude angle of the sun in degrees. Values range from -90 to 90 corresponding to midnight and midday each.
# -------------------------------------- # --------------------------------------
- var_name: fog_density - var_name: fog_density
type: float type: float
@ -50,15 +55,10 @@
doc: > doc: >
Wetness intensity. It only affects the RGB camera sensor. Values range from 0 to 100. Wetness intensity. It only affects the RGB camera sensor. Values range from 0 to 100.
# -------------------------------------- # --------------------------------------
- var_name: sun_azimuth_angle - var_name: falloff
type: float type: float
doc: > doc: >
The azimuth angle of the sun in degrees. Values range from 0 to 360. Zero is an origin point in a sphere determined by Unreal Engine. Density of the fog (as in specific mass) from 0 to infinity. The bigger the value, the more dense and heavy it will be, and the fog will reach smaller heights. Corresponds to <a href="https://docs.unrealengine.com/en-US/Engine/Actors/FogEffects/HeightFog/index.html#:~:text=Using%20Exponential%20Height%20Fog%20Features,-The%20sections%20below&text=Add%20a%20second%20fog%20layer,height%20falloff%2C%20and%20height%20offset">Fog Height Falloff</a> in the UE docs. <br> If the value is 0, the fog will be lighter than air, and will cover the whole scene. <br> A value of 1 is approximately as dense as the air, and reaches normal-sized buildings. <br> For values greater than 5, the air will be so dense that it will be compressed on ground level.
# --------------------------------------
- var_name: sun_altitude_angle
type: float
doc: >
Altitude angle of the sun in degrees. Values range from -90 to 90 corresponding to midnight and midday each.
# - METHODS ---------------------------- # - METHODS ----------------------------
methods: methods:
@ -98,7 +98,7 @@
type: float type: float
default: 0.0 default: 0.0
doc: > doc: >
Density of the fog, from 0 to 100. Concentration or thickness of the fog, from 0 to 100.
- param_name: fog_distance - param_name: fog_distance
type: float type: float
default: 0.0 default: 0.0
@ -109,6 +109,11 @@
default: 0.0 default: 0.0
doc: > doc: >
Humidity percentages of the road, from 0 to 100. Humidity percentages of the road, from 0 to 100.
- param_name: falloff
type: float
default: 0.2
doc: >
Density (specific mass) of the fog, from 0 to infinity.
note: > note: >
ClearNoon, CloudyNoon, WetNoon, WetCloudyNoon, SoftRainNoon, MidRainyNoon, HardRainNoon, ClearSunset, CloudySunset, WetSunset, WetCloudySunset, SoftRainSunset, MidRainSunset, HardRainSunset. ClearNoon, CloudyNoon, WetNoon, WetCloudyNoon, SoftRainNoon, MidRainyNoon, HardRainNoon, ClearSunset, CloudySunset, WetSunset, WetCloudySunset, SoftRainSunset, MidRainSunset, HardRainSunset.
doc: > doc: >