Dragengine.Scenery.ECPNavigationSpace Class Reference

Navigation space resource element class property for use with XML loading. More...

Inheritance diagram for Dragengine.Scenery.ECPNavigationSpace:

Public Member Functions
void	copyValue (ElementClass elementClass, ElementClassProperty property)
	Copy value from another element class property of the same type.
bool	getHasPreloaded ()
	Property has been preloaded.
LoadNavigationSpace	getLoader ()
	Navigation spa ce loader.
NavigationSpace	getNavigationSpaceCopy ()
	Copy of shared navigation space resource or null if not present.
NavigationSpace	getNavigationSpaceShared ()
	Shared navigation space resource or null if not present.
String	getPath ()
	Path to navigation space resource.
bool	logPreloadProblems (ElementClass elementClass, Console console)
	Log preloading problems.
ECPNavigationSpace	new (String name, LoadNavigationSpace loader)
	Create property.
ECPNavigationSpace	new (String name, LoadNavigationSpace loader, String path)
	Create property with initial path.
void	preloadResources (ElementClass elementClass, PreloadCounter counter)
	Preload resources if supported.
void	setNavigationSpace (NavigationSpace navigationSpace)
	Set navigation space resource or null if not present.
void	setPath (String path)
	Set path to navigation space resource.
void	setValue (Object value)
	Set value of property from XML decoded value.
Public Member Functions inherited from Dragengine.Scenery.ElementClassProperty
void	dispose ()
	Dispose of element class property to break reference loops.
String	getName ()
	Name.
ElementClassProperty	new (String name)
	Create property.

Public Attributes
Exception	pException
bool	pHasPreloaded
LoadNavigationSpace	pLoader
NavigationSpace	pNavigationSpace
String	pPath

Detailed Description

Navigation space resource element class property for use with XML loading.

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

Note

Navigation space resources can not be shared. For this reason there exists no getNavigationSpace() method but a getNavigationSpaceCopy() method which returns a copy of the navigation space which is safe to be used and a getNavigationSpaceShared() which returns the shared source navigation space.

Member Function Documentation

copyValue()

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

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

Version

1.17

getHasPreloaded()

bool Dragengine.Scenery.ECPNavigationSpace.getHasPreloaded

(

)

Property has been preloaded.

getLoader()

LoadNavigationSpace Dragengine.Scenery.ECPNavigationSpace.getLoader

(

)

Navigation spa ce loader.

getNavigationSpaceCopy()

NavigationSpace Dragengine.Scenery.ECPNavigationSpace.getNavigationSpaceCopy

(

)

Copy of shared navigation space resource or null if not present.

Note

Navigation space can not be shared. This method returns a copy which is safe to be added to world.

getNavigationSpaceShared()

NavigationSpace Dragengine.Scenery.ECPNavigationSpace.getNavigationSpaceShared

(

)

Shared navigation space resource or null if not present.

Warning

Do not use this navigation space in a world. It can not be shared. This method is for informational purpose. Use getNavigationSpaceCopy() to obtain a navigation space that you can add to world safely.

getPath()

String Dragengine.Scenery.ECPNavigationSpace.getPath

(

)

Path to navigation space resource.

logPreloadProblems()

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

Log preloading problems.

Returns

True if problems are present.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

References Dragengine.Scenery.logPreloadProblems().

new() [1/2]

ECPNavigationSpace Dragengine.Scenery.ECPNavigationSpace.new	(	String	name,
		LoadNavigationSpace	loader
	)

Create property.

new() [2/2]

ECPNavigationSpace Dragengine.Scenery.ECPNavigationSpace.new	(	String	name,
		LoadNavigationSpace	loader,
		String	path
	)

Create property with initial path.

preloadResources()

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

Preload resources if supported.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

setNavigationSpace()

void Dragengine.Scenery.ECPNavigationSpace.setNavigationSpace

(

NavigationSpace

navigationSpace

)

Set navigation space resource or null if not present.

setPath()

void Dragengine.Scenery.ECPNavigationSpace.setPath

(

String

path

)

Set path to navigation space resource.

setValue()

void Dragengine.Scenery.ECPNavigationSpace.setValue

(

Object

value

)

Set value of property from XML decoded value.

Reimplemented from Dragengine.Scenery.ElementClassProperty.

Member Data Documentation

pException

Exception Dragengine.Scenery.ECPNavigationSpace.pException

pHasPreloaded

bool Dragengine.Scenery.ECPNavigationSpace.pHasPreloaded

pLoader

LoadNavigationSpace Dragengine.Scenery.ECPNavigationSpace.pLoader

pNavigationSpace

NavigationSpace Dragengine.Scenery.ECPNavigationSpace.pNavigationSpace

pPath

String Dragengine.Scenery.ECPNavigationSpace.pPath

---

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

• ECPNavigationSpace.ds