Class: Geom::Vector2d

Inherits:

Object

• Object
• Geom::Vector2d

Defined in:

lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb

Overview

The Vector2d class represents vectors in a 2 dimensional space.

There are numerous tutorials on 2D vectors available on the internet.

Version:

• LayOut 2018

Instance Method Summary

• #%(vector) ⇒ Object

  The #% method returns the dot product between two Vector2d.

• #*(vector) ⇒ Geom::Vector2d

  The #* method returns the cross product between two Vector2d.

• #+(vector) ⇒ Geom::Vector2d

  The #+ method adds a Vector2d to this one.

• #-(vector) ⇒ Geom::Vector2d

  The #- method subtracts a Vector2d from this one.

• #==(vector) ⇒ Boolean

  The #== method returns whether two Vector2d are equal within tolerance.

• #[](index) ⇒ Numeric

  The #[] method returns the value of the Vector2d at the specified index.

• #[]=(index, value) ⇒ Numeric

  The #[]= method sets the x or y value of the Vector2d based on the specific index of the value.

• #angle_between(vector) ⇒ Numeric

  The #angle_between method computes the angle in radians between the Vector2d and another Vector2d.

• #clone ⇒ Geom::Vector2d

  The #clone method makes a copy of the Vector2d.

• #cross(vector) ⇒ Geom::Vector2d

  The #* method returns the cross product between two Vector2d.

• #dot(vector) ⇒ Object

  The #% method returns the dot product between two Vector2d.

• #initialize(*args) ⇒ Vector2d constructor

  The new method creates a new Vector2d.

• #inspect ⇒ String

  The #inspect method formats the Vector2d as a string.

• #length ⇒ Length

  The #length method returns the length of the Vector2d.

• #length=(length) ⇒ Numeric

  The #length= method sets the length of the Vector2d.

• #normalize ⇒ Geom::Vector2d

  The #normalize method returns a Vector2d that is a unit vector of the Vector2d.

• #normalize! ⇒ Object

  The #normalize! method converts a Vector2d vector into a unit vector.

• #parallel?(vector) ⇒ Boolean

  The #parallel? method determines if the Vector2d is parallel to another Vector2d to within tolerance.

• #perpendicular?(vector) ⇒ Boolean

  The #perpendicular? method determines if the Vector2d is perpendicular to another Vector2d to within tolerance.

• #reverse ⇒ Geom::Vector2d

  The #reverse method returns a new Vector2d that is the reverse of the Vector2d, leaving the original unchanged.

• #reverse! ⇒ Object

  The #reverse! method reverses the Vector2d in place.

• #same_direction?(vector) ⇒ Boolean

  The #same_direction? method determines if the Vector2d is parallel to and in the same direction as another Vector2d within tolerance.

• #set!(*args) ⇒ Object

  The #set! method sets the values of the Vector2d.

• #to_a ⇒ Array(Numeric, Numeric)

  The #to_a method retrieves the coordinates of the Vector2d in an Array.

• #to_s ⇒ String

  The #to_s method returns a string representation of the Vector2d.

• #transform(transform) ⇒ Geom::Vector2d

  The #transform method applies a transformation to a vector, returning a new vector.

• #transform!(transform) ⇒ Geom::Vector2d

  The #transform! method applies a transformation to a vector.

• #unit_vector? ⇒ Boolean

  The #unit_vector? method returns whether the Vector2d is a unit vector.

• #valid? ⇒ Boolean

  The #valid? method verifies if a Vector2d is valid.

• #x ⇒ Numeric

  The #x method retrieves the x value of the Vector2d.

• #x=(x) ⇒ Numeric

  The #x= method sets the x coordinate of the Vector2d.

• #y ⇒ Numeric

  The #y method retrieves the y value of the Vector2d.

• #y=(y) ⇒ Numeric

  The #y= method sets the y coordinate of the Vector2d.

Constructor Details

#initialize ⇒ Geom::Vector2d #initialize(x, y) ⇒ Geom::Vector2d #initialize(vector) ⇒ Geom::Vector2d

The new method creates a new Geom::Vector2d.

Examples:

# A vector that runs along the X axis.
vector = Geom::Vector2d.new(1, 0)

Overloads:

• #initialize ⇒ Geom::Vector2d
• #initialize(x, y) ⇒ Geom::Vector2d

  Parameters:

  • x (Numeric) —

    The length in the x direction

  • y (Numeric) —

    The length in the y direction

• #initialize(vector) ⇒ Geom::Vector2d

  Parameters:

  • vector (Geom::Vector2d, Array(Numeric, Numeric))

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 213

def initialize(*args)
end

Instance Method Details

#%(vector) ⇒ Object

The #% method returns the dot product between two Geom::Vector2d. This is an alias of the dot method.

Examples:

vector = Geom::Vector2d.new(0, 2)
vector2 = Geom::Vector2d.new(1, 0)
d2 = vector % vector2

Parameters:

• vector (Geom::Vector2d)

Returns:

• The dot product of the vectors

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 26

def %(vector)
end

#*(vector) ⇒ Geom::Vector2d

The #* method returns the cross product between two Geom::Vector2d. This is an alias of the cross method.

Examples:

vector = Geom::Vector2d.new(1, 0)
vector2 = Geom::Vector2d.new(0, 1)
cross = vector * vector

Parameters:

• vector (Geom::Vector2d)

Returns:

• (Geom::Vector2d)

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 42

def *(vector)
end

#+(vector) ⇒ Geom::Vector2d

The #+ method adds a Geom::Vector2d to this one.

Examples:

vector = Geom::Vector2d.new(0, 2)
vector2 = Geom::Vector2d.new(1, 0)
new_vector = vector + vector2

Parameters:

• vector (Geom::Vector2d)

Returns:

• (Geom::Vector2d)

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 57

def +(vector)
end

#-(vector) ⇒ Geom::Vector2d

The #- method subtracts a Geom::Vector2d from this one.

Examples:

vector = Geom::Vector2d.new(0, 2)
vector2 = Geom::Vector2d.new(1, 0)
new_vector = vector - vector2

Parameters:

• vector (Geom::Vector2d)

Returns:

• (Geom::Vector2d)

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 72

def -(vector)
end

#==(vector) ⇒ Boolean

The #== method returns whether two Geom::Vector2d are equal within tolerance.

Examples:

vector = Geom::Vector2d.new(1, 0)
vector2 = Geom::Vector2d.new(0,1)
# Returns false
status = vector == vector2

Parameters:

• vector (Geom::Vector2d)

Returns:

• (Boolean)

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 89

def ==(vector)
end

#[](index) ⇒ Numeric

The #[] method returns the value of the Geom::Vector2d at the specified index.

Examples:

vector = Geom::Vector2d.new(1, 2)
# retrieves the y value of 2
yvalue = vector[1]

Parameters:

• index (Integer) —

  The index into an array of two coordinates.

Returns:

• (Numeric) —

  The value for the x or y coordinate.

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 106

def [](index)
end

#[]=(index, value) ⇒ Numeric

The #[]= method sets the x or y value of the Geom::Vector2d based on the specific index of the value.

Examples:

point = Geom::Vector2d.new(1,2)
point[1] = 4

Parameters:

• index (Numeric) —

  The index for a specific x or y value in the Geom::Vector2d to set

• value (Numeric) —

  The value to set for x or y

Returns:

• (Numeric) —

  The new x or y value if successful

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 126

def []=(index, value)
end

#angle_between(vector) ⇒ Numeric

The #angle_between method computes the angle in radians between the Geom::Vector2d and another Geom::Vector2d.

Examples:

vector = Geom::Vector2d.new(1, 0)
vector2 = Geom::Vector2d.new(-1, 0)
# returns PI
angle = vector.angle_between(vector2)

Parameters:

• vector (Geom::Vector2d)

Returns:

• (Numeric) —

  The angle (in radians)

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 143

def angle_between(vector)
end

#clone ⇒ Geom::Vector2d

The #clone method makes a copy of the Geom::Vector2d. This method is equivalent to vec2 = Geom::Vector2d.new(vec).

Examples:

vector = Geom::Vector2d.new(1, 0)
vector2 = vector.clone

Returns:

• (Geom::Vector2d)

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 156

def clone
end

#cross(vector) ⇒ Geom::Vector2d

The #* method returns the cross product between two Geom::Vector2d. This is an alias of the cross method.

Examples:

vector = Geom::Vector2d.new(1, 0)
vector2 = Geom::Vector2d.new(0, 1)
cross = vector * vector

Parameters:

• vector (Geom::Vector2d)

Returns:

• (Geom::Vector2d)

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 172

def cross(vector)
end

#dot(vector) ⇒ Object

The #% method returns the dot product between two Geom::Vector2d. This is an alias of the dot method.

Examples:

vector = Geom::Vector2d.new(0, 2)
vector2 = Geom::Vector2d.new(1, 0)
d2 = vector % vector2

Parameters:

• vector (Geom::Vector2d)

Returns:

• The dot product of the vectors

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 188

def dot(vector)
end

#inspect ⇒ String

The #inspect method formats the Geom::Vector2d as a string.

Examples:

point = Geom::Point2d.new(1, 2)
string = point.inspect

Returns:

• (String) —

  the string representation of the Geom::Vector2d

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 225

def inspect
end

#length ⇒ Length

The #length method returns the length of the Geom::Vector2d.

Examples:

vector = Geom::Vector2d.new(0, 4)
# returns 4
l = vector.length

Returns:

• (Length) —

  The length of the Geom::Vector2d

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 238

def length
end

#length=(length) ⇒ Numeric

The #length= method sets the length of the Geom::Vector2d. The new length must not be 0.

Examples:

vector = Geom::Vector2d.new(0, 4)
l = vector.length
vector.length = 2

Parameters:

• length (Numeric) —

  The new length for the Geom::Vector2d

Returns:

• (Numeric) —

  The new length

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 255

def length=(length)
end

#normalize ⇒ Geom::Vector2d

The #normalize method returns a Geom::Vector2d that is a unit vector of the Geom::Vector2d.

Examples:

vector = Geom::Vector2d.new(0, 4)
# returns a new Vector2d(0, 1)
vector2 = vector.normalize

Returns:

• (Geom::Vector2d)

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 269

def normalize
end

#normalize! ⇒ Object

The #normalize! method converts a Geom::Vector2d vector into a unit vector. Another way to do this is vector.length = 1

Examples:

vector = Geom::Vector2d.new(0, 4)
# modifies vector to be the Vector2d(0, 1)
vector.normalize!

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 281

def normalize!
end

#parallel?(vector) ⇒ Boolean

The #parallel? method determines if the Geom::Vector2d is parallel to another Geom::Vector2d to within tolerance.

Examples:

vector = Geom::Vector2d.new(0, 1)
vector2 = Geom::Vector2d.new(1, 2)
# returns true
status = vector.parallel?(vector2)

Parameters:

• vector (Geom::Vector2d)

Returns:

• (Boolean)

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 298

def parallel?(vector)
end

#perpendicular?(vector) ⇒ Boolean

The #perpendicular? method determines if the Geom::Vector2d is perpendicular to another Geom::Vector2d to within tolerance.

Examples:

vector = Geom::Vector2d.new(0, 1)
vector2 = Geom::Vector2d.new(1, 2)
# returns false
status = vector.perpendicular?(vector2)

Parameters:

• vector (Geom::Vector2d)

Returns:

• (Boolean)

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 315

def perpendicular?(vector)
end

#reverse ⇒ Geom::Vector2d

The #reverse method returns a new Geom::Vector2d that is the reverse of the Geom::Vector2d, leaving the original unchanged.

Examples:

vector = Geom::Vector2d.new(1, 2)
# returns the Vector2d(-1, -2)
vector2 = vector.reverse

Returns:

• (Geom::Vector2d)

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 329

def reverse
end

#reverse! ⇒ Object

The #reverse! method reverses the Geom::Vector2d in place.

Examples:

vector = Geom::Vector2d.new(1, 2)
# modifies vector to be the Vector2d(-1, -2)
vector.reverse!

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 340

def reverse!
end

#same_direction?(vector) ⇒ Boolean

The #same_direction? method determines if the Geom::Vector2d is parallel to and in the same direction as another Geom::Vector2d within tolerance.

Examples:

vector = Geom::Vector2d.new(0, 1)
vector2 = Geom::Vector2d.new(1, 2)
# returns true
status = vector.sime_direction?(vector2)

Parameters:

• vector (Geom::Vector2d)

Returns:

• (Boolean)

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 357

def same_direction?(vector)
end

#set!(vector) ⇒ Geom::Vector2d #set!(x, y) ⇒ Geom::Vector2d

The #set! method sets the values of the Geom::Vector2d.

Examples:

vector = Geom::Vector2d.new(1, 2)
vector = vector.set!([4, 5])

Overloads:

• #set!(vector) ⇒ Geom::Vector2d

  Parameters:

  • vector (Geom::Vector2d, Array(Numeric, Numeric))

  Returns:

  • (Geom::Vector2d)
• #set!(x, y) ⇒ Geom::Vector2d

  Parameters:

  • x (Numeric)
  • y (Numeric)

  Returns:

  • (Geom::Vector2d)

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 378

def set!(*args)
end

#to_a ⇒ Array(Numeric, Numeric)

The #to_a method retrieves the coordinates of the Geom::Vector2d in an Array.

Examples:

a = vector.to_a

Returns:

• (Array(Numeric, Numeric))

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 390

def to_a
end

#to_s ⇒ String

The #to_s method returns a string representation of the Geom::Vector2d.

Examples:

point = Geom::Vector2d.new(1, 2)
str = point.to_s

Returns:

• (String) —

  the string representation of the Geom::Vector2d

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 402

def to_s
end

#transform(transform) ⇒ Geom::Vector2d

The #transform method applies a transformation to a vector, returning a new vector. The original vector is unchanged by this method.

Examples:

vector = Geom::Vector2d.new(4, 5)
transformation = Geom::Transformation2d.new([1, 0, 0, 1, 2, 3])
# vector2 will be (6, 8)
vector2 = vector.transform(transformation)

Parameters:

• transform (Geom::Transformation2d) —

  A transformation object to apply to the vector.

Returns:

• (Geom::Vector2d) —

  the newly transformed vector

Version:

• LayOut 2019

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 420

def transform(transform)
end

#transform!(transform) ⇒ Geom::Vector2d

The #transform! method applies a transformation to a vector. The vector itself is modified.

Examples:

vector = Geom::Vector2d.new(4, 5)
transformation = Geom::Transformation2d.new([1, 0, 0, 1, 2, 3])
# vector will be (6, 8)
vector.transform!(transformation)

Parameters:

• transform (Geom::Transformation2d) —

  A Transformation object to apply to the vector.

Returns:

• (Geom::Vector2d) —

  the transformed vector

Version:

• LayOut 2019

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 438

def transform!(transform)
end

#unit_vector? ⇒ Boolean

The #unit_vector? method returns whether the Geom::Vector2d is a unit vector. This is equivalent to vector.length == 1.0

Examples:

vector = Geom::Vector2d.new(1, 0)
# returns true
status = vector.unit_vector

Returns:

• (Boolean)

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 452

def unit_vector?
end

#valid? ⇒ Boolean

The #valid? method verifies if a Geom::Vector2d is valid. A Geom::Vector2d is valid if its length is not zero.

Examples:

vector = Geom::Vector2d.new(0, 4)
status = vector.valid

Returns:

• (Boolean)

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 465

def valid?
end

#x ⇒ Numeric

The #x method retrieves the x value of the Geom::Vector2d.

Examples:

vector = Geom::Vector2d.new(1, 2)
x = vector.x

Returns:

• (Numeric)

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 477

def x
end

#x=(x) ⇒ Numeric

The #x= method sets the x coordinate of the Geom::Vector2d.

Examples:

vector = Geom::Vector2d.new(1, 2)
vector.x = 7

Parameters:

• x (Numeric) —

  The desired x value of the Geom::Vector2d

Returns:

• (Numeric) —

  The new x value of the Geom::Vector2d

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 492

def x=(x)
end

#y ⇒ Numeric

The #y method retrieves the y value of the Geom::Vector2d.

Examples:

vector = Geom::Vector2d.new(1, 2)
y = vector.y

Returns:

• (Numeric)

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 504

def y
end

#y=(y) ⇒ Numeric

The #y= method sets the y coordinate of the Geom::Vector2d.

Examples:

vector = Geom::Vector2d.new(1, 2)
vector.y = 7

Parameters:

• y (Numeric) —

  The desired y value of the Geom::Vector2d

Returns:

• (Numeric) —

  The new y value of the Geom::Vector2d

Version:

• LayOut 2018

# File 'lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb', line 519

def y=(y)
end