BlueSkies for Unity  1.8.1
BlueSkies.CloudManager Class Reference

Manager for handling addition/creation/tracking of clouds. More...

Inheritance diagram for BlueSkies.CloudManager:
BlueSkies.ICloudManager

Public Member Functions

void initialize ()
 
ulong addCloud (ICloudDescriptor descriptor)
 
ulong addCloudLayer (ICloudLayerDescriptor descriptor)
 
bool removeCloud (ulong uid)
 
bool removeCloudLayer (ulong uid)
 
void update ()
 
ICloud getCloud (ulong uid)
 
ICloudLayer getCloudLayer (ulong uid)
 
uint getSizeOfManagedClouds ()
 
uint getSizeOfManagedLayers ()
 
bool isUnderPreciptitatingCloud (Vector3 position, ref ICloud _currentCloud)
 
bool isUnderCloud (Vector3 position, ICloud cloud)
 
GameObject getStratusParent ()
 
GameObject getCumulusParent ()
 
GameObject getCirrusParent ()
 

Public Attributes

List< ICloudLayer_cloudLayers = new List<ICloudLayer>()
 

Detailed Description

Manager for handling addition/creation/tracking of clouds.

Member Function Documentation

ulong BlueSkies.CloudManager.addCloud ( ICloudDescriptor  descriptor)

Creates a new managed individual cloud.

Parameters
[in]descriptorThe descriptor for the cloud
Returns
Unique identifier for the new cloud

Implements BlueSkies.ICloudManager.

ulong BlueSkies.CloudManager.addCloudLayer ( ICloudLayerDescriptor  descriptor)

Creates a new managed cloud layer.

Parameters
[in]descriptorThe descriptor for the cloud layer
Returns
Unique identifier for the new cloud layer

Implements BlueSkies.ICloudManager.

GameObject BlueSkies.CloudManager.getCirrusParent ( )
Returns
The GameObject that holds all generated Cirrus clouds and cloud layers

Implements BlueSkies.ICloudManager.

ICloud BlueSkies.CloudManager.getCloud ( ulong  uid)
Returns
The managed cloud with the specified ID

Implements BlueSkies.ICloudManager.

ICloudLayer BlueSkies.CloudManager.getCloudLayer ( ulong  uid)
Returns
The managed cloud layer with the specified ID

Implements BlueSkies.ICloudManager.

GameObject BlueSkies.CloudManager.getCumulusParent ( )
Returns
The GameObject that holds all generated Cumulus clouds and cloud layers

Implements BlueSkies.ICloudManager.

uint BlueSkies.CloudManager.getSizeOfManagedClouds ( )
Returns
The size of managed clouds

Implements BlueSkies.ICloudManager.

uint BlueSkies.CloudManager.getSizeOfManagedLayers ( )
Returns
The size of managed layers

Implements BlueSkies.ICloudManager.

GameObject BlueSkies.CloudManager.getStratusParent ( )
Returns
The GameObject that holds all generated Stratus clouds and cloud layers

Implements BlueSkies.ICloudManager.

void BlueSkies.CloudManager.initialize ( )

Initialize the CloudManager.

Implements BlueSkies.ICloudManager.

bool BlueSkies.CloudManager.isUnderCloud ( Vector3  position,
ICloud  cloud 
)

Checks if we are under a cloud

Parameters
[in]positionCurrent camera position
[in]_currentCloudCloud we are checking
Returns
TRUE if camera is beneath a cloud

Implements BlueSkies.ICloudManager.

bool BlueSkies.CloudManager.isUnderPreciptitatingCloud ( Vector3  position,
ref ICloud  _currentCloud 
)

Checks if we are under a precipitating cloud

Parameters
[in]positionCurrent camera position
[in]_currentCloudCloud we are checking
Returns
TRUE if camera is beneath a cloud that is precipitating

Implements BlueSkies.ICloudManager.

bool BlueSkies.CloudManager.removeCloud ( ulong  uid)

Removes the cloud with the specified identifier.

Parameters
[in]idUnique identifier of the cloud

Implements BlueSkies.ICloudManager.

bool BlueSkies.CloudManager.removeCloudLayer ( ulong  uid)

Removes the cloud layer with the specified identifier.

Parameters
[in]idUnique identifier of the cloud layer

Implements BlueSkies.ICloudManager.

void BlueSkies.CloudManager.update ( )

Updates all tracked clouds and layers.

Implements BlueSkies.ICloudManager.


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