Video resource 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... | |
| void | failedLoading (String filename, ResourceLoaderType resourceType) |
| Resource failed loading. More... | |
| void | finishedLoading (String path, ResourceLoaderType resourceType, Object resource) |
| Resource has finished loading. More... | |
| bool | getHasPreloaded () |
| Property has been preloaded. More... | |
| String | getPath () |
| Path to video resource. More... | |
| Video | getVideo () |
| Video resource or null if not present. More... | |
| Video | getVideo (StubWithProperties stub, ElementClass eclass) |
| Video modified by stub property if present. More... | |
| bool | logPreloadProblems (ElementClass elementClass, Console console) |
| Log preloading problems. More... | |
| ECPVideo | new (String name) |
| Create property. More... | |
| ECPVideo | new (String name, 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 video resource. More... | |
| void | setValue (Object value) |
| Set value of property from XML decoded value. More... | |
| void | setVideo (Video video) |
| Set video resource or null if not present. 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... | |
Notification | |
Detailed Description
Video resource element class property for use with XML loading.
Video 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.
Member Function Documentation
◆ copyValue()
| void Dragengine.Scenery.ECPVideo.copyValue | ( | ElementClass | elementClass, |
| ElementClassProperty | property | ||
| ) |
Copy value from another element class property of the same type.
- Version
- 1.17
◆ failedLoading()
| void Dragengine.Scenery.ECPVideo.failedLoading | ( | String | filename, |
| ResourceLoaderType | resourceType | ||
| ) |
Resource failed loading.
Implements Dragengine.ResourceListener.
◆ finishedLoading()
| void Dragengine.Scenery.ECPVideo.finishedLoading | ( | String | path, |
| ResourceLoaderType | resourceType, | ||
| Object | resource | ||
| ) |
Resource has finished loading.
Implements Dragengine.ResourceListener.
◆ getHasPreloaded()
| bool Dragengine.Scenery.ECPVideo.getHasPreloaded | ( | ) |
Property has been preloaded.
◆ getPath()
| String Dragengine.Scenery.ECPVideo.getPath | ( | ) |
Path to video resource.
◆ getVideo() [1/2]
| Video Dragengine.Scenery.ECPVideo.getVideo | ( | ) |
Video resource or null if not present.
◆ getVideo() [2/2]
| Video Dragengine.Scenery.ECPVideo.getVideo | ( | StubWithProperties | stub, |
| ElementClass | eclass | ||
| ) |
Video modified by stub property if present.
If named stub property is not present or empty string the stored video is returned. If the named stub property is present it is loaded as video resource.
◆ logPreloadProblems()
| bool Dragengine.Scenery.ECPVideo.logPreloadProblems | ( | ElementClass | elementClass, |
| Console | console | ||
| ) |
Log preloading problems.
- Returns
- True if problems are present.
Reimplemented from Dragengine.Scenery.ElementClassProperty.
◆ new() [1/2]
| ECPVideo Dragengine.Scenery.ECPVideo.new | ( | String | name | ) |
Create property.
Reimplemented from Dragengine.Scenery.ElementClassProperty.
◆ new() [2/2]
| ECPVideo Dragengine.Scenery.ECPVideo.new | ( | String | name, |
| String | path | ||
| ) |
Create property with initial path.
◆ preloadResources()
| void Dragengine.Scenery.ECPVideo.preloadResources | ( | ElementClass | elementClass, |
| PreloadCounter | counter | ||
| ) |
Preload resources if supported.
Reimplemented from Dragengine.Scenery.ElementClassProperty.
◆ setPath()
| void Dragengine.Scenery.ECPVideo.setPath | ( | String | path | ) |
Set path to video resource.
◆ setValue()
| void Dragengine.Scenery.ECPVideo.setValue | ( | Object | value | ) |
Set value of property from XML decoded value.
Reimplemented from Dragengine.Scenery.ElementClassProperty.
◆ setVideo()
| void Dragengine.Scenery.ECPVideo.setVideo | ( | Video | video | ) |
Set video resource or null if not present.
The documentation for this class was generated from the following file:
