HelpSource/Classes/Point.schelp

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