"

 COPYRIGHT (c) 1989 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

"{ Package: 'stx:libbasic' }"

ArithmeticValue subclass:#Point

	instanceVariableNames:'x y'

	classVariableNames:'PointZero PointOne'

	poolDictionaries:''

	category:'Graphics-Geometry'

!

!Point class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1989 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

!

documentation

"

    I represent a point in 2D space. Or I can be used to represent

    an extent (of a rectangle, for example), in which case my x-coordinate 

    represents the width, and y-coordinate the height of something.

    The x and y coordinate are usually numbers.

    [Instance variables:]

	x              <Number>        the x-coordinate of myself

	y              <Number>        the y-coordinate of myself

    [author:]

	Claus Gittinger

    [see also:]

	Rectangle Polygon

	LayoutOrigin LayoutFrame AlignmentOrigin Layout 

	View GraphicsContext

"

! !

!Point class methodsFor:'initialization'!

initialize

    PointZero isNil ifTrue:[

	PointZero := 0 @ 0.

	PointOne  := 1 @ 1

    ]

! !

!Point class methodsFor:'instance creation'!

decodeFromLiteralArray:anArray

    "create & return a new instance from information encoded in anArray.

     Redefined for faster creation."

    ^ self x:(anArray at:2) y:(anArray at:3)

    "

     Point

	decodeFromLiteralArray:#(Point 10 10)

    "

    "Created: / 28.1.1998 / 17:44:08 / cg"

!

r:distance angle:angle

    "create and return a new point given polar coordinates.

     The angle is given in degrees.

     OBSOLETE STX interface, use #r:theta:"

    <resource:#obsolete>

    ^ self r:distance theta:angle degreesToRadians

    "

     Point r:100 angle:0  

     Point r:100 angle:90  

     Point r:100 angle:45  

     Point r:100 angle:180  

    "

    "Modified: 8.5.1996 / 20:01:50 / cg"

!

r:distance degrees:angle

    "create and return a new point given polar coordinates.

     The angle is given in degrees.

     Added for Squeak compatibility"

    ^ self r:distance theta:angle degreesToRadians

    "

     Point r:100 degrees:90  

    "

    "Modified: 8.5.1996 / 20:01:50 / cg"

!

r:distance theta:angleInRadians

    "create and return a new point given polar coordinates.

     The angle is given in radians"

    |x y|

    x := distance * angleInRadians cos.

    y := distance * angleInRadians sin.

    ^ x @ y

    "

     Point r:100 theta:0  

     Point r:100 theta:Float pi/2 

    "

    "Modified: 2.4.1997 / 00:01:40 / cg"

!

readFrom:aStringOrStream onError:exceptionBlock

    "return the next Point from the (character-)stream aStream;

     skipping all whitespace first; return the value of exceptionBlock,

     if no point can be read."

    ^ [

        |str newX newY hasParen|

        str := aStringOrStream readStream.

        str skipSeparators.

        (hasParen := str peek) == $( ifTrue:[

            str next.   

        ].

        newX := Number readFrom:str onError:nil.

        newX notNil ifTrue:[

            (str skipSeparators == $@) ifTrue:[

                str  next.

                newY := Number readFrom:str onError:nil.

                newY notNil ifTrue:[

                    hasParen ifTrue:[

                        str skipSeparators.

                        str peek == $) ifTrue:[

                            str next.   

                        ]

                    ].

                    ^ self x:newX y:newY

                ]

            ]

        ].

        ^ exceptionBlock value

    ] on:Error do:exceptionBlock.

    "

     Point readFrom:'1.234 @ 5.678'

     Point readFrom:'1'

     Point readFrom:'1' onError:[1@1]

     Point readFrom:'fooBar' onError:[0@0]

    "

    "Modified: 8.10.1996 / 19:31:39 / cg"

!

x:newX y:newY

    "create and return a new point with coordinates newX and newY"

%{  /* NOCONTEXT */

    /*

     * claus: I am no longer certain, if this primitive is worth the effort

     */

    if (__CanDoQuickNew(sizeof(struct __Point))) {      /* OBJECT ALLOCATION */

        if (self == @global(Point)) {

            OBJ newPoint;

            int spc;

            __qCheckedAlignedNew(newPoint, sizeof(struct __Point));

            __InstPtr(newPoint)->o_class = self; __qSTORE(newPoint, self);

            __PointInstPtr(newPoint)->p_x = newX;

            __PointInstPtr(newPoint)->p_y = newY;

            if (! __bothSmallInteger(newX, newY)) {

                spc = __qSpace(newPoint);

                __STORE_SPC(newPoint, newX, spc);

                __STORE_SPC(newPoint, newY, spc);

            }

            RETURN ( newPoint );

        }

    }

%}.

    ^ (self basicNew) x:newX y:newY

! !

!Point class methodsFor:'constants'!

unity

    "return the neutral element for multiplication"

    ^ PointOne

!

zero

    "return the neutral element for addition"

    ^ PointZero

! !

!Point class methodsFor:'queries'!

isBuiltInClass

    "return true if this class is known by the run-time-system.

     Here, true is returned for myself, false for subclasses."

    ^ self == Point

    "Modified: 23.4.1996 / 16:00:18 / cg"

! !

!Point methodsFor:'Compatibility-Squeak'!

adhereTo: aRectangle

    "If the receiver lies outside aRectangle, return the nearest point on the boundary of the rectangle, otherwise return self."

    (aRectangle containsPoint: self) ifTrue: [^ self].

    ^ ((x max: aRectangle left) min: aRectangle right)

      @

      ((y max: aRectangle top) min: aRectangle bottom)

!

asFloatPoint

    "Squeak mimicri return the receiver as Point - this is the receiver"

    ^ self

! !

!Point methodsFor:'accessing'!

x

    "return the x coordinate"

    ^ x

!

x:newX

    "set the x coordinate to be the argument, aNumber.

     This is destructive (modifies the receiver, not a copy) and 

     should only be used if you know, that you are the exclusive owner 

     of the receiver."

    x := newX

!

x:newX y:newY

    "set both the x and y coordinates.

     This is destructive (modifies the receiver, not a copy) and 

     should only be used if you know, that you are the exclusive owner 

     of the receiver."

    x := newX.

    y := newY

!

y

    "return the y coordinate"

    ^ y

!

y:newY

    "set the y coordinate to be the argument, aNumber.

     This is destructive (modifies the receiver, not a copy) and 

     should only be used if you know, that you are the exclusive owner 

     of the receiver."

    y := newY

! !

!Point methodsFor:'coercing & converting'!

coerce:anObject

    "return aNumber converted into receivers type"

    ^ anObject asPoint

!

generality

    "return the generality value - see ArithmeticValue>>retry:coercing:"

    ^ 120

! !

!Point methodsFor:'comparing'!

< aPoint

    "return true if the receiver is above and to the left

     of the argument, aPoint"

    |p|

    p := aPoint asPoint.

    x < (p x) ifTrue:[

	y < (p y) ifTrue:[^ true].

    ].

    ^ false

    "notice the funny result if one coordinate has the same value ...

     (3@4) < (4@4)    

     (3@4) <= (4@4)    

     (3@4) > (4@4) 

     (4@4) >= (3@4)   

     (4@4) > (3@4)   

    "

    "Modified: 7.5.1996 / 12:14:25 / cg"

!

= aPoint

    "return true if the receiver represents the same point as

     the argument, aPoint"

    |p|

    (aPoint isMemberOf:Point) ifTrue:[     "this is a hint to STC"

	x ~= (aPoint x) ifTrue:[^ false].

	y ~= (aPoint y) ifTrue:[^ false].

	^ true

    ].

    aPoint respondsToArithmetic ifFalse:[ ^ false].

    p := aPoint asPoint.

    x ~= (p x) ifTrue:[^ false].

    y ~= (p y) ifTrue:[^ false].

    ^ true

!

> aPoint

    "return true if  the receiver is below and to the right

     of the argument, aPoint"

    |p|

    p := aPoint asPoint.

    (p x) < x ifTrue:[

	(p y) < y ifTrue:[^ true].

    ].

    ^ false

    "Modified: 7.5.1996 / 12:11:15 / cg"

!

hash

    "return a number for hashing"

    x = y ifTrue:[^ x hash].

"

 used to be:

    ^ (x hash) bitXor:(y hash)

 the following handles 1@x vs. x@1 better:

"

    ^ (x hash) bitXor:(y hash bitShift:16)

!

max:aPoint

    "return the lower right corner of the rectangle uniquely defined by

     the receiver and the argument, aPoint"

    |p maxX maxY|

    p := aPoint asPoint.

    maxX := x max:(p x).

    maxY := y max:(p y).

    ^ maxX @ maxY

!

min:aPoint

    "return the upper left corner of the rectangle uniquely defined by

     the receiver and the argument, aPoint"

    |p minX minY|

    p := aPoint asPoint.

    minX := x min:(p x).

    minY := y min:(p y).

    ^ minX @ minY

! !

!Point methodsFor:'converting'!

asComplex

    "Return a complex number whose real and imaginary components are the x and y

     coordinates of the receiver."

    ^ Complex real:x imaginary:y

    "Modified: / 9.7.1998 / 10:21:10 / cg"

!

asFractionalLayout

    "return a LayoutOrigin from the receiver,

     treating the receiver coordinates as fractional parts 

     (i.e. relative to superview).

     Notice: in 10.5.x LayoutOrigin is not yet officially released."

    ^ LayoutOrigin fractionalFromPoint:self

    "

     (0@0.5) asFractionalLayout 

     (0@0.5) asLayout           

     (0@10) asLayout             

     (0@10) asOffsetLayout      

    "

!

asIntegerPoint

    (x isInteger and:[y isInteger]) ifTrue:[ ^ self].

    ^ x asInteger @ y asInteger

!

asLayout

    "return a LayoutOrigin from the receiver.

     If the receiver coordinates are between 0 and 1, take

     them as fractional parts (relative to superview).

     Otherwise, treat them as absolute offsets.

     Notice: in 10.5.x LayoutOrigin is not yet released."

    ^ LayoutOrigin fromPoint:self

    "

     (0@0.5) asFractionalLayout 

     (0@0.5) asLayout           

     (0@10) asLayout             

     (0@10) asOffsetLayout      

    "

!

asOffsetLayout

    "return a LayoutOrigin from the receiver,

     treating the receiver coordinates as absolute offsets. 

     Notice: in 10.5.x LayoutOrigin is not yet released."

    ^ LayoutOrigin offsetFromPoint:self

    "

     (0@0.5) asFractionalLayout 

     (0@0.5) asLayout           

     (0@10) asLayout             

     (0@10) asOffsetLayout      

    "

!

asPoint

    "return the receiver as Point - this is the receiver"

    ^ self

!

asRectangle

    "return a zero-width rectangle consisting of origin 

     and corner being the receiver"

    ^ self corner:self

    "

     (0@10) asRectangle