class QucDirection : public CorPersistent

a 3D direction

Inheritance:

public members:

	QucDirection ( double alphaAngle = 0, double gammaAngle = 0, double tauAngle = 0 ) double alphaAngle double gammaAngle double tauAngle
	QucDirection ( const QucDirection & aRef ) const QucDirection & aRef
QucDirection &	operator= ( const QucDirection & aRef ) const QucDirection & aRef
virtual	~QucDirection ()
QucPosition	project ()
void	unproject ( QucPosition aPosition ) QucPosition aPosition
void	rotate ( QucDirection aDirection ) QucDirection aDirection
void	unrotate ( QucDirection aDirection ) QucDirection aDirection
double	alpha () const
double	gamma () const
double	alphaP () const
double	gammaP () const
double	tau () const
void	print () const
virtual CorStream&	operator<< ( CorStream& aStream ) const CorStream& aStream
virtual CorStream&	operator>> ( CorStream& aStream ) CorStream& aStream

SYNOPSIS

    #include <QucDirection.h>
  
    QucDirection myObject;
  

DESCRIPTION
This class models a three dimensional direction through 2 angles.

CAUTIONS
<optional>

EXAMPLES
<optional>

SEE ALSO
<optional>
QucPosition

QucDirection ( double alphaAngle = 0, double gammaAngle = 0, double tauAngle = 0 )

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 alphaAngle

double gammaAngle

double tauAngle

QucDirection ( const QucDirection & 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 QucDirection & aRef

the reference instance

QucDirection & operator= ( const QucDirection & 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 QucDirection & aRef

the reference instance

virtual ~QucDirection ()

Purpose
The d'tor.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

QucPosition project ()

Purpose
Project this direction.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the projected position.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

void unproject ( QucPosition aPosition )

Purpose
Undo a projection of a given position.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucPosition aPosition

position to unproject around

void rotate ( QucDirection aDirection )

Purpose
Rotate a floop by a given direction.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucDirection aDirection

direction to rotate around

void unrotate ( QucDirection aDirection )

Purpose
Rotate a floop anti-clockwise by a given direction.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucDirection aDirection

direction to unrotate around

double alpha () const

Purpose
Query the alpha angle.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the alpha angle of this direction.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

double gamma () const

Purpose
Query the gamma angle.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the gamma angle of this direction.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

double alphaP () const

Purpose
Query the projected alpha angle.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the projected alpha angle of this direction.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

double gammaP () const

Purpose
Query the projected gamma angle.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the projected gamma angle of this direction.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

double tau () const

Purpose
Query the tau angle.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the tau angle of this direction.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

void print () const

Purpose
Print out the angles of this instance.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

virtual CorStream& operator<< ( CorStream& aStream ) const

Purpose
Write this instance to a stream.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the adjusted stream.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorStream& aStream

stream to save to

virtual CorStream& operator>> ( CorStream& aStream )

Purpose
Read this instance from a stream.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the adjusted stream.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

CorStream& aStream

stream to read from

generated by doc++