BlueSkies.Sun Class Reference

Controls a suns object position, size, lighting, and colors. More...

Inheritance diagram for BlueSkies.Sun:

Public Member Functions
override bool	initialize (string prefab)
override void	update ()

Protected Member Functions
override void	updateSize ()
override void	updateColor ()
override void	updateLighting ()
override Vector3	getPosition ()
Protected Member Functions inherited from BlueSkies.Celestial
virtual void	updatePosition ()
virtual void	generateParticleSystem ()
virtual void	placeInfrontOfCamera ()

Static Protected Attributes
static readonly float	_SUN_ILLUSION_MULTIPLIER = 2.0f
Static Protected Attributes inherited from BlueSkies.Celestial
static readonly float	_CELESTIAL_DISTANCE = 900f

Properties
Vector3	SunDirection [get, set]
float	SunAngle [get, set]
float	SunSetStartAngle [get, set]
float	SunSetStopAngle [get, set]
Properties inherited from BlueSkies.Celestial
Color	Color [get, set]
float	Size [get, set]
Vector3	Position [get]
Properties inherited from BlueSkies.ICelestial
Color	Color [get, set]
float	Size [get, set]
Vector3	Position [get]
Properties inherited from BlueSkies.ISun
Color	Color [get, set]
Vector3	Position [get]
Vector3	SunDirection [get, set]
float	SunAngle [get, set]
float	SunSetStartAngle [get, set]
float	SunSetStopAngle [get, set]

Additional Inherited Members
Protected Attributes inherited from BlueSkies.Celestial
GameObject	_gameObject = null
Color	_color
float	_size
Vector3	_position
string	_name
IParticleSystemGenerator	_generator = null

Detailed Description

Controls a suns object position, size, lighting, and colors.

Member Function Documentation

override Vector3 BlueSkies.Sun.getPosition ( )

protectedvirtual

Grabs the Suns surrent position

Returns

Postition of the Sun

Implements BlueSkies.Celestial.

override bool BlueSkies.Sun.initialize

(

string

prefab

)

Base initialization of sun bject

Returns

TRUE if successfully initialized

Parameters

[in]

prefab

String location of prefab

Implements BlueSkies.ISun.

override void BlueSkies.Sun.update

(

)

update on sun object

Implements BlueSkies.ISun.

override void BlueSkies.Sun.updateColor ( )

protectedvirtual

Updates the Sun object's color

Implements BlueSkies.Celestial.

override void BlueSkies.Sun.updateLighting ( )

protectedvirtual

Updates the Sun object's lights

Implements BlueSkies.Celestial.

override void BlueSkies.Sun.updateSize ( )

protectedvirtual

Updates the Sun object's size

Implements BlueSkies.Celestial.

---

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

• C:/code/BlueSkies/Unity/Assets/BlueSkies/Scripts/Sky/Sun.cs