HelpSource/Classes/Point.schelp

   1 class:: Point
   2 summary:: Cartesian point
   3 related:: Classes/Polar, Classes/Complex
   4 categories:: Geometry
   5
   6 description::
   7 Defines a point on the Cartesian plane.
   8
   9 classmethods::
  10
  11 method::new
  12 Defines a new point.
  13
  14 instancemethods::
  15
  16 subsection:: Accessing
  17
  18 method::x
  19 Get or set the x coordinate value.
  20
  21 method::y
  22 Get or set the y coordinate value.
  23
  24 method::set
  25 Sets the point x and y values.
  26
  27 subsection:: Testing
  28
  29 method::==
  30 Answers a Boolean whether the receiver equals the argument.
  31
  32 method::hash
  33 Returns a hash value for the receiver.
  34
  35 subsection:: Math
  36
  37 method::+
  38 Addition.
  39
  40 method::-
  41 Subtraction.
  42
  43 method::*
  44 Multiplication.
  45
  46 method::/
  47 Division.
  48
  49 method::translate
  50 Addition by a Point.
  51
  52 method::scale
  53 Multiplication by a Point.
  54
  55 method::rotate
  56 Rotation about the origin by the angle given in radians.
  57
  58 method::abs
  59 Absolute value of the point.
  60
  61 method::rho
  62 Return the polar coordinate radius of the receiver.
  63
  64 method::theta
  65 Return the polar coordinate angle of the receiver.
  66
  67 method::dist
  68 Return the distance from the receiver to aPoint.
  69
  70 method::transpose
  71 Return a Point whose x and y coordinates are swapped.
  72
  73 method::round
  74 Round the coordinate values to a multiple of quantum.
  75
  76 method::trunc
  77 Truncate the coordinate values to a multiple of quantum.
  78
  79 subsection:: Conversion
  80
  81 method::asPoint
  82 Returns the receiver.
  83
  84 method::asComplex
  85 Returns a complex number with x as the real part and y as the imaginary part.
  86
  87 method::asString
  88 Return a string representing the receiver.