Dragengine.Scenery.ECPAnimator Class Reference

Animator element class property for use with XML loading. More...

Inheritance diagram for Dragengine.Scenery.ECPAnimator:

Public Member Functions
void	copyValue (ElementClass elementClass, ElementClassProperty property)
	Copy value from another element class property of the same type. More...
Animator	getAnimator ()
	Animator or null if not present. More...
Animator	getAnimator (StubWithProperties stub, ElementClass eclass)
	Animator modified by stub property if present. More...
bool	getHasPreloaded ()
	Property has been preloaded. More...
LoadAnimator	getLoader ()
	Animator loader. More...
String	getPath ()
	Path to animator. More...
bool	logPreloadProblems (ElementClass elementClass, Console console)
	Log preloading problems. More...
ECPAnimator	new (String name, LoadAnimator loader)
	Create property. More...
ECPAnimator	new (String name, LoadAnimator loader, String path)
	Create property with initial path. More...
void	preloadResources (ElementClass elementClass, PreloadCounter counter)
	Preload resources if supported. More...
void	setAnimator (Animator animator)
	Set animator or null if not present. More...
void	setPath (String path)
	Set path to animator. More...
void	setValue (Object value)
	Set value of property from XML decoded value. More...
Public Member Functions inherited from Dragengine.Scenery.ElementClassProperty
void	dispose ()
	Dispose of element class property to break reference loops. More...
String	getName ()
	Name. More...
ElementClassProperty	new (String name)
	Create property. More...

Detailed Description

Animator element class property for use with XML loading.

Animator is set from XML using a path. Loads the animator during preloading. The value of the property is then the loaded resource. If loading fails null animator is stored.

Member Function Documentation

copyValue()

void Dragengine.Scenery.ECPAnimator.copyValue	(	ElementClass	elementClass,
		ElementClassProperty	property
	)

Copy value from another element class property of the same type.

Version

1.17

getAnimator() [1/2]

Animator Dragengine.Scenery.ECPAnimator.getAnimator

(

)

Animator or null if not present.

getAnimator() [2/2]

Animator Dragengine.Scenery.ECPAnimator.getAnimator	(	StubWithProperties	stub,
		ElementClass	eclass
	)

Animator modified by stub property if present.

If named stub property is not present or empty string the stored animator is returned. If the named stub property is present it is loaded as animator resource.

getHasPreloaded()

bool Dragengine.Scenery.ECPAnimator.getHasPreloaded

(

)

Property has been preloaded.

getLoader()

LoadAnimator Dragengine.Scenery.ECPAnimator.getLoader

(

)

Animator loader.

getPath()

String Dragengine.Scenery.ECPAnimator.getPath

(

)

Path to animator.

logPreloadProblems()

bool Dragengine.Scenery.ECPAnimator.logPreloadProblems	(	ElementClass	elementClass,
		Console	console
	)

Log preloading problems.

Returns

True if problems are present.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

new() [1/2]

ECPAnimator Dragengine.Scenery.ECPAnimator.new	(	String	name,
		LoadAnimator	loader
	)

Create property.

new() [2/2]

ECPAnimator Dragengine.Scenery.ECPAnimator.new	(	String	name,
		LoadAnimator	loader,
		String	path
	)

Create property with initial path.

preloadResources()

void Dragengine.Scenery.ECPAnimator.preloadResources	(	ElementClass	elementClass,
		PreloadCounter	counter
	)

Preload resources if supported.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

setAnimator()

void Dragengine.Scenery.ECPAnimator.setAnimator

(

Animator

animator

)

Set animator or null if not present.

setPath()

void Dragengine.Scenery.ECPAnimator.setPath

(

String

path

)

Set path to animator.

setValue()

void Dragengine.Scenery.ECPAnimator.setValue

(

Object

value

)

Set value of property from XML decoded value.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

---

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

• ECPAnimator.ds