| Package | flare.system |
| Class | public class Library3D |
| Inheritance | Library3D  flash.events.EventDispatcher |
| Implements | ILibraryExternalItem |
| Property | Defined By | ||
|---|---|---|---|
| allowEventsAfterComplete : Boolean
Allow to fire events (progress and complete) after the first complete event were dispatched. | Library3D | ||
| bytesLoaded : uint [read-only]
Returns the amount of bytes loaded. | Library3D | ||
| bytesTotal : uint [read-only]
Returns the amount of bytes that will be loaded. | Library3D | ||
| items : Vector.<ILibraryItem> [read-only]
Returns a copy of the stored items. | Library3D | ||
| itemsToLoad : Vector.<ILibraryExternalItem> [read-only]
Returns a copy of the stored items to be loaded. | Library3D | ||
| loaded : Boolean [read-only] | Library3D | ||
| progress : Number [read-only]
Returns the global progress of all the resources being currently loaded. | Library3D | ||
| request : * [read-only] | Library3D | ||
| Method | Defined By | ||
|---|---|---|---|
Library3D(connections:int = 10, autoStart:Boolean = true, allowEventsAfterComplete:Boolean = true)
Creates a new library object. | Library3D | ||
Adds a new item to the library. | Library3D | ||
close():void
Closes all connections. | Library3D | ||
dispose():void
Eliminates cached resources. | Library3D | ||
getItem(key:*):ILibraryItem
Returns an item instance previosuly associated to a path. | Library3D | ||
load():void
Start downloading. | Library3D | ||
Loads a new item object. | Library3D | ||
removeItem(key:*):ILibraryItem
Removes an item from the library. | Library3D | ||
reset():void
Removes all items and clean all references. | Library3D | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| This event occurs once the loading process of all the library elements has been completed. | Library3D | |||
| Dispatched if a call to load() results in a fatal error that terminates the download. | Library3D | |||
| This event occurs whenever the loading progress of the elements of a library is modified. | Library3D | |||
| This event occurs when the library has been updated. | Library3D | |||
| allowEventsAfterComplete | property |
allowEventsAfterComplete:BooleanAllow to fire events (progress and complete) after the first complete event were dispatched. It can be used to load multiple packages.
public function get allowEventsAfterComplete():Boolean public function set allowEventsAfterComplete(value:Boolean):void| bytesLoaded | property |
bytesLoaded:uint [read-only] Returns the amount of bytes loaded.
public function get bytesLoaded():uint| bytesTotal | property |
bytesTotal:uint [read-only] Returns the amount of bytes that will be loaded.
public function get bytesTotal():uint| items | property |
items:Vector.<ILibraryItem> [read-only] Returns a copy of the stored items.
public function get items():Vector.<ILibraryItem>| itemsToLoad | property |
itemsToLoad:Vector.<ILibraryExternalItem> [read-only] Returns a copy of the stored items to be loaded.
public function get itemsToLoad():Vector.<ILibraryExternalItem>| loaded | property |
loaded:Boolean [read-only] public function get loaded():Boolean| progress | property |
progress:Number [read-only] Returns the global progress of all the resources being currently loaded. Once the 'complete' event has been received, it will be set back to zero and a new progress stage will begin if new resources are loaded only if allowEventsAfterComplete is seted to true in the class constructor,
public function get progress():Number| request | property |
request:* [read-only] public function get request():*| Library3D | () | Constructor |
public function Library3D(connections:int = 10, autoStart:Boolean = true, allowEventsAfterComplete:Boolean = true)Creates a new library object.
Parametersconnections:int (default = 10) | |
autoStart:Boolean (default = true) | |
allowEventsAfterComplete:Boolean (default = true) |
| addItem | () | method |
public function addItem(key:*, item:ILibraryItem):ILibraryItemAdds a new item to the library. This method asociates the item instance to a key-path to be used with the getItem() method. Also adds the item to a collecion of items. This method isn't related to the loading proccess, just stores the items for future use. To add items to the loading queue, use the push method.
Parameters
key:* — Path or key to associate the item.
| |
item:ILibraryItem — The item instance.
|
ILibraryItem |
See also
| close | () | method |
public function close():voidCloses all connections.
| dispose | () | method |
public function dispose():voidEliminates cached resources.
| getItem | () | method |
public function getItem(key:*):ILibraryItemReturns an item instance previosuly associated to a path.
Parameters
key:* — Path of the item instance.
|
ILibraryItem — The item corresponding to the path, null othwrwise.
|
See also
| load | () | method |
public function load():voidStart downloading. If autoStart propery was seted to true in the constructor, this method will be automatically called when loads the first file.
| push | () | method |
public function push(item:ILibraryExternalItem):ILibraryExternalItemLoads a new item object. If the item can not be loaded inmediately (depending of the amount of available connections), it will be added to a queue to be load when connections are available.
Parameters
item:ILibraryExternalItem |
ILibraryExternalItem — true if was sucesful, false otherwise.
|
| removeItem | () | method |
public function removeItem(key:*):ILibraryItemRemoves an item from the library. This method removes the association of an item instance with its key-path that is used with the getItem() method. Also removes the item from the collecion of items. This method isn't related to the loading proccess, just stores the items for future use.
Parameters
key:* — Path or key to associate the item.
|
ILibraryItem — The removed item if any.
|
| reset | () | method |
public function reset():voidRemoves all items and clean all references.
| complete | Event |
flash.events.Eventflash.events.EventThis event occurs once the loading process of all the library elements has been completed.
| ioError | Event |
flash.events.IOErrorEventflash.events.IOErrorEvent.IO_ERRORDispatched if a call to load() results in a fatal error that terminates the download.
| progress | Event |
flash.events.ProgressEventflash.events.EventThis event occurs whenever the loading progress of the elements of a library is modified.
| updated | Event |
flash.events.Eventflash.events.EventThis event occurs when the library has been updated.