Dragengine.Scenery.Sky Class Reference

Sky. More...

Inheritance diagram for Dragengine.Scenery.Sky:

Public Member Functions
Constructors
Sky	new ()
	Create sky.
Management
Color	getBgColor ()
	Background color.
void	setBgColor (Color color)
	Set background color.
int	getControllerCount ()
	Number of controllers.
void	setControllerCount (int count)
	Set number of controllers.
SkyController	getControllerAt (int index)
	Get wrapper for controller.
SkyController	getControllerNamed (String name)
	Get wrapper for controller if present.
int	indexOfControllerNamed (String name)
	Index of named controller or -1 if not found.
int	getLinkCount ()
	Number of links.
void	setLinkCount (int count)
	Set number of links.
SkyLink	getLinkAt (int index)
	Get wrapper for link.
int	getLayerCount ()
	Number of layers.
void	setLayerCount (int count)
	Set number of layers.
SkyLayer	getLayerAt (int index)
	Get wrapper for layer.
void	contentChanged ()
	Notify peer parameters changed.

Detailed Description

Sky.

This is a native class.

Member Function Documentation

contentChanged()

void Dragengine.Scenery.Sky.contentChanged

(

)

Notify peer parameters changed.

Use after changing one or more parameters. If possible avoid changing parameters while sky instances use this sky.

getBgColor()

Color Dragengine.Scenery.Sky.getBgColor

(

)

Background color.

getControllerAt()

SkyController Dragengine.Scenery.Sky.getControllerAt

(

int

index

)

Get wrapper for controller.

Warning

The wrapper is only valid as long as the controller structure in the parent sky is not changed.

Parameters

index

Index of controller. If index is negative controller count is added to it. This allows to get controllers starting from the last controller.

Exceptions

EOutOfBoundary

controller is less than -getControllerCount() or larger than or equal to getControllerCount().

getControllerCount()

int Dragengine.Scenery.Sky.getControllerCount

(

)

Number of controllers.

getControllerNamed()

SkyController Dragengine.Scenery.Sky.getControllerNamed

(

String

name

)

Get wrapper for controller if present.

Warning

The wrapper is only valid as long as the controller structure in the animator is not changed.

Parameters

name	Name of controller. If no controller with this name is present null is returned.

getLayerAt()

SkyLayer Dragengine.Scenery.Sky.getLayerAt

(

int

index

)

Get wrapper for layer.

Warning

The wrapper is only valid as long as the layer structure in the parent sky is not changed.

Exceptions

EOutOfBoundary

layer is less than 0 or larger than or equal to getLayerCount().

getLayerCount()

int Dragengine.Scenery.Sky.getLayerCount

(

)

Number of layers.

getLinkAt()

SkyLink Dragengine.Scenery.Sky.getLinkAt

(

int

index

)

Get wrapper for link.

Warning

The wrapper is only valid as long as the link structure in the parent sky is not changed.

Exceptions

EOutOfBoundary

link is less than 0 or larger than or equal to getLinkCount().

getLinkCount()

int Dragengine.Scenery.Sky.getLinkCount

(

)

Number of links.

indexOfControllerNamed()

int Dragengine.Scenery.Sky.indexOfControllerNamed

(

String

name

)

Index of named controller or -1 if not found.

new()

Sky Dragengine.Scenery.Sky.new

(

)

Create sky.

setBgColor()

void Dragengine.Scenery.Sky.setBgColor

(

Color

color

)

Set background color.

setControllerCount()

void Dragengine.Scenery.Sky.setControllerCount

(

int

count

)

Set number of controllers.

Sets all controllers to default vaules.

setLayerCount()

void Dragengine.Scenery.Sky.setLayerCount

(

int

count

)

Set number of layers.

Sets all layers to default vaules.

setLinkCount()

void Dragengine.Scenery.Sky.setLinkCount

(

int

count

)

Set number of links.

Sets all links to default vaules.

---

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

• Sky.ds