class Geom::Point2d

The {Geom::Point2d} class allows you to work with a point in 2D space. {Geom::Point2d} is a series of values representing x and y coordinates.

The values are specified as +[x, y]+. For example [1, 1]. To create a point call Geom::Point2d.new, where the creation method can take a variety of arguments:

@example

# No arguments, creates a point at the origin [0, 0]
pt1 = Geom::Point2d.new

# Creates a point at x of 1, y of 2.
pt2 = Geom::Point2d.new(1, 2)

# You can also create a point directly by simply assigning the x, and y
# values to a variable as an array:
pt3 = [1, 2]

@version LayOut 2018

Public Class Methods

new(*args) click to toggle source

The {.new} method creates a new {Geom::Point2d}.

@example

# No arguments, creates a point at the origin [0, 0]
pt1 = Geom::Point2d.new

# Creates a point at x of 1 and y of 2.
pt2 = Geom::Point2d.new(1, 2)

# You can also create a point directly by simply assigning the x and y
# values to a variable as an array:
pt3 = [1, 2]

@overload initialize

@return [Geom::Point2d]

@overload initialize(x, y)

@param [Numeric] x The location along the x axis
@param [Numeric] y The location along the y axis
@return [Geom::Point2d]

@overload initialize(point)

@param [Geom::Point2d, Array(Numeric, Numeric)] point
@return [Geom::Point2d]

@version LayOut 2018

# File lib/sketchup-api-stubs/stubs/Geom/Point2d.rb, line 183
def initialize(*args)
end

Public Instance Methods

+(vector) click to toggle source

The {#+} operator is a simple way to add to the current x and y values of the {Geom::Point2d}, or to set the values of the {Geom::Point2d} by adding a {Geom::Vector2d} to the {Geom::Point2d}.

@example

pt = [1, 1]
# the result is a Point2d(2, 3)
pt2 = pt + [1, 2]

@param [Geom::Vector2d, Array(Numeric, Numeric)] vector

@return [Geom::Point2d]

@version LayOut 2018

# File lib/sketchup-api-stubs/stubs/Geom/Point2d.rb, line 41
def +(vector)
end
-(arg) click to toggle source

The {#-} operator is a simple way to subtract from the current x and y values of the {Geom::Point2d}.

@example

vec = Geom::Vector2d.new(1, 2)
# result is a Point2d(3, 0)
pt = [4, 2] - vec
# result is a Vector2d(1, 2)
vec2 = [4, 2] - pt

@overload -(vector)

@param [Geom::Vector2d, Array(Numeric, Numeric)] vector
@return [Geom::Point2d]

@overload -(point)

@param [Geom::Point2d] point2d
@return [Geom::Vector2d] a vector indicating the difference between the two
    points

@version LayOut 2018

# File lib/sketchup-api-stubs/stubs/Geom/Point2d.rb, line 66
def -(arg)
end
==(point) click to toggle source

The {#==} method compares two points for equality. This uses the standard SketchUp tolerance to determine if two points are the same.

@example

point1 = Geom::Point2d.new(1, 1)
point2 = Geom::Point2d.new(0, 1)
status = point1 == point2

@param [Geom::Point2d, Array(Numeric, Numeric)] point

@return [Boolean]

@version LayOut 2018

# File lib/sketchup-api-stubs/stubs/Geom/Point2d.rb, line 82
def ==(point)
end
[](index) click to toggle source

The {#[]} method returns the value of the {Geom::Point2d} at the specified index.

@example

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

# returns the y value of 2
yvalue = point[1]

@param [Integer] index

The index for a specific x or y value in the
{Geom::Point2d}

@return [Length] The new x or y value if successful

@version LayOut 2018

# File lib/sketchup-api-stubs/stubs/Geom/Point2d.rb, line 101
def [](index)
end
[]=(index, value) click to toggle source

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

@example

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

@param [Integer] index

The index for a specific x or y value in the
{Geom::Point2d} to set

@param [Numeric] value

The value to set for x or y

@return [Numeric] The new x or y value if successful

@version LayOut 2018

# File lib/sketchup-api-stubs/stubs/Geom/Point2d.rb, line 121
def []=(index, value)
end
clone() click to toggle source

The {#clone} method creates another point identical to the {Geom::Point2d} being cloned.

@example

point = Geom::Point2d.new(1, 2)
newpoint = point.clone

@return [Geom::Point2d] the cloned {Geom::Point2d} object

@version LayOut 2018

# File lib/sketchup-api-stubs/stubs/Geom/Point2d.rb, line 134
def clone
end
distance(point) click to toggle source

The {#distance} method computes the distance from the {Geom::Point2d} to another {Geom::Point2d}.

@example

point1 = Geom::Point2d.new(1, 1)
point2 = Geom::Point2d.new(1, 4)
# result is a value of 3
distance = point1.distance(point2)

@param [Geom::Point2d, Array(Numeric, Numeric)] point

@return [Numeric] the distance between the points in the current units

@version LayOut 2018

# File lib/sketchup-api-stubs/stubs/Geom/Point2d.rb, line 151
def distance(point)
end
inspect() click to toggle source

The {#inspect} method formats the {Geom::Point2d} as a string.

@example

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

@return [String]

@version LayOut 2018

# File lib/sketchup-api-stubs/stubs/Geom/Point2d.rb, line 195
def inspect
end
offset(*args) click to toggle source

The {#offset} method offsets the {Geom::Point2d} by a {Geom::Vector2d} and returns a new {Geom::Point2d}. If distance is provided, it must be non-zero.

@example

point = Geom::Point2d.new
vector = Geom::Vector2d.new(0, 2)
# result is a Point2d(0, 1)
point2 = point1.offset(vector, 1)

@overload offset(vector)

@param [Geom::Vector2d, Array(Numeric, Numeric)] vector
@return [Geom::Point2d]

@overload offset(vector, distance)

@param [Geom::Vector2d, Array(Numeric, Numeric)] vector
@param [Numeric] distance The how far along the vector to offset
@return [Geom::Point2d]

@version LayOut 2018

# File lib/sketchup-api-stubs/stubs/Geom/Point2d.rb, line 219
def offset(*args)
end
offset!(*args) click to toggle source

The {#offset!} method offsets the {Geom::Point2d} by a {Geom::Vector2d}. The {Geom::Point2d} itself is modified. The length of the vector must not be zero.

@example

point = Geom::Point2d.new
vector = Geom::Vector2d.new(0, 2)
# result is a Point2d(0, 1)
point1.offset!(vector, 1)

@overload offset!(vector)

@param [Geom::Vector2d, Array(Numeric, Numeric)] vector
@return [Geom::Point2d]

@overload offset!(vector, distance)

@param [Geom::Vector2d, Array(Numeric, Numeric)] vector
@param [Numeric] distance The distance along the vector to offset
@return [Geom::Point2d]

@version LayOut 2018

# File lib/sketchup-api-stubs/stubs/Geom/Point2d.rb, line 244
def offset!(*args)
end
set!(*args) click to toggle source

The {#set!} method sets the values of the {Geom::Point2d}.

@example

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

@overload set!(point)

@param [Geom::Point2d, Array(Numeric, Numeric)] point
@return [Geom::Point2d]

@overload set!(x, y)

@param [Numeric] x
@param [Numeric] y
@return [Geom::Point2d]

@version LayOut 2018

# File lib/sketchup-api-stubs/stubs/Geom/Point2d.rb, line 265
def set!(*args)
end
to_a() click to toggle source

The {#to_a} method converts the {Geom::Point2d} to an array of 2 numbers.

@example

point = Geom::Point2d.new(1, 2)
array = point.to_a

@return [Array(Numeric, Numeric)] an array of two numbers representing x, y

of the {Geom::Point2d}

@version LayOut 2018

# File lib/sketchup-api-stubs/stubs/Geom/Point2d.rb, line 278
def to_a
end
to_s() click to toggle source

The {#to_s} method returns a string representation of the {Geom::Point2d}.

@example

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

@return [String]

@version LayOut 2018

# File lib/sketchup-api-stubs/stubs/Geom/Point2d.rb, line 290
def to_s
end
transform(transform) click to toggle source

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

@example

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

@param [Geom::Transformation2d] transform

A Transformation object to apply to the point.

@return [Geom::Point2d] the transformed point

@version LayOut 2019

# File lib/sketchup-api-stubs/stubs/Geom/Point2d.rb, line 308
def transform(transform)
end
transform!(transform) click to toggle source

The {#transform!} method applies a transformation to a point. The point itself is modified.

@example

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

@param [Geom::Transformation2d] transform

A Transformation object to apply to the point.

@return [Geom::Point2d] the transformed point

@version LayOut 2019

# File lib/sketchup-api-stubs/stubs/Geom/Point2d.rb, line 326
def transform!(transform)
end
vector_to(point) click to toggle source

The {#vector_to} method returns the vector between points.

@example

pt1 = Geom::Point2d.new(1, 1)
pt2 = Geom::Point2d.new(3, 1)

# result is a Vector2d(2, 0)
vec = pt1.vector_to(pt2) # is equivalent to (pt2 - pt1)

@param [Geom::Point2d] point

@return [Geom::Vector2d]

@version LayOut 2018

# File lib/sketchup-api-stubs/stubs/Geom/Point2d.rb, line 343
def vector_to(point)
end
x() click to toggle source

The {#x} method returns the x value of the {Geom::Point2d}.

@example

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

@return [Length] the x value of the {Geom::Point2d}

@version LayOut 2018

# File lib/sketchup-api-stubs/stubs/Geom/Point2d.rb, line 355
def x
end
x=(x) click to toggle source

The {#x=} method sets the x value of the {Geom::Point2d}.

@example

point = Geom::Point2d.new(1, 2)
point.x = 7

@param [Numeric] x

The desired x value of the {Geom::Point2d}

@return [Numeric] The new x value of the {Geom::Point2d}

@version LayOut 2018

# File lib/sketchup-api-stubs/stubs/Geom/Point2d.rb, line 370
def x=(x)
end
y() click to toggle source

The {#y} method returns the y value of the {Geom::Point2d}.

@example

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

@return [Length] The y value of the {Geom::Point2d}

@version LayOut 2018

# File lib/sketchup-api-stubs/stubs/Geom/Point2d.rb, line 382
def y
end
y=(y) click to toggle source

The {#y=} method sets the y value of the {Geom::Point2d}.

@example

point = Geom::Point2d.new(1, 2)
point.y = 7

@param [Numeric] y

The desired y value of the {Geom::Point2d}

@return [Numeric] The new y value of the {Geom::Point2d}

@version LayOut 2018

# File lib/sketchup-api-stubs/stubs/Geom/Point2d.rb, line 397
def y=(y)
end