TPoint3D Class Reference

Stores a three-dimensional point in Cartesian or polar co-ordinates. More...

#include <e32cmn.h>

Public Types
enum	TUninitialized { EUninitialized }

Public Member Functions
	TPoint3D (TUninitialized)
	TUninitialized Constructor.
	TPoint3D ()
	Constructs default TPoint3D, initialising its iX , iY and iZ members to zero.
	TPoint3D (TInt aX, TInt aY, TInt aZ)
	Constructs TPoint3D with the specified x,y and z co-ordinates.
	TPoint3D (const TPoint &aPoint)
	Copy Construct from TPoint , initialises Z co-ordinate to Zero.
IMPORT_C TBool	operator== (const TPoint3D &aPoint3D) const
	Compares two 3D points(TPoint3D) for equality.
IMPORT_C TBool	operator!= (const TPoint3D &aPoint3D) const
	Compares two 3D points for inequality.
IMPORT_C TPoint3D &	operator-= (const TPoint3D &aPoint3D)
	TPoint3D subtraction assignment operator.
IMPORT_C TPoint3D &	operator-= (const TPoint &aPoint)
	TPoint subtraction assignment operator.
IMPORT_C TPoint3D &	operator+= (const TPoint3D &aPoint3D)
	TPoint3D addition assignment operator.
IMPORT_C TPoint3D &	operator+= (const TPoint &aPoint)
	TPoint addition assignment operator.
IMPORT_C TPoint3D	operator- (const TPoint3D &aPoint3D) const
	TPoint3D subtraction operator.
IMPORT_C TPoint3D	operator- (const TPoint &aPoint) const
	TPoint subtraction operator.
IMPORT_C TPoint3D	operator+ (const TPoint3D &aPoint3D) const
	The operator adds the specified point to this point, and returns the resulting value.
IMPORT_C TPoint3D	operator+ (const TPoint &aPoint) const
	TPoint addition operator.
IMPORT_C TPoint3D	operator- () const
	Unary minus operator.
IMPORT_C void	SetXYZ (TInt aX, TInt aY, TInt aZ)
	Set Method to set the xyz co-ordinates of TPoint3D.
IMPORT_C void	SetPoint (const TPoint &aPoint)
	TPoint3D from TPoint, sets the Z co-ordinate to Zero.
IMPORT_C TPoint	AsPoint () const
	Returns TPoint from TPoint3D.

Public Attributes
TInt	iX
	The x co-ordinate.
TInt	iY
	The y co-ordinate.
TInt	iZ
	The z co-ordinate.

Detailed Description

Stores a three-dimensional point in Cartesian or polar co-ordinates.

Its data members (iX, iY and iZ) are public and can be manipulated directly.

API status

Published to all clients. Prototype:

Definition at line 2332 of file e32cmn.h.

Member Enumeration Documentation

TUninitialized

enum TPoint3D::TUninitialized

Enumerator
EUninitialized

Definition at line 2336 of file e32cmn.h.

Constructor & Destructor Documentation

TPoint3D() [1/4]

TPoint3D::TPoint3D ( TUninitialized  )

inline

TUninitialized Constructor.

Definition at line 2341 of file e32cmn.h.

TPoint3D() [2/4]

TPoint3D::TPoint3D ( )

inline

Constructs default TPoint3D, initialising its iX , iY and iZ members to zero.

TPoint3D() [3/4]

TPoint3D::TPoint3D ( TInt  aX, TInt  aY, TInt  aZ  )

inline

Constructs TPoint3D with the specified x,y and z co-ordinates.

Parameters

aX	The x co-ordinate value.
aY	The y co-ordinate value.
aZ	The z co-ordinate value.

(generated from Symbian Developer Library)

TPoint3D() [4/4]

TPoint3D::TPoint3D ( const TPoint &  aPoint )

inline

Copy Construct from TPoint , initialises Z co-ordinate to Zero.

Member Function Documentation

AsPoint()

IMPORT_C TPoint TPoint3D::AsPoint

(

)

const

Returns TPoint from TPoint3D.

operator!=()

IMPORT_C TBool TPoint3D::operator!=

(

const TPoint3D &

aPoint3D

)

const

Compares two 3D points for inequality.

For two points to be unequal, their x or y or z co-ordinate values must be different.

Parameters

aPoint3D

The point to be compared with this point.

(generated from Symbian Developer Library)

operator+() [1/2]

IMPORT_C TPoint3D TPoint3D::operator+

(

const TPoint &

aPoint

)

const

TPoint addition operator.

The operator adds the specified TPoint to this point, and returns the resulting value.

(generated from Symbian Developer Library)

operator+() [2/2]

IMPORT_C TPoint3D TPoint3D::operator+

(

const TPoint3D &

aPoint3D

)

const

The operator adds the specified point to this point, and returns the resulting value.

Parameters

aPoint3D

The point to be added to this point.

(generated from Symbian Developer Library)

operator+=() [1/2]

IMPORT_C TPoint3D & TPoint3D::operator+=

(

const TPoint &

aPoint

)

TPoint addition assignment operator.

The operator adds the specified TPoint to this point, and assigns the result back to this point.

The operation proceeds by: adding x and y cordinates of the TPoin to this point and no changes to the Z-coordinatete value

Parameters

aPoint

The TPoint to be added to this point.

(generated from Symbian Developer Library)

operator+=() [2/2]

IMPORT_C TPoint3D & TPoint3D::operator+=

(

const TPoint3D &

aPoint3D

)

TPoint3D addition assignment operator.

The operator adds the specified point to this point, and assigns the result back to this point.

Parameters

aPoint3D

The point to be added.

(generated from Symbian Developer Library)

operator-() [1/3]

IMPORT_C TPoint3D TPoint3D::operator-

(

)

const

Unary minus operator.

The operator returns the negation of this Point3D

operator-() [2/3]

IMPORT_C TPoint3D TPoint3D::operator-

(

const TPoint &

aPoint

)

const

TPoint subtraction operator.

The operator subtracts the specified TPoint from this point, and returns the resulting value.

Parameters

aPoint

The TPoint to be subtracted.

(generated from Symbian Developer Library)

operator-() [3/3]

IMPORT_C TPoint3D TPoint3D::operator-

(

const TPoint3D &

aPoint3D

)

const

TPoint3D subtraction operator.

The operator subtracts the specified point from this point, and returns the resulting value.

Parameters

aPoint3D

The point to be subtracted from this point.

(generated from Symbian Developer Library)

operator-=() [1/2]

IMPORT_C TPoint3D & TPoint3D::operator-=

(

const TPoint &

aPoint

)

TPoint subtraction assignment operator.

The operator subtracts the specified TPoint from this point(TPoint3D), and assigns the result back to this point.

The operation proceeds by subtracting x and y cordinates of the TPoin to this point and no changes to the Z-coordinatete value

Parameters

aPoint

The aPoint to be subtracted.

(generated from Symbian Developer Library)

operator-=() [2/2]

IMPORT_C TPoint3D & TPoint3D::operator-=

(

const TPoint3D &

aPoint3D

)

TPoint3D subtraction assignment operator.

The operator subtracts the specified point from this point, and assigns the result back to this point.

(generated from Symbian Developer Library)

operator==()

IMPORT_C TBool TPoint3D::operator==

(

const TPoint3D &

aPoint3D

)

const

Compares two 3D points(TPoint3D) for equality.

For two TPoint3D to be equal, their x , y and zco-ordinate values must be equal.

Parameters

aPoint3D

The point to be compared with this point.

(generated from Symbian Developer Library)

SetPoint()

IMPORT_C void TPoint3D::SetPoint

(

const TPoint &

aPoint

)

TPoint3D from TPoint, sets the Z co-ordinate to Zero.

SetXYZ()

IMPORT_C void TPoint3D::SetXYZ	(	TInt	aX,
		TInt	aY,
		TInt	aZ
	)

Set Method to set the xyz co-ordinates of TPoint3D.

Parameters

aX	The value to assign to the x co-ordinate.
aY	The value to assign to the y co-ordinate.
aZ	The value to assign to the z co-ordinate.

(generated from Symbian Developer Library)

Member Data Documentation

iX

TInt TPoint3D::iX

The x co-ordinate.

Definition at line 2393 of file e32cmn.h.

iY

TInt TPoint3D::iY

The y co-ordinate.

Definition at line 2397 of file e32cmn.h.

iZ

TInt TPoint3D::iZ

The z co-ordinate.

Definition at line 2401 of file e32cmn.h.

---

The documentation for this class was generated from the following files:

• e32cmn.h
• e32cmn.h.dox