Skip to main content

Scene2D

                            
                              
                                class 
                                Scene2D
                                extends 
                                
                                  
                                    
                                      GeneratorScene
                                      
                                        
                                          
                                            View2D
                                          
                                        
                                      
                                    
                                  
                                
                                implements 
                                
                                  
                                    
                                      Inspectable

Constructors ​

constructor ​ 

                            
                              
                                public 
                                override
                                new
                                Scene2D
                                
                                  
                                    
                                      description
                                      : 
                                      FullSceneDescription
                                      
                                        
                                          
                                            ThreadGeneratorFactory
                                            
                                              
                                                
                                                  View2D
                                                
                                              
                                            
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                Scene2D

Parameters

  • description : FullSceneDescription ThreadGeneratorFactory View2D
Overwrites GeneratorScene.constructor

Properties ​

creationStack ​ 

                            
                              
                                creationStack
                                ?: 
                                string
Inherited from GeneratorScene.creationStack

experimentalFeatures ​ 

                            
                              
                                readonly 
                                experimentalFeatures
                                : 
                                boolean
Inherited from GeneratorScene.experimentalFeatures

lifecycleEvents ​ 

                            
                              
                                readonly 
                                lifecycleEvents
                                : 
                                LifecycleEvents
Inherited from GeneratorScene.lifecycleEvents

logger ​ 

                            
                              
                                readonly 
                                logger
                                : 
                                Logger
Inherited from GeneratorScene.logger

meta ​ 

                            
                              
                                readonly 
                                meta
                                : 
                                ObjectMetaField
                                
                                  
                                    
                                      
                                        
                                          
                                            seed
                                            : 
                                            MetaField
                                            
                                              
                                                
                                                  any
                                                
                                                
                                                  number
                                                
                                              
                                            
                                          
                                          
                                            timeEvents
                                            : 
                                            MetaField
                                            
                                              
                                                
                                                  SerializedTimeEvent
                                                  []
                                                
                                                
                                                  SerializedTimeEvent
                                                  []
                                                
                                              
                                            
                                          
                                          
                                            version
                                            : 
                                            MetaField
                                            
                                              
                                                
                                                  any
                                                
                                                
                                                  number
Inherited from GeneratorScene.meta

name ​ 

                            
                              
                                readonly 
                                name
                                : 
                                string
Inherited from GeneratorScene.name

playback ​ 

                            
                              
                                readonly 
                                playback
                                : 
                                PlaybackStatus
Inherited from GeneratorScene.playback

previousOnTop ​ 

                            
                              
                                previousOnTop
                                : 
                                SignalValue
                                
                                  
                                    
                                      boolean
Inherited from GeneratorScene.previousOnTop

random ​ 

                            
                              
                                random
                                : 
                                Random
Inherited from GeneratorScene.random

shaders ​ 

                            
                              
                                readonly 
                                shaders
                                : 
                                Shaders
Inherited from GeneratorScene.shaders

slides ​ 

                            
                              
                                readonly 
                                slides
                                : 
                                Slides
Inherited from GeneratorScene.slides

timeEvents ​ 

                            
                              
                                readonly 
                                timeEvents
                                : 
                                TimeEvents
Inherited from GeneratorScene.timeEvents

variables ​ 

                            
                              
                                readonly 
                                variables
                                : 
                                Variables
Inherited from GeneratorScene.variables

Accessors ​

LifecycleEvents ​ 

                            
                              
                                public 
                                get 
                                LifecycleEvents
                                (): 
                                LifecycleEvents
Inherited from GeneratorScene.LifecycleEvents

firstFrame ​ 

                            
                              
                                public 
                                get 
                                firstFrame
                                (): 
                                number
Inherited from GeneratorScene.firstFrame

lastFrame ​ 

                            
                              
                                public 
                                get 
                                lastFrame
                                (): 
                                number
Inherited from GeneratorScene.lastFrame

onCacheChanged ​ 

                            
                              
                                public 
                                get 
                                onCacheChanged
                                (): 
                                SubscribableValueEvent
                                
                                  
                                    
                                      CachedSceneData
Inherited from GeneratorScene.onCacheChanged

onRecalculated ​ 

                            
                              
                                public 
                                get 
                                onRecalculated
                                (): 
                                Subscribable
                                
                                  
                                    
                                      void
                                    
                                    
                                      EventHandler
                                      
                                        
                                          
                                            void
Inherited from GeneratorScene.onRecalculated

onReloaded ​ 

                            
                              
                                public 
                                get 
                                onReloaded
                                (): 
                                Subscribable
                                
                                  
                                    
                                      void
                                    
                                    
                                      EventHandler
                                      
                                        
                                          
                                            void
Inherited from GeneratorScene.onReloaded

onRenderLifecycle ​ 

                            
                              
                                public 
                                get 
                                onRenderLifecycle
                                (): 
                                Subscribable
                                
                                  
                                    
                                      
                                        
                                          
                                            SceneRenderEvent
                                          
                                          
                                            CanvasRenderingContext2D
                                          
                                        
                                      
                                    
                                    
                                      EventHandler
                                      
                                        
                                          
                                            
                                              
                                                
                                                  SceneRenderEvent
                                                
                                                
                                                  CanvasRenderingContext2D
Inherited from GeneratorScene.onRenderLifecycle

onReset ​ 

                            
                              
                                public 
                                get 
                                onReset
                                (): 
                                Subscribable
                                
                                  
                                    
                                      void
                                    
                                    
                                      EventHandler
                                      
                                        
                                          
                                            void
Inherited from GeneratorScene.onReset

onThreadChanged ​ 

                            
                              
                                public 
                                get 
                                onThreadChanged
                                (): 
                                SubscribableValueEvent
                                
                                  
                                    
                                      
                                        
                                          
                                            null
                                          
                                          
                                            Thread
Inherited from GeneratorScene.onThreadChanged

previous ​ 

                            
                              
                                public 
                                get 
                                previous
                                (): 
                                
                                  
                                    
                                      null
                                    
                                    
                                      Scene
                                      
                                        
                                          
                                            unknown
Inherited from GeneratorScene.previous

Methods ​

canTransitionOut ​ 

                            
                              
                                public 
                                canTransitionOut
                                (): 
                                boolean
Inherited from GeneratorScene.canTransitionOut

draw ​ 

                            
                              
                                public 
                                override
                                draw
                                
                                  
                                    
                                      context
                                      : 
                                      CanvasRenderingContext2D
                                    
                                  
                                
                                : 
                                void

Parameters

Overwrites GeneratorScene.draw

drawOverlay ​ 

                            
                              
                                public 
                                drawOverlay
                                
                                  
                                    
                                      element
                                      : 
                                      unknown
                                    
                                    
                                      matrix
                                      : 
                                      DOMMatrix
                                    
                                    
                                      context
                                      : 
                                      CanvasRenderingContext2D
                                    
                                  
                                
                                : 
                                void

Parameters

enterAfterTransitionIn ​ 

                            
                              
                                public 
                                enterAfterTransitionIn
                                (): 
                                void
Inherited from GeneratorScene.enterAfterTransitionIn

enterCanTransitionOut ​ 

                            
                              
                                public 
                                enterCanTransitionOut
                                (): 
                                void
Inherited from GeneratorScene.enterCanTransitionOut

enterInitial ​ 

                            
                              
                                public 
                                enterInitial
                                (): 
                                void
Inherited from GeneratorScene.enterInitial

getDetachedNodes ​ 

                            
                              
                                public 
                                getDetachedNodes
                                (): 
                                Generator
                                
                                  
                                    
                                      Node
                                    
                                    
                                      void
                                    
                                    
                                      unknown

getNode ​ 

                            
                              
                                public 
                                getNode
                                
                                  
                                    
                                      key
                                      : 
                                      any
                                    
                                  
                                
                                : 
                                
                                  
                                    
                                      null
                                    
                                    
                                      Node

Parameters

getRealSize ​ 

                            
                              
                                public 
                                getRealSize
                                (): 
                                Vector2
Inherited from GeneratorScene.getRealSize

getSize ​ 

                            
                              
                                public 
                                getSize
                                (): 
                                Vector2
Inherited from GeneratorScene.getSize

getView ​ 

                            
                              
                                public 
                                override
                                getView
                                (): 
                                View2D
Overwrites GeneratorScene.getView

inspectAttributes ​ 

                            
                              
                                public 
                                inspectAttributes
                                
                                  
                                    
                                      element
                                      : 
                                      unknown
                                    
                                  
                                
                                : 
                                
                                  
                                    
                                      null
                                    
                                    
                                      InspectedAttributes

Parameters

inspectPosition ​ 

                            
                              
                                public 
                                inspectPosition
                                
                                  
                                    
                                      x
                                      : 
                                      number
                                    
                                    
                                      y
                                      : 
                                      number
                                    
                                  
                                
                                : 
                                unknown

Parameters

  • x : number
  • y : number

isAfterTransitionIn ​ 

                            
                              
                                public 
                                isAfterTransitionIn
                                (): 
                                boolean
Inherited from GeneratorScene.isAfterTransitionIn

isCached ​ 

                            
                              
                                public 
                                isCached
                                (): 
                                boolean
Inherited from GeneratorScene.isCached

isFinished ​ 

                            
                              
                                public 
                                isFinished
                                (): 
                                boolean
Inherited from GeneratorScene.isFinished

next ​ 

                            
                              
                                public 
                                override
                                next
                                (): 
                                Promise
                                
                                  
                                    
                                      void
Overwrites GeneratorScene.next

recalculate ​ 

                            
                              
                                public 
                                recalculate
                                
                                  
                                    
                                      setFrame
                                      : 
                                      
                                        
                                          
                                            frame
                                            : 
                                            number
                                          
                                        
                                      
                                       => 
                                      void
                                    
                                  
                                
                                : 
                                Promise
                                
                                  
                                    
                                      void

Parameters

Inherited from GeneratorScene.recalculate

registerNode ​ 

                            
                              
                                public 
                                registerNode
                                
                                  
                                    
                                      node
                                      : 
                                      Node
                                    
                                    
                                      key
                                      ?: 
                                      string
                                    
                                  
                                
                                : 
                                
                                  
                                    
                                      string
                                    
                                    
                                      () => 
                                      void

Parameters

reload ​ 

                            
                              
                                public 
                                reload
                                
                                  
                                    
                                      {...}
                                      ?: 
                                      SceneDescriptionReload
                                      
                                        
                                          
                                            ThreadGeneratorFactory
                                            
                                              
                                                
                                                  View2D
                                                
                                              
                                            
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                void

Parameters

  • {...} ?: SceneDescriptionReload ThreadGeneratorFactory View2D
Inherited from GeneratorScene.reload

render ​ 

                            
                              
                                public 
                                render
                                
                                  
                                    
                                      context
                                      : 
                                      CanvasRenderingContext2D
                                    
                                  
                                
                                : 
                                Promise
                                
                                  
                                    
                                      void

Parameters

Inherited from GeneratorScene.render

reset ​ 

                            
                              
                                public 
                                override
                                reset
                                
                                  
                                    
                                      previousScene
                                      ?: 
                                      Scene
                                      
                                        
                                          
                                            unknown
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                Promise
                                
                                  
                                    
                                      void

Parameters

Overwrites GeneratorScene.reset

transformMousePosition ​ 

                            
                              
                                public 
                                transformMousePosition
                                
                                  
                                    
                                      x
                                      : 
                                      number
                                    
                                    
                                      y
                                      : 
                                      number
                                    
                                  
                                
                                : 
                                
                                  
                                    
                                      null
                                    
                                    
                                      Vector2

Parameters

  • x : number
  • y : number

update ​ 

                            
                              
                                public 
                                update
                                (): 
                                void

Update the view.

Invoked after each step of the main generator.Can be used for calculating layout.

Can modify the state of the view.

Inherited from GeneratorScene.update

validateInspection ​ 

                            
                              
                                public 
                                validateInspection
                                
                                  
                                    
                                      element
                                      : 
                                      unknown
                                    
                                  
                                
                                : 
                                unknown

Parameters