Synthesizer element class property for use with XML loading. More...
Public Member Functions | |
| void | copyValue (ElementClass elementClass, ElementClassProperty property) |
| Copy value from another element class property of the same type. More... | |
| bool | getHasPreloaded () |
| Property has been preloaded. More... | |
| LoadSynthesizer | getLoader () |
| Synthesizer loader. More... | |
| String | getPath () |
| Path to synthesizer. More... | |
| Synthesizer | getSynthesizer () |
| Synthesizer or null if not present. More... | |
| Synthesizer | getSynthesizer (StubWithProperties stub, ElementClass eclass) |
| Synthesizer modified by stub property if present. More... | |
| bool | logPreloadProblems (ElementClass elementClass, Console console) |
| Log preloading problems. More... | |
| ECPSynthesizer | new (String name, LoadSynthesizer loader) |
| Create property. More... | |
| ECPSynthesizer | new (String name, LoadSynthesizer loader, String path) |
| Create property with initial path. More... | |
| void | preloadResources (ElementClass elementClass, PreloadCounter counter) |
| Preload resources if supported. More... | |
| void | setPath (String path) |
| Set path to synthesizer. More... | |
| void | setSynthesizer (Synthesizer synthesizer) |
| Set synthesizer or null if not present. 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
Synthesizer element class property for use with XML loading.
Synthesizer is set from XML using a path. Loads the synthesizer during preloading. The value of the property is then the loaded resource. If loading fails null synthesizer is stored.
Member Function Documentation
◆ copyValue()
| void Dragengine.Scenery.ECPSynthesizer.copyValue | ( | ElementClass | elementClass, |
| ElementClassProperty | property | ||
| ) |
Copy value from another element class property of the same type.
- Version
- 1.17
◆ getHasPreloaded()
| bool Dragengine.Scenery.ECPSynthesizer.getHasPreloaded | ( | ) |
Property has been preloaded.
◆ getLoader()
| LoadSynthesizer Dragengine.Scenery.ECPSynthesizer.getLoader | ( | ) |
Synthesizer loader.
◆ getPath()
| String Dragengine.Scenery.ECPSynthesizer.getPath | ( | ) |
Path to synthesizer.
◆ getSynthesizer() [1/2]
| Synthesizer Dragengine.Scenery.ECPSynthesizer.getSynthesizer | ( | ) |
Synthesizer or null if not present.
◆ getSynthesizer() [2/2]
| Synthesizer Dragengine.Scenery.ECPSynthesizer.getSynthesizer | ( | StubWithProperties | stub, |
| ElementClass | eclass | ||
| ) |
Synthesizer modified by stub property if present.
If named stub property is not present or empty string the stored synthesizer is returned. If the named stub property is present it is loaded as synthesizer resource.
◆ logPreloadProblems()
| bool Dragengine.Scenery.ECPSynthesizer.logPreloadProblems | ( | ElementClass | elementClass, |
| Console | console | ||
| ) |
Log preloading problems.
- Returns
- True if problems are present.
Reimplemented from Dragengine.Scenery.ElementClassProperty.
◆ new() [1/2]
| ECPSynthesizer Dragengine.Scenery.ECPSynthesizer.new | ( | String | name, |
| LoadSynthesizer | loader | ||
| ) |
Create property.
◆ new() [2/2]
| ECPSynthesizer Dragengine.Scenery.ECPSynthesizer.new | ( | String | name, |
| LoadSynthesizer | loader, | ||
| String | path | ||
| ) |
Create property with initial path.
◆ preloadResources()
| void Dragengine.Scenery.ECPSynthesizer.preloadResources | ( | ElementClass | elementClass, |
| PreloadCounter | counter | ||
| ) |
Preload resources if supported.
Reimplemented from Dragengine.Scenery.ElementClassProperty.
◆ setPath()
| void Dragengine.Scenery.ECPSynthesizer.setPath | ( | String | path | ) |
Set path to synthesizer.
◆ setSynthesizer()
| void Dragengine.Scenery.ECPSynthesizer.setSynthesizer | ( | Synthesizer | synthesizer | ) |
Set synthesizer or null if not present.
◆ setValue()
| void Dragengine.Scenery.ECPSynthesizer.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:
