class QucPosition : public CorBase

a 3D position

Inheritance:

public members:

	QucPosition ( double anX, double aY, double aZ ) double anX double aY double aZ
	QucPosition ( const QucPosition & aRef ) const QucPosition & aRef
QucPosition &	operator= ( const QucPosition & aRef ) const QucPosition & aRef
virtual	~QucPosition ()
void	rotateX ( double anAngle ) double anAngle
void	rotateY ( double anAngle ) double anAngle
void	rotateZ ( double anAngle ) double anAngle
void	translate ( QucPosition aPosition ) QucPosition aPosition
void	scale ( double xFactor = 1.0, double yFactor = 1.0, double zFactor = 1.0 ) double xFactor double yFactor double zFactor
double	x () const
double	y () const
double	z () const
void	print () const
QucPosition	operator+ ( QucPosition aPosition ) QucPosition aPosition
QucPosition	operator- ( QucPosition aPosition ) QucPosition aPosition
QucPosition	operator* ( QucPosition aPosition ) QucPosition aPosition
QucPosition	operator* ( double aScalar ) double aScalar
QucPosition	operator/ ( double aScalar ) double aScalar

QucPosition ( double anX, double aY, double aZ )

Purpose
The default c'tor.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double anX

initial x coordinate

double aY

initial y coordinate

double aZ

initial z coordinate

QucPosition ( const QucPosition & aRef )

Purpose
The copy c'tor creates a new instance from a reference.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucPosition & aRef

the reference instance

QucPosition & operator= ( const QucPosition & aRef )

Purpose
The assignment operator makes this instance look like another one.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
A reference to this instance.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucPosition & aRef

the reference instance

virtual ~QucPosition ()

Purpose
The d'tor.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

void rotateX ( double anAngle )

Purpose
Rotate this position around the x axis.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double anAngle

angle of rotation

void rotateY ( double anAngle )

Purpose
Rotate this position around the z axis.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double anAngle

angle of rotation

void rotateZ ( double anAngle )

Purpose
Rotate this position around the z axis.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double anAngle

angle of rotation

void translate ( QucPosition aPosition )

Purpose
Translate this position around another one.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucPosition aPosition

translation position

void scale ( double xFactor = 1.0, double yFactor = 1.0, double zFactor = 1.0 )

Purpose
Scale this position with respect to 0,0,0.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double xFactor

x scaling factor

double yFactor

y scaling factor

double zFactor

z scaling factor

double x () const

Purpose
Query the x coordinate.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
The x attribute of this instance.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

double y () const

Purpose
Query the y coordinate.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
The y attribute of this instance.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

double z () const

Purpose
query the z coordinate.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
The z attribute of this instance.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

void print () const

Purpose
Print out the coordinate attributes.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

QucPosition operator+ ( QucPosition aPosition )

Purpose
Add another position to this one.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
Return a position that equals this one plus another one.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucPosition aPosition

Another value

QucPosition operator- ( QucPosition aPosition )

Purpose
Subtract a position from this one.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
Return a position that equals this one minus another one.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucPosition aPosition

QucPosition operator* ( QucPosition aPosition )

Purpose
Multiply a position with this one.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
Return a position that equals this one times another one.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucPosition aPosition

factor

QucPosition operator* ( double aScalar )

Purpose
Multiply this position with a scalar.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
Return a position that equals this one times a scalar.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aScalar

factor

QucPosition operator/ ( double aScalar )

Purpose
Divide this position by a scalar.

Preconditions

• The scalar must not be 0.

Returns
Return a position that equals this one divided by a scalar.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aScalar

denominator

generated by doc++