Dragengine.Scenery.DynamicSkin Class Reference

Dynamic skin. More...

Inheritance diagram for Dragengine.Scenery.DynamicSkin:

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

Detailed Description

Dynamic skin.

This is a native class.

Member Function Documentation

addRenderable()

void Dragengine.Scenery.DynamicSkin.addRenderable	(	String	name,
		DynamicSkinRenderableType	type
	)

Add named renderable.

Exceptions

EInvalidParam

Named renderable is present.

getCameraAt()

Camera Dragengine.Scenery.DynamicSkin.getCameraAt

(

int

renderable

)

Renderable camera or null if not set.

Version

1.20

Exceptions

EOutOfBoundary	renderable is less than 0 or greater than or equal to getRenderableCount().
EInvalidParam	Renderable is not of type DynamicSkinRenderableType.camera.

getCanvasAt()

CanvasView Dragengine.Scenery.DynamicSkin.getCanvasAt

(

int

renderable

)

Renderable canvas or null if not set.

Exceptions

EOutOfBoundary	renderable is less than 0 or greater than or equal to getRenderableCount().
EInvalidParam	Renderable is not of type DynamicSkinRenderableType.canvas.

getColorAt()

Color Dragengine.Scenery.DynamicSkin.getColorAt

(

int

renderable

)

Renderable color or null if not set.

Version

1.20

Exceptions

EOutOfBoundary	renderable is less than 0 or greater than or equal to getRenderableCount().
EInvalidParam	Renderable is not of type DynamicSkinRenderableType.color.

getImageAt()

Image Dragengine.Scenery.DynamicSkin.getImageAt

(

int

renderable

)

Renderable image or null if not set.

Version

1.20

Exceptions

EOutOfBoundary	renderable is less than 0 or greater than or equal to getRenderableCount().
EInvalidParam	Renderable is not of type DynamicSkinRenderableType.image.

getRenderableCount()

int Dragengine.Scenery.DynamicSkin.getRenderableCount

(

)

Number of renderables.

getTypeAt()

DynamicSkinRenderableType Dragengine.Scenery.DynamicSkin.getTypeAt

(

int

renderable

)

Type of renderable at index.

Exceptions

EOutOfBoundary

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

getValueAt()

float Dragengine.Scenery.DynamicSkin.getValueAt

(

int

renderable

)

Renderable value or null if not set.

Version

1.20

Exceptions

EOutOfBoundary	renderable is less than 0 or greater than or equal to getRenderableCount().
EInvalidParam	Renderable is not of type DynamicSkinRenderableType.value.

getVideoPlayerAt()

VideoPlayer Dragengine.Scenery.DynamicSkin.getVideoPlayerAt

(

int

renderable

)

Renderable video player or null if not set.

Version

1.20

Exceptions

EOutOfBoundary	renderable is less than 0 or greater than or equal to getRenderableCount().
EInvalidParam	Renderable is not of type DynamicSkinRenderableType.videoPlayer.

hasRenderable()

bool Dragengine.Scenery.DynamicSkin.hasRenderable

(

String

name

)

Named renderable is present.

indexOfRenderable()

int Dragengine.Scenery.DynamicSkin.indexOfRenderable

(

String

name

)

Index of named renderable or -1 if absent.

new()

DynamicSkin Dragengine.Scenery.DynamicSkin.new

(

)

Create dynamic skin.

removeAllRenderables()

void Dragengine.Scenery.DynamicSkin.removeAllRenderables

(

)

Remove all renderables.

removeRenderable()

void Dragengine.Scenery.DynamicSkin.removeRenderable

(

String

name

)

Remove named renderable.

Exceptions

EInvalidParam

Named renderable is absent.

setCameraAt()

void Dragengine.Scenery.DynamicSkin.setCameraAt	(	int	renderable,
		Camera	camera
	)

Set renderable camera or null if not set.

Exceptions

EOutOfBoundary	renderable is less than 0 or greater than or equal to getRenderableCount().
EInvalidParam	Renderable is not of type DynamicSkinRenderableType.camera.

setCanvasAt() [1/3]

void Dragengine.Scenery.DynamicSkin.setCanvasAt	(	int	renderable,
		CanvasView	canvas
	)

Set renderable canvas or null if not set.

Exceptions

EOutOfBoundary	renderable is less than 0 or greater than or equal to getRenderableCount().
EInvalidParam	Renderable is not of type DynamicSkinRenderableType.canvas.

setCanvasAt() [2/3]

void Dragengine.Scenery.DynamicSkin.setCanvasAt	(	int	renderable,
		CanvasView	canvas,
		int	componentCount
	)

Set renderable canvas or null if not set.

Version

1.7

Exceptions

EOutOfBoundary	renderable is less than 0 or greater than or equal to getRenderableCount().
EInvalidParam	Renderable is not of type DynamicSkinRenderableType.canvas.
EInvalidParam	componentCount is less than 1.
EInvalidParam	componentCount is greater than 4.

setCanvasAt() [3/3]

void Dragengine.Scenery.DynamicSkin.setCanvasAt	(	int	renderable,
		CanvasView	canvas,
		int	componentCount,
		int	bitCount
	)

Set renderable canvas or null if not set.

Version

1.7

Exceptions

EOutOfBoundary	renderable is less than 0 or greater than or equal to getRenderableCount().
EInvalidParam	Renderable is not of type DynamicSkinRenderableType.canvas.
EInvalidParam	componentCount is less than 1.
EInvalidParam	componentCount is greater than 4.
EInvalidParam	bitCount is not 8, 16 or 32.

setColorAt()

void Dragengine.Scenery.DynamicSkin.setColorAt	(	int	renderable,
		Color	color
	)

Set renderable color.

Exceptions

EOutOfBoundary	renderable is less than 0 or greater than or equal to getRenderableCount().
EInvalidParam	Renderable is not of type DynamicSkinRenderableType.color.

setImageAt()

void Dragengine.Scenery.DynamicSkin.setImageAt	(	int	renderable,
		Image	image
	)

Set renderable image or null if not set.

Exceptions

EOutOfBoundary	renderable is less than 0 or greater than or equal to getRenderableCount().
EInvalidParam	Renderable is not of type DynamicSkinRenderableType.image.

setValueAt()

void Dragengine.Scenery.DynamicSkin.setValueAt	(	int	renderable,
		float	value
	)

Set renderable value.

Exceptions

EOutOfBoundary	renderable is less than 0 or greater than or equal to getRenderableCount().
EInvalidParam	Renderable is not of type DynamicSkinRenderableType.value.

setVideoPlayerAt()

void Dragengine.Scenery.DynamicSkin.setVideoPlayerAt	(	int	renderable,
		VideoPlayer	videoPlayer
	)

Set renderable video player or null if not set.

Exceptions

EOutOfBoundary	renderable is less than 0 or greater than or equal to getRenderableCount().
EInvalidParam	Renderable is not of type DynamicSkinRenderableType.videoFrame.

---

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

• DynamicSkin.ds