- Source:
Module for dealing with the render queue.
Methods
(static) clear()
- Source:
Removes all items from the render queue.
(static) ensureRenderPathExists(outputModule)
- Source:
Checks if the folder where the output module is rendering to exists, if it does not exist, it gets created.
Parameters:
| Name | Type | Description |
|---|---|---|
outputModule |
OutputModule | The output module to check the render path of. |
(static) getQueuedComps() → {aeq.arrayEx}
- Source:
Gets all CompItems that are queued for rendering.
Returns:
ArrayEx of CompItems
- Type
- aeq.arrayEx
(static) getQueuedItems() → {aeq.arrayEx}
- Source:
Gets all RenderQueueItems in the render queue which are queued for
rendering.
Returns:
ArrayEx of RenderQueueItems
- Type
- aeq.arrayEx
(static) getRQComps() → {aeq.arrayEx}
- Source:
Gets all compItems added to the render queue.
Returns:
ArrayEx of CompItems in the render queue.
- Type
- aeq.arrayEx
(static) getRQItems() → {aeq.arrayEx}
- Source:
Gets all render queue items.
Returns:
ArrayEx of RenderQueueItems
- Type
- aeq.arrayEx
(static) getSettings(renderItem) → {Object}
Gets settings from a RenderQueueItem or OutputModule.
Parameters:
| Name | Type | Description |
|---|---|---|
renderItem |
RenderQueueItem | OutputModule | The object to get settings from. |
Returns:
Object with render settings as strings.
- Type
- Object
(static) isQueued(rqItem) → {boolean}
- Source:
Check if an item in the render queue is queued for rendering.
Parameters:
| Name | Type | Description |
|---|---|---|
rqItem |
RenderQueueItem | The item to check. |
Returns:
true if the item is going to be rendered.
- Type
- boolean
(static) omTemplateExists(templateName) → {boolean}
- Source:
Checks if the given output module template exists.
Parameters:
| Name | Type | Description |
|---|---|---|
templateName |
string | Name of the template to check if exists. |
Returns:
true if the output module template exists.
- Type
- boolean
(static) queue(item) → {RenderQueueItem}
- Source:
Add a project item to the render queue.
Parameters:
| Name | Type | Description |
|---|---|---|
item |
Item | CompItem | The item to add to the queue. |
Returns:
The added RenderQueueItem.
- Type
- RenderQueueItem
(static) rqTemplateExists(templateName) → {boolean}
- Source:
Checks if the given render queue template exists.
Parameters:
| Name | Type | Description |
|---|---|---|
templateName |
string | Name of the template to check. |
Returns:
true if the template exists.
- Type
- boolean
(static) unqueueAll()
- Source:
Unqueues all items in the render queue