BlueSkies for Unity  1.8.1
BlueSkies.WindVolume Class Reference

Represents one vertical layer of wind to affect the clouds. More...

Inheritance diagram for BlueSkies.WindVolume:
BlueSkies.IWindVolume

Public Member Functions

 WindVolume (float minAltitude, float maxAltitude, float windSpeed, float direction)
 
bool contains (ICloud cloud)
 
bool contains (ICloudLayer cloudLayer)
 

Properties

ulong UID [get]
 
float MinAltitude [get, set]
 
float MaxAltitude [get, set]
 
float WindSpeed [get, set]
 
float WindDirection [get, set]
 
Vector3 VelocityVector [get]
 
- Properties inherited from BlueSkies.IWindVolume
ulong UID [get]
 
float MinAltitude [get, set]
 
float MaxAltitude [get, set]
 
float WindSpeed [get, set]
 
float WindDirection [get, set]
 
Vector3 VelocityVector [get]
 

Detailed Description

Represents one vertical layer of wind to affect the clouds.

All clouds within the bounds of a WindVolume will be blown along at the specified wind speed in the specified direction.

Direction is given in degrees from north.

North: 0
East:  90
South: 180
West:  270

North is assumed to be along the +Z axis.

Constructor & Destructor Documentation

BlueSkies.WindVolume.WindVolume ( float  minAltitude,
float  maxAltitude,
float  windSpeed,
float  direction 
)
Parameters
[in]minAltitudeAltitude that the WindVolume begins to take effect.
[in]maxAltitudeAltitude that the WindVolume stops taking effect.
[in]windSpeedSpeed of the wind.
[in]directionDirection of the wind (in degrees from North).

Member Function Documentation

bool BlueSkies.WindVolume.contains ( ICloud  cloud)

Checks if cloud is contained in WinVolume

Parameters
[in]cloudCloud we are checking
Returns
TRUE if statement is correct

Implements BlueSkies.IWindVolume.

bool BlueSkies.WindVolume.contains ( ICloudLayer  cloudLayer)

Checks if cloudLayer is contained in WinVolume

Parameters
[in]cloudLayerCloud layer we are checking
Returns
TRUE if statement is correct

Implements BlueSkies.IWindVolume.


The documentation for this class was generated from the following file: