| Package | com.mi.rs |
| Class | public class GenericRenderCommand |
| Inheritance | GenericRenderCommand  Command Object |
| Implements | IRenderCommand |
| Property | Defined By | ||
|---|---|---|---|
 | isCancelled : Boolean [read-only]
Always false. | Command | |
| name : String [read-only]
The name of the RealityServer command to call. | Command | |
| params : Object [read-only]
An associative array containing the command arguments as
name/value pairs. | Command | |
| renderTarget : ImageRenderTarget [read-only]
Returns the ImageRenderTarget that will display the rendered
image. | GenericRenderCommand | ||
| Method | Defined By | ||
|---|---|---|---|
GenericRenderCommand(renderTarget:ImageRenderTarget, name:String, params:Object)
A generic implementation of the render command interface. | GenericRenderCommand | ||
createGetCanvasCommand(renderTarget:ImageRenderTarget, sceneName:String, renderContextName:String, canvasName:String, format:String = jpg):IRenderCommand [static]
Creates a "get_canvas" command with the most common options. | GenericRenderCommand | ||
createGetLastRenderCommand(renderTarget:ImageRenderTarget, sceneName:String, renderContextName:String, format:String = jpg):IRenderCommand [static]
Creates a "get_last_render" command with the most common options. | GenericRenderCommand | ||
createRenderCommand(renderTarget:ImageRenderTarget, sceneName:String, renderContextName:String = null, renderer:String = null, canvasName:String = null, format:String = jpg, renderContextTimeout:uint = 30):IRenderCommand [static]
Creates a "render" command with the most common options. | GenericRenderCommand | ||
| toString():String
Returns a string for debugging purposes. | Command | |
| renderTarget | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesrenderTarget:ImageRenderTarget [read-only] Returns the ImageRenderTarget that will display the rendered image.
public function get renderTarget():ImageRenderTarget| GenericRenderCommand | () | Constructor |
public function GenericRenderCommand(renderTarget:ImageRenderTarget, name:String, params:Object)A generic implementation of the render command interface. Use this class to invoke any command that returns an image. Use the factory methods to create more specialized render commands. It is possible to add properties after the command has been created by adding them to the params property.
ParametersrenderTarget:ImageRenderTarget | |
name:String | |
params:Object |
| createGetCanvasCommand | () | method |
public static function createGetCanvasCommand(renderTarget:ImageRenderTarget, sceneName:String, renderContextName:String, canvasName:String, format:String = jpg):IRenderCommandCreates a "get_canvas" command with the most common options. Additional parameters can be added to the params property after the render command has been created.
Parameters
renderTarget:ImageRenderTarget | |
sceneName:String | |
renderContextName:String | |
canvasName:String | |
format:String (default = jpg) |
IRenderCommand |
| createGetLastRenderCommand | () | method |
public static function createGetLastRenderCommand(renderTarget:ImageRenderTarget, sceneName:String, renderContextName:String, format:String = jpg):IRenderCommandCreates a "get_last_render" command with the most common options. Additional parameters can be added to the params property after the render command has been created.
Parameters
renderTarget:ImageRenderTarget | |
sceneName:String | |
renderContextName:String | |
format:String (default = jpg) |
IRenderCommand |
| createRenderCommand | () | method |
public static function createRenderCommand(renderTarget:ImageRenderTarget, sceneName:String, renderContextName:String = null, renderer:String = null, canvasName:String = null, format:String = jpg, renderContextTimeout:uint = 30):IRenderCommandCreates a "render" command with the most common options. Additional parameters can be added to the params property after the render command has been created.
Parameters
renderTarget:ImageRenderTarget | |
sceneName:String | |
renderContextName:String (default = null) | |
renderer:String (default = null) | |
canvasName:String (default = null) | |
format:String (default = jpg) | |
renderContextTimeout:uint (default = 30) |
IRenderCommand |