Class: Geom::Vector3d
 Inherits:

Object
 Object
 Geom::Vector3d
Overview
The Vector3d class is used to represent vectors in a 3 dimensional space. Vectors in SketchUp have a direction and a length, but not a starting point.
There are numerous tutorials on 3D vectors available on the internet.
Class Method Summary collapse

.linear_combination(weight1, vector1, weight2, vector2) ⇒ Object
The linear_combination method is used to create a new vector as a linear combination of other vectors.
Instance Method Summary collapse

#dot(vector2) ⇒ Object
The dot method is used to compute the dot product between two vectors.

#cross(vector) ⇒ Object
The cross method is used to compute the cross product between two vectors.

#+(vector2) ⇒ Object
The  method is used to add a vector to this one.

#(vector2) ⇒ Object
The  method is used to subtract a vector from this one.

#<(vector2) ⇒ Object
The < method is used to determine if a vector's x, y or z value is less than another vector's x, y or z value.

#==(vector2) ⇒ Object
The == method is used to determine if two vectors are equal to within tolerance.

#[](i) ⇒ Object
The [] method is used to access the coordinates of a vector as if it was an Array.

#[]=(arguments) ⇒ Object
The []= method is used to set the coordinates of a vector as if it was an Array.

#angle_between(vector2) ⇒ Object
The angle_between method is used to compute the angle (in radians) between this vector and another vector.

#axes ⇒ Object
The axes method is used to compute an arbitrary set of axes with the given vector as the zaxis direction.

#clone ⇒ Object
The clone method is used to make a copy of a vector.

#cross(vector) ⇒ Object
The cross method is used to compute the cross product between two vectors.

#dot(vector2) ⇒ Object
The dot method is used to compute the dot product between two vectors.

#initialize(*args) ⇒ Object
constructor
The new method is used to create a new vector.

#inspect ⇒ Object
The inspect method is used to inspect the contents of a vector as a friendly string.

#length ⇒ Object
The length method is used to retrieve the length of the vector.

#length=(length) ⇒ Object
The length= method is used to set the length of the vector.

#normalize ⇒ Object
The normalize method is used to return a vector that is a unit vector of another.

#normalize! ⇒ Object
The normalize! method is used to convert a vector into a unit vector, in place.

#parallel?(vector2) ⇒ Object
The parallel method is used to determine if this vector is parallel to another vector to within tolerance.

#perpendicular?(vector2) ⇒ Object
The perpendicular? method is used to determine if this vector is perpendicular to another vector to within tolerance.

#reverse ⇒ Object
The reverse method is used to return a new vector that is the reverse of this vector, while leaving the original unchanged.

#reverse! ⇒ Object
The reverse! method is used to reverse the vector in place.

#samedirection(vector2) ⇒ Object
The samedirection? method is used to determine if this vector is parallel to and in the same direction as another vector to within tolerance.

#set!(*args) ⇒ Object
The set! method is used to set the coordinates of the vector.

#to_a ⇒ Object
The to_a method retrieves the coordinates of the vector in an Array [x, y, z].

#to_s ⇒ Object
The to_s method is used to format the vector as a String.

#transform!(transform) ⇒ Object
Apply a Transformation to a vector.

#transform(transform) ⇒ Object
Apply a Transformation to a vector, returning a new vector.

#unitvector? ⇒ Object
The unitvector? method is used to see if the vector is a unit vector.

#valid? ⇒ Object
The valid? method is used to verify if a vector is valid.

#x ⇒ Object
The x method is used to retrieve the x coordinate of the vector.

#x=(x) ⇒ Object
The x= method is used to set the x coordinate of the vector.

#y ⇒ Object
The y method is used to retrieve the y coordinate of the vector.

#y=(y) ⇒ Object
Set the y coordinate of the vector.

#z ⇒ Object
Get the z coordinate of the vector.

#z=(z) ⇒ Object
Set the z coordinate of the vector.
Constructor Details
#initialize ⇒ Geom::Vector3d #initialize(x, y, z) ⇒ Geom::Vector3d #initialize(vector2) ⇒ Geom::Vector3d
The new method is used to create a new vector.
Class Method Details
.linear_combination(weight1, vector1, weight2, vector2) ⇒ Object
The linear_combination method is used to create a new vector as a linear combination of other vectors. This method is generally used to get a vector at some percentage between two vectors.
A linear combination is a standard term for vector math. It is defined as point = weight1 * point1 + weight2 * point2.
In addition to the 4argument form detailed here, you may also call this method with 6 parameters in the form of:
 vec = Geom::Vector3d.linear_combination(x, xaxis, y, yaxis, z, zaxis)
Instance Method Details
#dot(vector2) ⇒ Object
The dot method is used to compute the dot product between two vectors.
#cross(vector) ⇒ Object
The cross method is used to compute the cross product between two vectors.
The cross product, also called the vector product, is an operation on two vectors. The cross product of two vectors produces a third vector which is perpendicular to the plane in which the first two lie.
#+(vector2) ⇒ Object
The  method is used to add a vector to this one.
#(vector2) ⇒ Object
The  method is used to subtract a vector from this one.
#<(vector2) ⇒ Object
The < method is used to determine if a vector's x, y or z value is less than another vector's x, y or z value.
#==(vector2) ⇒ Object
The == method is used to determine if two vectors are equal to within tolerance.
#[](i) ⇒ Object
The [] method is used to access the coordinates of a vector as if it was an Array. The index must be 0, 1 or 2.
The following are equivalent:
#[]=(arguments) ⇒ Object
The []= method is used to set the coordinates of a vector as if it was an Array. The value of i must be 0, 1 or 2.
#angle_between(vector2) ⇒ Object
The angle_between method is used to compute the angle (in radians) between this vector and another vector.
#axes ⇒ Object
The axes method is used to compute an arbitrary set of axes with the given vector as the zaxis direction.
Returns an Array of three vectors [xaxis, yaxis, zaxis]
#clone ⇒ Object
The clone method is used to make a copy of a vector.
This method is equivalent to vec2 = Geom::Vector3d.new(vec)
#cross(vector) ⇒ Object
The cross method is used to compute the cross product between two vectors.
The cross product, also called the vector product, is an operation on two vectors. The cross product of two vectors produces a third vector which is perpendicular to the plane in which the first two lie.
#dot(vector2) ⇒ Object
The dot method is used to compute the dot product between two vectors.
#inspect ⇒ Object
The inspect method is used to inspect the contents of a vector as a friendly string.
#length ⇒ Object
The length method is used to retrieve the length of the vector.
#length=(length) ⇒ Object
The length= method is used to set the length of the vector. The length must be greater than 0.
#normalize ⇒ Object
The normalize method is used to return a vector that is a unit vector of another.
#normalize! ⇒ Object
The normalize! method is used to convert a vector into a unit vector, in place.
Another way to do this is vec.length = 1
#parallel?(vector2) ⇒ Object
The parallel method is used to determine if this vector is parallel to another vector to within tolerance.
#perpendicular?(vector2) ⇒ Object
The perpendicular? method is used to determine if this vector is perpendicular to another vector to within tolerance.
#reverse ⇒ Object
The reverse method is used to return a new vector that is the reverse of this vector, while leaving the original unchanged.
#reverse! ⇒ Object
The reverse! method is used to reverse the vector in place.
#samedirection(vector2) ⇒ Object
The samedirection? method is used to determine if this vector is parallel to and in the same direction as another vector to within tolerance.
#set!(x, y, z) ⇒ Object #set!(vector2) ⇒ Object
The set! method is used to set the coordinates of the vector.
#to_a ⇒ Object
The to_a method retrieves the coordinates of the vector in an Array [x, y, z].
#to_s ⇒ Object
The to_s method is used to format the vector as a String.
#transform!(transform) ⇒ Object
Apply a Transformation to a vector. The vector itself is modified.
#transform(transform) ⇒ Object
Apply a Transformation to a vector, returning a new vector. The original vector is unchanged by this method.
#unitvector? ⇒ Object
The unitvector? method is used to see if the vector is a unit vector.
This is equivalent to vec.length == 1.0
#valid? ⇒ Object
The valid? method is used to verify if a vector is valid. A vector is valid if its length is not zero.
#x ⇒ Object
The x method is used to retrieve the x coordinate of the vector.
#x=(x) ⇒ Object
The x= method is used to set the x coordinate of the vector.
#y ⇒ Object
The y method is used to retrieve the y coordinate of the vector.
#y=(y) ⇒ Object
Set the y coordinate of the vector.
#z ⇒ Object
Get the z coordinate of the vector.
#z=(z) ⇒ Object
Set the z coordinate of the vector.