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

Dynamic skin. More...

Inheritance diagram for DynamicSkin:

Public Member Functions

Constructors
DynamicSkin new ()
 Create dynamic skin. More...
 
Management
int getRenderableCount ()
 Number of renderables. More...
 
bool hasRenderable (String name)
 Named renderable is present. More...
 
int indexOfRenderable (String name)
 Index of named renderable or -1 if absent. More...
 
void addRenderable (String name, int type)
 Add named renderable. More...
 
void removeRenderable (String name)
 Remove named renderable. More...
 
void removeAllRenderables ()
 Remove all renderables. More...
 
int getTypeAt (int renderable)
 Renderable at index. More...
 
void setValueAt (int renderable, float value)
 Set renderable value. More...
 
void setColorAt (int renderable, Color color)
 Set renderable color. More...
 
void setImageAt (int renderable, Image image)
 Set renderable image or null if not set. More...
 
CanvasView getCanvasAt (int renderable)
 Renderable canvas or null if not set. More...
 
void setCanvasAt (int renderable, CanvasView canvas)
 Set renderable canvas or null if not set. More...
 
void setCameraAt (int renderable, Camera camera)
 Set renderable camera or null if not set. More...
 
void setVideoPlayerAt (int renderable, VideoPlayer videoPlayer)
 Set renderable video player or null if not set. More...
 

Static Public Attributes

Type constants
static final int VALUE = 0
 Floating point value type. More...
 
static final int COLOR = 1
 Color type. More...
 
static final int IMAGE = 2
 Image type. More...
 
static final int CANVAS = 3
 Canvas type. More...
 
static final int CAMERA = 4
 Camera type. More...
 
static final int VIDEOFRAME = 5
 Video frame type. More...
 

Detailed Description

Dynamic skin.

This is a native class.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ addRenderable()

void addRenderable ( String  name,
int  type 
)

Add named renderable.

Exceptions
EInvalidParamNamed renderable is present.

§ getCanvasAt()

CanvasView getCanvasAt ( int  renderable)

Renderable canvas or null if not set.

Exceptions
EOutOfBoundaryrenderable is less than 0 or greater than or equal to getRenderableCount().
EInvalidParamRenderable is not of type DynamicSkin.CANVAS.

§ getRenderableCount()

int getRenderableCount ( )

Number of renderables.

§ getTypeAt()

int getTypeAt ( int  renderable)

Renderable at index.

Exceptions
EOutOfBoundaryrenderable is less than 0 or greater than or equal to getRenderableCount().

§ hasRenderable()

bool hasRenderable ( String  name)

Named renderable is present.

§ indexOfRenderable()

int indexOfRenderable ( String  name)

Index of named renderable or -1 if absent.

§ new()

DynamicSkin new ( )

Create dynamic skin.

§ removeAllRenderables()

void removeAllRenderables ( )

Remove all renderables.

§ removeRenderable()

void removeRenderable ( String  name)

Remove named renderable.

Exceptions
EInvalidParamNamed renderable is absent.

§ setCameraAt()

void setCameraAt ( int  renderable,
Camera  camera 
)

Set renderable camera or null if not set.

Exceptions
EOutOfBoundaryrenderable is less than 0 or greater than or equal to getRenderableCount().
EInvalidParamRenderable is not of type DynamicSkin.CAMERA.

§ setCanvasAt()

void setCanvasAt ( int  renderable,
CanvasView  canvas 
)

Set renderable canvas or null if not set.

Exceptions
EOutOfBoundaryrenderable is less than 0 or greater than or equal to getRenderableCount().
EInvalidParamRenderable is not of type DynamicSkin.CANVAS.

§ setColorAt()

void setColorAt ( int  renderable,
Color  color 
)

Set renderable color.

Exceptions
EOutOfBoundaryrenderable is less than 0 or greater than or equal to getRenderableCount().
EInvalidParamRenderable is not of type DynamicSkin.COLOR.

§ setImageAt()

void setImageAt ( int  renderable,
Image  image 
)

Set renderable image or null if not set.

Exceptions
EOutOfBoundaryrenderable is less than 0 or greater than or equal to getRenderableCount().
EInvalidParamRenderable is not of type DynamicSkin.IMAGE.

§ setValueAt()

void setValueAt ( int  renderable,
float  value 
)

Set renderable value.

Exceptions
EOutOfBoundaryrenderable is less than 0 or greater than or equal to getRenderableCount().
EInvalidParamRenderable is not of type DynamicSkin.VALUE.

§ setVideoPlayerAt()

void setVideoPlayerAt ( int  renderable,
VideoPlayer  videoPlayer 
)

Set renderable video player or null if not set.

Exceptions
EOutOfBoundaryrenderable is less than 0 or greater than or equal to getRenderableCount().
EInvalidParamRenderable is not of type DynamicSkin.VIDEOFRAME.

Member Data Documentation

§ CAMERA

final int CAMERA = 4
static

Camera type.

World rendered using a camera is used to define content of texture properties. For texture properties requiring less than 4 components the pixel intensities red, green and blue are consumed in this order. For texture properties requring a single value black is used. If camera is not set black color is used.

§ CANVAS

final int CANVAS = 3
static

Canvas type.

Canvas is rendered into a texture and the pixels thereof used to define content of texture properties. For texture properties requiring less than 4 components the pixel intensities red, green and blue are consumed in this order. For texture properties requring a single value black is used. If canvas is not set black color is used.

§ COLOR

final int COLOR = 1
static

Color type.

For texture properties requiring less than 4 components the intensities red, green and blue are consumed in this order.

§ IMAGE

final int IMAGE = 2
static

Image type.

Image pixels define content of texture properties. For texture properties requiring less than 4 components the pixel intensities red, green and blue are consumed in this order. For texture properties requring a single value black is used. If image is not set black color is used.

§ VALUE

final int VALUE = 0
static

Floating point value type.

For texture properties requiring more than one component the same value is used for all components except alphe which is set to 1.

§ VIDEOFRAME

final int VIDEOFRAME = 5
static

Video frame type.

Video player frame pixels define content of texture properties. For texture properties requiring less than 4 components the pixel intensities red, green and blue are consumed in this order. For texture properties requring a single value black is used. The video player is not modified by the renderable. The user has to update the video player. If image is not set black color is used.


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