Skip to main content

Renderer

                            
                              
                                class 
                                Renderer

The rendering logic used by the editor to export animations.

This class uses the PlaybackManager to render animations. In contrast to aplayer, a renderer does not use an update loop. It plays through theanimation as fast as it can, occasionally pausing to keep the UI responsive.

The actual exporting is outsourced to an Exporter .

Constructors ​

constructor ​ 

                            
                              
                                public 
                                new
                                Renderer
                                
                                  
                                    
                                      project
                                      : 
                                      Project
                                    
                                  
                                
                                : 
                                Renderer

Parameters

Properties ​

estimator ​ 

                            
                              
                                readonly 
                                public 
                                estimator
                                : 
                                TimeEstimator
                                 = 
                                ...

stage ​ 

                            
                              
                                readonly 
                                public 
                                stage
                                : 
                                Stage
                                 = 
                                ...

Accessors ​

onFinished ​ 

                            
                              
                                public 
                                get 
                                onFinished
                                (): 
                                Subscribable
                                
                                  
                                    
                                      RendererResult
                                    
                                    
                                      EventHandler
                                      
                                        
                                          
                                            RendererResult

onFrameChanged ​ 

                            
                              
                                public 
                                get 
                                onFrameChanged
                                (): 
                                SubscribableValueEvent
                                
                                  
                                    
                                      number

onStateChanged ​ 

                            
                              
                                public 
                                get 
                                onStateChanged
                                (): 
                                SubscribableValueEvent
                                
                                  
                                    
                                      RendererState

Methods ​

abort ​ 

                            
                              
                                public 
                                abort
                                (): 
                                void

Abort the ongoing render process.

render ​ 

                            
                              
                                public 
                                render
                                
                                  
                                    
                                      settings
                                      : 
                                      RendererSettings
                                    
                                  
                                
                                : 
                                Promise
                                
                                  
                                    
                                      void

Render the animation using the provided settings.

Parameters

  • settings : RendererSettings

    The rendering settings.

renderFrame ​ 

                            
                              
                                public 
                                renderFrame
                                
                                  
                                    
                                      settings
                                      : 
                                      RendererSettings
                                    
                                    
                                      time
                                      : 
                                      number
                                    
                                  
                                
                                : 
                                Promise
                                
                                  
                                    
                                      void

Export an individual frame.

This method always uses the default ImageExporter .

Parameters

  • settings : RendererSettings

    The rendering settings.

  • time : number

    The timestamp to export.