Skip to main content

Vector2

                            
                              
                                class 
                                Vector2
                                implements 
                                
                                  
                                    
                                      Type
                                    
                                  
                                
                              
                              

Represents a two-dimensional vector.

Constructors

constructor

                            
                              
                                public 
                                new
                                Vector2
                                (): 
                                Vector2
                              
                              
                            
                              
                                public 
                                new
                                Vector2
                                
                                  
                                    
                                      from
                                      : 
                                      PossibleVector2
                                      
                                        
                                          
                                            number
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                Vector2
                              
                              
                            
                              
                                public 
                                new
                                Vector2
                                
                                  
                                    
                                      x
                                      : 
                                      number
                                    
                                    
                                      y
                                      : 
                                      number
                                    
                                  
                                
                                : 
                                Vector2
                              
                              

Properties

x

                            
                              
                                public 
                                x
                                : 
                                number
                                 = 
                                0
                              
                              

y

                            
                              
                                public 
                                y
                                : 
                                number
                                 = 
                                0
                              
                              

down

                            
                              
                                static 
                                readonly 
                                public 
                                down
                                : 
                                Vector2
                                 = 
                                ...
                              
                              

left

                            
                              
                                static 
                                readonly 
                                public 
                                left
                                : 
                                Vector2
                                 = 
                                ...
                              
                              

one

                            
                              
                                static 
                                readonly 
                                public 
                                one
                                : 
                                Vector2
                                 = 
                                ...
                              
                              

right

                            
                              
                                static 
                                readonly 
                                public 
                                right
                                : 
                                Vector2
                                 = 
                                ...
                              
                              

symbol

                            
                              
                                static 
                                readonly 
                                public 
                                symbol
                                : 
                                typeof 
                                symbol
                                 = 
                                ...
                              
                              

up

                            
                              
                                static 
                                readonly 
                                public 
                                up
                                : 
                                Vector2
                                 = 
                                ...
                              
                              

zero

                            
                              
                                static 
                                readonly 
                                public 
                                zero
                                : 
                                Vector2
                                 = 
                                ...
                              
                              

Accessors

ctg

                            
                              
                                public 
                                get 
                                ctg
                                (): 
                                number
                              
                              

flipped

                            
                              
                                public 
                                get 
                                flipped
                                (): 
                                Vector2
                              
                              

floored

                            
                              
                                public 
                                get 
                                floored
                                (): 
                                Vector2
                              
                              

height

                            
                              
                                public 
                                set 
                                height
                                
                                  
                                    
                                      value
                                      : 
                                      number
                                    
                                  
                                
                                : 
                                void
                              
                              
                            
                              
                                public 
                                get 
                                height
                                (): 
                                number
                              
                              

Parameters


magnitude

                            
                              
                                public 
                                get 
                                magnitude
                                (): 
                                number
                              
                              

normalized

                            
                              
                                public 
                                get 
                                normalized
                                (): 
                                Vector2
                              
                              

perpendicular

                            
                              
                                public 
                                get 
                                perpendicular
                                (): 
                                Vector2
                              
                              

radians

                            
                              
                                public 
                                get 
                                radians
                                (): 
                                number
                              
                              

safe

                            
                              
                                public 
                                get 
                                safe
                                (): 
                                Vector2
                              
                              

width

                            
                              
                                public 
                                set 
                                width
                                
                                  
                                    
                                      value
                                      : 
                                      number
                                    
                                  
                                
                                : 
                                void
                              
                              
                            
                              
                                public 
                                get 
                                width
                                (): 
                                number
                              
                              

Parameters

Methods

add

                            
                              
                                public 
                                add
                                
                                  
                                    
                                      possibleVector
                                      : 
                                      PossibleVector2
                                      
                                        
                                          
                                            number
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                Vector2
                              
                              

Parameters


addX

                            
                              
                                public 
                                addX
                                
                                  
                                    
                                      value
                                      : 
                                      number
                                    
                                  
                                
                                : 
                                Vector2
                              
                              

Parameters


addY

                            
                              
                                public 
                                addY
                                
                                  
                                    
                                      value
                                      : 
                                      number
                                    
                                  
                                
                                : 
                                Vector2
                              
                              

Parameters


div

                            
                              
                                public 
                                div
                                
                                  
                                    
                                      possibleVector
                                      : 
                                      PossibleVector2
                                      
                                        
                                          
                                            number
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                Vector2
                              
                              

Parameters


dot

                            
                              
                                public 
                                dot
                                
                                  
                                    
                                      possibleVector
                                      : 
                                      PossibleVector2
                                      
                                        
                                          
                                            number
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                number
                              
                              

Parameters


exactlyEquals

                            
                              
                                public 
                                exactlyEquals
                                
                                  
                                    
                                      other
                                      : 
                                      Vector2
                                    
                                  
                                
                                : 
                                boolean
                              
                              

Parameters


getOriginOffset

                            
                              
                                public 
                                getOriginOffset
                                
                                  
                                    
                                      origin
                                      : 
                                      
                                        
                                          
                                            Direction
                                          
                                          
                                            Origin
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                Vector2
                              
                              

Parameters


lerp

                            
                              
                                public 
                                lerp
                                
                                  
                                    
                                      to
                                      : 
                                      Vector2
                                    
                                    
                                      value
                                      : 
                                      
                                        
                                          
                                            number
                                          
                                          
                                            Vector2
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                Vector2
                              
                              

Parameters

  • to : Vector2
  • value : number Vector2

mul

                            
                              
                                public 
                                mul
                                
                                  
                                    
                                      possibleVector
                                      : 
                                      PossibleVector2
                                      
                                        
                                          
                                            number
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                Vector2
                              
                              

Parameters


scale

                            
                              
                                public 
                                scale
                                
                                  
                                    
                                      value
                                      : 
                                      number
                                    
                                  
                                
                                : 
                                Vector2
                              
                              

Parameters


serialize

                            
                              
                                public 
                                serialize
                                (): 
                                SerializedVector2
                                
                                  
                                    
                                      number
                                    
                                  
                                
                              
                              

sub

                            
                              
                                public 
                                sub
                                
                                  
                                    
                                      possibleVector
                                      : 
                                      PossibleVector2
                                      
                                        
                                          
                                            number
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                Vector2
                              
                              

Parameters


toSymbol

                            
                              
                                public 
                                toSymbol
                                (): 
                                symbol
                              
                              

transform

                            
                              
                                public 
                                transform
                                
                                  
                                    
                                      matrix
                                      : 
                                      DOMMatrix
                                    
                                  
                                
                                : 
                                Vector2
                              
                              

Parameters


transformAsPoint

                            
                              
                                public 
                                transformAsPoint
                                
                                  
                                    
                                      matrix
                                      : 
                                      DOMMatrix
                                    
                                  
                                
                                : 
                                Vector2
                              
                              

Parameters


arcLerp

                            
                              
                                static 
                                public 
                                arcLerp
                                
                                  
                                    
                                      from
                                      : 
                                      Vector2
                                    
                                    
                                      to
                                      : 
                                      Vector2
                                    
                                    
                                      value
                                      : 
                                      number
                                    
                                    
                                      reverse
                                      : 
                                      boolean
                                       = 
                                      false
                                    
                                    
                                      ratio
                                      ?: 
                                      number
                                    
                                  
                                
                                : 
                                Vector2
                              
                              

Parameters


createSignal

                            
                              
                                static 
                                public 
                                createSignal
                                
                                  
                                    
                                      initial
                                      ?: 
                                      SignalValue
                                      
                                        
                                          
                                            PossibleVector2
                                            
                                              
                                                
                                                  number
                                                
                                              
                                            
                                          
                                        
                                      
                                    
                                    
                                      interpolation
                                      : 
                                      InterpolationFunction
                                      
                                        
                                          
                                            Vector2
                                          
                                          
                                            any
                                            []
                                          
                                        
                                      
                                       = 
                                      Vector2.lerp
                                    
                                    
                                      owner
                                      ?: 
                                      any
                                    
                                  
                                
                                : 
                                Vector2Signal
                                
                                  
                                    
                                      void
                                    
                                  
                                
                              
                              

Parameters


fromOrigin

                            
                              
                                static 
                                public 
                                fromOrigin
                                
                                  
                                    
                                      origin
                                      : 
                                      
                                        
                                          
                                            Direction
                                          
                                          
                                            Origin
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                Vector2
                              
                              

Parameters


fromRadians

                            
                              
                                static 
                                public 
                                fromRadians
                                
                                  
                                    
                                      radians
                                      : 
                                      number
                                    
                                  
                                
                                : 
                                Vector2
                              
                              

Parameters


fromScalar

                            
                              
                                static 
                                public 
                                fromScalar
                                
                                  
                                    
                                      value
                                      : 
                                      number
                                    
                                  
                                
                                : 
                                Vector2
                              
                              

Parameters


lerp

                            
                              
                                static 
                                public 
                                lerp
                                
                                  
                                    
                                      from
                                      : 
                                      Vector2
                                    
                                    
                                      to
                                      : 
                                      Vector2
                                    
                                    
                                      value
                                      : 
                                      
                                        
                                          
                                            number
                                          
                                          
                                            Vector2
                                          
                                        
                                      
                                    
                                  
                                
                                : 
                                Vector2
                              
                              

Parameters


magnitude

                            
                              
                                static 
                                public 
                                magnitude
                                
                                  
                                    
                                      x
                                      : 
                                      number
                                    
                                    
                                      y
                                      : 
                                      number
                                    
                                  
                                
                                : 
                                number
                              
                              

Parameters

  • x : number
  • y : number