SDK Home Glossary Index Left Right Up

Point


Section contents


Overview

Defined in

ce32base.oxh


Construction / destruction


NewPoint - Constructor

Usage

this& = NewPoint&:(X&,Y&)

Description

Creates a point object and returns a handle which allows the object to be manipulated.

Parameters
X& The X co-ordinate of the point.
Y& The Y co-ordinate of the point
Return Value
this& An value which represents the created point
Error Handling

If the object could not be created then an error is generated which should be trapped by an ONERR handler.

Example
  LOCAL this&

  this& = NewPoint&:(50,50)
  DeletePoint:(this&) 

DeletePoint - Destructor

Usage

DeletePoint:(BYREF this&)

Description

Destroys the point object.

Arguments
BYREF this& A handle to a point object
Example
  LOCAL this&

  this& = NewPoint&:(50,50)
  DeletePoint:(this&) 

Methods provided


PointAdd

Usage

this& = PointAdd&:(this&,point&)

Description

Adds the point in point& to the point in this& and returns the handle this&.

Arguments
this& A handle to a point object
point& A handle to a point objec
Return value
this& A handle to a point object

PointAddSize

Usage

this& = PointAddSize&:(this&,size&)

Description

Adds the size in point& to the point in this& and returns the handle this&.

Arguments
this& A handle to a point object
size& A handle to a size objec
Return value
this& A handle to a point object

PointAsSize

Usage

size& = PointAsSize&:(this&)

Description
<TBS>
Arguments
this& A handle to a point object
Return value
size& A size object created. The handle should be freed by the caller when it is no longer required.
Error Handling

If the size& object cannot be created then an error is generated which should be trapped by an ONERR handler.


PointEQ

Usage

result% = PointEQ%:(this&,point&)

Description

Compares the 2 points for equality.

Arguments
this& A handle to a point object
point& A handle to a point objec
Return value
result% Returns -1 (true) if the points described by this& and point& are the same, otherwise returns 0

PointMinus

Usage

this& = PointMinus&:(this&,point&)

Description

Subtracts the point in point& from the point in this& and returns the handle this&.

Arguments
this& A handle to a point object
point& A handle to a point objec
Return value
this& A handle to a point object

PointMinusSize

Usage

this& = PointMinusSize&:(this&,size&)

Description

Subtracts the size in point& from the point in this& and returns the handle this&.

Arguments
this& A handle to a point object
size& A handle to a size objec
Return value
this& A handle to a point object

PointNE

Usage

result% = PointNE%:(this&,point&)

Description

Compares the 2 point for inequality.

Arguments
this& A handle to a point object
point& A handle to a point objec
Return value
result% Returns -1 (true) if the points described by this& and point& are not the same, otherwise returns 0

PointNegate

Usage

this& = PointNegate&:(this&)

Description

Negates the point in this& and returns the handle this&.

Arguments
this& A handle to a point object
Return value
this& A handle to a point object

PointSetXY

Usage

PointSetXY:(this&,X&,Y&)

Description

Set the X and Y co-ordinates in the point object..

Arguments
this& A handle to a point object
X& X co-ordinate
Y& Y co-ordinate

PointX

Usage

X& = PointX&:(this&)

Description

Returns the X co-ordinate from the point object..

Arguments
this& A handle to a point object
Return value
X& The X co-ordinate

PointY

Usage

Y& = PointY&:(this&)

Description

Returns the Y co-ordinate from the point object..

Arguments
this& A handle to a point object
Return value
Y& The Y co-ordinate

  SDK Home Glossary Index Left Right Up