Skip to main content

types

                            
                              
                                import
                                
                                {
                                ...
                                }
                                
                                from
                                
                                "@motion-canvas/core/lib/types"
                                ;

Complex types used in animations.

Enumerations ​

  • Center
  • Direction
  • Origin

Classes ​

  • BBox
  • Matrix2D
  • Spacing
  • Vector2

Interfaces ​

  • Color
  • Type

Type Aliases ​

CanvasColorSpace ​ 

                            
                              
                                type 
                                CanvasColorSpace
                                 = 
                                
                                  
                                    
                                      'srgb'
                                    
                                    
                                      'display-p3'

CanvasOutputMimeType ​ 

                            
                              
                                type 
                                CanvasOutputMimeType
                                 = 
                                
                                  
                                    
                                      'image/png'
                                    
                                    
                                      'image/jpeg'
                                    
                                    
                                      'image/webp'

ColorSignal ​ 

                            
                              
                                type 
                                ColorSignal
                                
                                  
                                    
                                      T
                                    
                                  
                                
                                 = 
                                Signal
                                
                                  
                                    
                                      PossibleColor
                                    
                                    
                                      Color
                                    
                                    
                                      T

Type Parameters

PossibleBBox ​ 

                            
                              
                                type 
                                PossibleBBox
                                 = 
                                
                                  
                                    
                                      SerializedBBox
                                    
                                    
                                      
                                        
                                          
                                            number
                                          
                                          
                                            number
                                          
                                          
                                            number
                                          
                                          
                                            number
                                          
                                        
                                      
                                    
                                    
                                      Vector2
                                    
                                    
                                      undefined

PossibleColor ​ 

                            
                              
                                type 
                                PossibleColor
                                 = 
                                
                                  
                                    
                                      SerializedColor
                                    
                                    
                                      number
                                    
                                    
                                      Color
                                    
                                    
                                      
                                        
                                          
                                            a
                                            : 
                                            number
                                          
                                          
                                            b
                                            : 
                                            number
                                          
                                          
                                            g
                                            : 
                                            number
                                          
                                          
                                            r
                                            : 
                                            number

PossibleMatrix2D ​ 

                            
                              
                                type 
                                PossibleMatrix2D
                                 = 
                                
                                  
                                    
                                      Matrix2D
                                    
                                    
                                      
                                        
                                          
                                            number
                                          
                                          
                                            number
                                          
                                          
                                            number
                                          
                                          
                                            number
                                          
                                          
                                            number
                                          
                                          
                                            number
                                          
                                        
                                      
                                    
                                    
                                      
                                        
                                          
                                            PossibleVector2
                                          
                                          
                                            PossibleVector2
                                          
                                          
                                            PossibleVector2
                                          
                                        
                                      
                                    
                                    
                                      undefined

PossibleSpacing ​ 

                            
                              
                                type 
                                PossibleSpacing
                                 = 
                                
                                  
                                    
                                      SerializedSpacing
                                    
                                    
                                      number
                                    
                                    
                                      
                                        
                                          
                                            number
                                          
                                          
                                            number
                                          
                                        
                                      
                                    
                                    
                                      
                                        
                                          
                                            number
                                          
                                          
                                            number
                                          
                                          
                                            number
                                          
                                        
                                      
                                    
                                    
                                      
                                        
                                          
                                            number
                                          
                                          
                                            number
                                          
                                          
                                            number
                                          
                                          
                                            number
                                          
                                        
                                      
                                    
                                    
                                      undefined

PossibleVector2 ​ 

                            
                              
                                type 
                                PossibleVector2
                                
                                  
                                    
                                      T
                                       = 
                                      number
                                    
                                  
                                
                                 = 
                                
                                  
                                    
                                      SerializedVector2
                                      
                                        
                                          
                                            T
                                          
                                        
                                      
                                    
                                    
                                      
                                        
                                          
                                            height
                                            : 
                                            T
                                          
                                          
                                            width
                                            : 
                                            T
                                          
                                        
                                      
                                    
                                    
                                      T
                                    
                                    
                                      
                                        
                                          
                                            T
                                          
                                          
                                            T
                                          
                                        
                                      
                                    
                                    
                                      undefined

Type Parameters

  • T = number

RectSignal ​ 

                            
                              
                                type 
                                RectSignal
                                
                                  
                                    
                                      T
                                    
                                  
                                
                                 = 
                                CompoundSignal
                                
                                  
                                    
                                      PossibleBBox
                                    
                                    
                                      BBox
                                    
                                    
                                      
                                        
                                          
                                            'x'
                                          
                                          
                                            'y'
                                          
                                          
                                            'width'
                                          
                                          
                                            'height'
                                          
                                        
                                      
                                    
                                    
                                      T

Type Parameters

SerializedBBox ​ 

                            
                              
                                type 
                                SerializedBBox
                                 = 
                                
                                  
                                    
                                      height
                                      : 
                                      number
                                    
                                    
                                      width
                                      : 
                                      number
                                    
                                    
                                      x
                                      : 
                                      number
                                    
                                    
                                      y
                                      : 
                                      number

SerializedColor ​ 

                            
                              
                                type 
                                SerializedColor
                                 = 
                                string

SerializedSpacing ​ 

                            
                              
                                type 
                                SerializedSpacing
                                 = 
                                
                                  
                                    
                                      bottom
                                      : 
                                      number
                                    
                                    
                                      left
                                      : 
                                      number
                                    
                                    
                                      right
                                      : 
                                      number
                                    
                                    
                                      top
                                      : 
                                      number

SerializedVector2 ​ 

                            
                              
                                type 
                                SerializedVector2
                                
                                  
                                    
                                      T
                                       = 
                                      number
                                    
                                  
                                
                                 = 
                                
                                  
                                    
                                      x
                                      : 
                                      T
                                    
                                    
                                      y
                                      : 
                                      T

Type Parameters

  • T = number

SimpleVector2Signal ​ 

                            
                              
                                type 
                                SimpleVector2Signal
                                
                                  
                                    
                                      T
                                    
                                  
                                
                                 = 
                                Signal
                                
                                  
                                    
                                      PossibleVector2
                                    
                                    
                                      Vector2
                                    
                                    
                                      T

Type Parameters

SpacingSignal ​ 

                            
                              
                                type 
                                SpacingSignal
                                
                                  
                                    
                                      T
                                    
                                  
                                
                                 = 
                                CompoundSignal
                                
                                  
                                    
                                      PossibleSpacing
                                    
                                    
                                      Spacing
                                    
                                    
                                      
                                        
                                          
                                            'top'
                                          
                                          
                                            'right'
                                          
                                          
                                            'bottom'
                                          
                                          
                                            'left'
                                          
                                        
                                      
                                    
                                    
                                      T

Type Parameters

Vector2Signal ​ 

                            
                              
                                type 
                                Vector2Signal
                                
                                  
                                    
                                      T
                                    
                                  
                                
                                 = 
                                CompoundSignal
                                
                                  
                                    
                                      PossibleVector2
                                    
                                    
                                      Vector2
                                    
                                    
                                      
                                        
                                          
                                            'x'
                                          
                                          
                                            'y'
                                          
                                        
                                      
                                    
                                    
                                      T

Type Parameters

Variables ​

EPSILON ​ 

                            
                              
                                const 
                                EPSILON
                                : 
                                0.000001
                                 = 
                                0.000001

Functions ​

flipOrigin ​ 

                            
                              
                                public 
                                flipOrigin
                                
                                  
                                    
                                      origin
                                      : 
                                      Direction
                                    
                                    
                                      axis
                                      ?: 
                                      Center
                                    
                                  
                                
                                : 
                                Direction
                              
                              

                            
                          
                            
                              
                                public 
                                flipOrigin
                                
                                  
                                    
                                      origin
                                      : 
                                      Origin
                                    
                                    
                                      axis
                                      ?: 
                                      Center
                                    
                                  
                                
                                : 
                                Origin

Parameters

isType ​ 

                            
                              
                                public 
                                isType
                                
                                  
                                    
                                      value
                                      : 
                                      any
                                    
                                  
                                
                                : 
                                value 
                                is 
                                Type

Parameters

originToOffset ​ 

                            
                              
                                public 
                                originToOffset
                                
                                  
                                    
                                      origin
                                      : 
                                      
                                        
                                          
                                            Direction
                                          
                                          
                                            Origin
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                Vector2

Convert the given origin to a vector representing its offset.

Examples

Parameters

  • origin : Direction Origin

    The origin to convert.

transformAngle ​ 

                            
                              
                                public 
                                transformAngle
                                
                                  
                                    
                                      angle
                                      : 
                                      number
                                    
                                    
                                      matrix
                                      : 
                                      DOMMatrix
                                    
                                  
                                
                                : 
                                number

Parameters

transformScalar ​ 

                            
                              
                                public 
                                transformScalar
                                
                                  
                                    
                                      scalar
                                      : 
                                      number
                                    
                                    
                                      matrix
                                      : 
                                      DOMMatrix
                                    
                                  
                                
                                : 
                                number

Parameters