Drag[en]gine Script Module DragonScript Script API  1.0
Sky Class Reference

Sky. More...

Inheritance diagram for Sky:

Public Member Functions

Constructors
Sky new ()
 Create sky. More...
 
Management
Color getBackgroundColor ()
 Background color. More...
 
void setBackgroundColor (Color color)
 Set background color. More...
 
void update (float elapsed)
 Update sky with time elapsed since last update. More...
 
Layers
int getLayerCount ()
 Number of layers. More...
 
void addLayer ()
 Add sky layer. More...
 
void removeLayerAt (int index)
 Remove layer at the given position. More...
 
void removeAllLayers ()
 Remove all layers. More...
 
Vector getLayerPosition (int layer)
 Position of layer. More...
 
void setLayerPosition (int layer, Vector position)
 Set position of layer. More...
 
Quaternion getLayerOrientation (int layer)
 Orientation of layer. More...
 
void setLayerOrientation (int layer, Quaternion orientation)
 Set orientation of layer. More...
 
Vector getLayerSize (int layer)
 Size of layer. More...
 
void setLayerSize (int layer, Vector size)
 Set size of layer. More...
 
Color getLayerColor (int layer)
 Color of layer. More...
 
void setLayerColor (int layer, Color color)
 Set color of layer. More...
 
float getLayerIntensity (int layer)
 Intensity of layer. More...
 
void setLayerIntensity (int layer, float intensity)
 Set intensity of layer. More...
 
Skin getLayerSkin (int layer)
 Skin of layer or null if not set. More...
 
void setLayerSkin (int layer, Skin skin)
 Set skin of layer or null if not set. More...
 
Layer bodies
int getLayerBodyCount (int layer)
 Number of bodies in layer. More...
 
void addLayerBody (int layer, int texture, Quaternion orientation, float width, float height, Color color)
 Add body to layer. More...
 
void setLayerBody (int layer, int body, int texture, Quaternion orientation, float width, float height, Color color)
 Set parameters of body in layer. More...
 
void removeLayerBody (int layer, int body)
 Remove body from layer. More...
 
void removeLayerAllBodies (int layer)
 Remove all bodies from layer. More...
 
Layer lighting
Color getLayerLightColor (int layer)
 Light color of layer. More...
 
void setLayerLightColor (int layer, Color color)
 Set light color of layer. More...
 
float getLayerLightIntensity (int layer)
 Intensity of layer light. More...
 
void setLayerLightIntensity (int layer, float intensity)
 Set intensity of layer light. More...
 

Detailed Description

Sky.

This is a native class.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ addLayer()

void addLayer ( )

Add sky layer.

§ addLayerBody()

void addLayerBody ( int  layer,
int  texture,
Quaternion  orientation,
float  width,
float  height,
Color  color 
)

Add body to layer.

Exceptions
EOutOfBoundarylayer is less than 0 or greater than or equal to getLayerCount().

§ getBackgroundColor()

Color getBackgroundColor ( )

Background color.

§ getLayerBodyCount()

int getLayerBodyCount ( int  layer)

Number of bodies in layer.

Exceptions
EOutOfBoundarylayer is less than 0 or greater than or equal to getLayerCount().

§ getLayerColor()

Color getLayerColor ( int  layer)

Color of layer.

Exceptions
EOutOfBoundarylayer is less than 0 or greater than or equal to getLayerCount().

§ getLayerCount()

int getLayerCount ( )

Number of layers.

§ getLayerIntensity()

float getLayerIntensity ( int  layer)

Intensity of layer.

Exceptions
EOutOfBoundarylayer is less than 0 or greater than or equal to getLayerCount().

§ getLayerLightColor()

Color getLayerLightColor ( int  layer)

Light color of layer.

Exceptions
EOutOfBoundarylayer is less than 0 or greater than or equal to getLayerCount().

§ getLayerLightIntensity()

float getLayerLightIntensity ( int  layer)

Intensity of layer light.

Exceptions
EOutOfBoundarylayer is less than 0 or greater than or equal to getLayerCount().

§ getLayerOrientation()

Quaternion getLayerOrientation ( int  layer)

Orientation of layer.

Exceptions
EOutOfBoundarylayer is less than 0 or greater than or equal to getLayerCount().

§ getLayerPosition()

Vector getLayerPosition ( int  layer)

Position of layer.

Exceptions
EOutOfBoundarylayer is less than 0 or greater than or equal to getLayerCount().

§ getLayerSize()

Vector getLayerSize ( int  layer)

Size of layer.

Exceptions
EOutOfBoundarylayer is less than 0 or greater than or equal to getLayerCount().

§ getLayerSkin()

Skin getLayerSkin ( int  layer)

Skin of layer or null if not set.

Exceptions
EOutOfBoundarylayer is less than 0 or greater than or equal to getLayerCount().

§ new()

Sky new ( )

Create sky.

§ removeAllLayers()

void removeAllLayers ( )

Remove all layers.

§ removeLayerAllBodies()

void removeLayerAllBodies ( int  layer)

Remove all bodies from layer.

Exceptions
EOutOfBoundarylayer is less than 0 or greater than or equal to getLayerCount().

§ removeLayerAt()

void removeLayerAt ( int  index)

Remove layer at the given position.

Exceptions
EOutOfBoundaryindex is less than 0 or greater than or equal to getLayerCount().

§ removeLayerBody()

void removeLayerBody ( int  layer,
int  body 
)

Remove body from layer.

Exceptions
EOutOfBoundarylayer is less than 0 or greater than or equal to getLayerCount().
EOutOfBoundarybody is less than 0 or greater than or equal to getLayerBodyCount().

§ setBackgroundColor()

void setBackgroundColor ( Color  color)

Set background color.

§ setLayerBody()

void setLayerBody ( int  layer,
int  body,
int  texture,
Quaternion  orientation,
float  width,
float  height,
Color  color 
)

Set parameters of body in layer.

Exceptions
EOutOfBoundarylayer is less than 0 or greater than or equal to getLayerCount().
EOutOfBoundarybody is less than 0 or greater than or equal to getLayerBodyCount().

§ setLayerColor()

void setLayerColor ( int  layer,
Color  color 
)

Set color of layer.

Exceptions
EOutOfBoundarylayer is less than 0 or greater than or equal to getLayerCount().

§ setLayerIntensity()

void setLayerIntensity ( int  layer,
float  intensity 
)

Set intensity of layer.

Exceptions
EOutOfBoundarylayer is less than 0 or greater than or equal to getLayerCount().

§ setLayerLightColor()

void setLayerLightColor ( int  layer,
Color  color 
)

Set light color of layer.

Exceptions
EOutOfBoundarylayer is less than 0 or greater than or equal to getLayerCount().

§ setLayerLightIntensity()

void setLayerLightIntensity ( int  layer,
float  intensity 
)

Set intensity of layer light.

Exceptions
EOutOfBoundarylayer is less than 0 or greater than or equal to getLayerCount().

§ setLayerOrientation()

void setLayerOrientation ( int  layer,
Quaternion  orientation 
)

Set orientation of layer.

Exceptions
EOutOfBoundarylayer is less than 0 or greater than or equal to getLayerCount().

§ setLayerPosition()

void setLayerPosition ( int  layer,
Vector  position 
)

Set position of layer.

Exceptions
EOutOfBoundarylayer is less than 0 or greater than or equal to getLayerCount().

§ setLayerSize()

void setLayerSize ( int  layer,
Vector  size 
)

Set size of layer.

Exceptions
EOutOfBoundarylayer is less than 0 or greater than or equal to getLayerCount().

§ setLayerSkin()

void setLayerSkin ( int  layer,
Skin  skin 
)

Set skin of layer or null if not set.

Exceptions
EOutOfBoundarylayer is less than 0 or greater than or equal to getLayerCount().

§ update()

void update ( float  elapsed)

Update sky with time elapsed since last update.


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