Type: Point

From Waltz
Revision as of 18:30, 26 February 2019 by Patrick Angle (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

The Point type represents a single, infinitely small, point in 3D space. The directions and signs of the axises are left up to the discretion of the user of the type, although commonly numbers extend downward (y), rightwards (x), and outwards (z) on screen. This type can also easily store 2D points, leaving the z axis at 0.

Constructors

Arguments
Point(x, y) Number x - The x coordinate of the point.

Number y - The y coordinate of the point.

Point(x, y, z) Number x - The x coordinate of the point.

Number y - The y coordinate of the point.

Number z - The z coordinate of the point.

Parameters

Type Details
x Number Note: The parameter is read-only. The x coordinate of the point.
y Number Note: The parameter is read-only. The y coordinate of the point.
z Number Note: The parameter is read-only. The z coordinate of the point.
integerPoint java.awt.Point Note: The parameter is read-only. The native Point type in Java. The x and y coordinates are rounded to the nearest whole number, and the z coordinate is excluded.
point2D java.awt.geom.Point2D Note: The parameter is read-only. The native double-precision Point type in Java. The z coordinate is excluded.
anglesFromOrigin Point Note: The parameter is read-only. The angles for each axis of this point from the origin, in degrees.
zAngleFromOrigin Number Note: The parameter is read-only. The angle of this point relative to the origin on the z axis, in degrees. This is the 2D angle.

Functions

Arguments Returns Details
offsetBy(x, y) Number x - The factor by which to offset the x coordinate.

Number y - The factor by which to offset the y coordinate.

Point Create a new Point offset by the given amounts on the x and y axises.
offsetBy(x, y, z) Number x - The factor by which to offset the x coordinate.

Number y - The factor by which to offset the y coordinate.

Number z - The factor by which to offset the z coordinate.

Point Create a new Point offset by the given amounts on the x, y, and z axises.
offsetBy(p) Point p - A point containing x, y, and z values by which to offset this point. Point Create a new Point offset by the given amounts on the x, y, and z axises.
offsetBy(p2d) java.awt.geom.Point2D p2d - A native double-precision point containing x and y values by which to offset this point. Point Create a new Point offset by the given amounts on the x and y axises.
scaleBy(f) Number f - The factor by which to scale all three axises. Point Create a new Point scaled by the given factor on the x, y, and z axises.
scaleBy(x, y) Number x - The factor by which to scale the x coordinate.

Number y - The factor by which to scale the y coordinate.

Point Create a new Point scaled by the given factors on the x and y axises.
scaleBy(x, y, z) Number x - The factor by which to scale the x coordinate.

Number y - The factor by which to scale the y coordinate.

Number z - The factor by which to scale the z coordinate.

Point Create a new Point scaled by the given factors on the x, y, and z axises.
scaleBy(p) Point p - A point containing x, y, and z values by which to scale this point. Point Create a new Point scaled by the given factor on the x, y, and z axises.
scaleBy(p2d) java.awt.geom.Point2D p2d - A native double-precision point containing x and y values by which to scale this point. Point Create a new Point scaled by the given factors on the x and y axises.
rotateBy(z) Number z - The number of degrees by which the z-axis should be rotated clockwise. Point Create a new Point rotated clockwise on the z axis by the given number of degrees.
rotateBy(x, y, z) Number x - The number of degrees by which the x-axis should be rotated clockwise.

Number y - The number of degrees by which the y-axis should be rotated clockwise.

Number z - The number of degrees by which the z-axis should be rotated clockwise.

Point Create a new Point rotated clockwise on the x, y, and z by the given number of degrees. The z rotation is calculated first, followed by the y rotation, and finally the x rotation.
shearBy(x, y) Number x - The factor by which to shear the x coordinate.

Number y - The factor by which to shear the y coordinate.

Point Create a new Point sheared by the given factors on the x and y axises.
shearBy(x, y, z) Number x - The factor by which to shear the x coordinate.

Number y - The factor by which to shear the y coordinate.

Number z - The factor by which to shear the z coordinate.

Point Create a new Point sheared by the given factors on the x, y, and z axises.
shearBy(yx, zx, xy, zy, xz, yz) Number yx - The factor by which to shear the x coordinate relative to its y position.

Number zx - The factor by which to shear the x coordinate relative to its z position.

Number xy - The factor by which to shear the y coordinate relative to its x position.

Number zy - The factor by which to shear the y coordinate relative to its z position.

Number xz - The factor by which to shear the z coordinate relative to its x position.

Number yz - The factor by which to shear the z coordinate relative to its y position.

Point Create a new Point sheared by the given factors on the x, y, and z axises.
shearBy(p) Point p - A point containing x, y, and z values by which to shear this point. Point Create a new Point sheared by the given factors on the x, y, and z axises.
shearBy(p2d) java.awt.geom.Point2D p2d - A native double-precision point containing x and y values by which to shear this point. Point Create a new Point sheared by the given factors on the x and y axises.
distanceTo(x, y) Number x - The x coordinate to which distance should be calculated.

Number y - The y coordinate to which distance should be calculated.

Number Get the distance between this point and a point at the given x and y coordinates and a z coordinate of 0 measured using Euclidean distance.
distanceTo(x, y, z) Number x - The x coordinate to which distance should be calculated.

Number y - The y coordinate to which distance should be calculated.

Number z - The z coordinate to which distance should be calculated.

Number Get the distance between this point and a point at the given x, y, and z coordinates measured using Euclidean distance.
distanceTo(p) Point p - The point to which distance should be calculated. Number Get the distance between this point and the provided point measured using Euclidean distance.
distanceTo(p2d) java.awt.geom.Point2D p2d - A native double-precision point containing x and y values to which distance should be calculated. Number Get the distance between this point and the provided point with a z coordinate of 0 measured using Euclidean distance.
distanceTo(p2d, z) java.awt.geom.Point2D p2d - A native double-precision point containing x and y values to which distance should be calculated.

Number z - The z coordinate to which distance should be calculated.

Number Get the distance between this point and the provided point with the provided z coordinate measured using Euclidean distance.
vectorTo(x, y) Number x - The x coordinate to which a vector should be calculated.

Number y - The y coordinate to which a vector should be calculated.

Point
vectorTo(x, y, z) Number x - The x coordinate to which a vector should be calculated.

Number y - The y coordinate to which a vector should be calculated.

Number z - The z coordinate to which a vector should be calculated.

Point
vectorTo(p) Point p - The point to which a vector should be calculated. Point
vectorTo(p2d) java.awt.geom.Point2D p2d - A native double-precision point containing x and y values to which a vector should be calculated. Point
equals(p) Point p - A point against which to compare equality. Boolean Compares two points to determine if they represent the same point in 3D space.
Types
Primitives Boolean · Number · String
Objects Color · Dimension · DmxMultiverse · DmxUniverse · LocalInterface · Material · Point · RemoteAddress/IP · Scene · Time · Touch
Node Specific NdiSource · WoControlCue · WoHitTestResult · WoTimeline
Collections List · List of Lists · Map · Varargs
Special Any · Consumer · Expression · Null · Void