class QucOpticalRay : public CorBase

a model of a ray of light

Inheritance:

public members:

	QucOpticalRay ()
	QucOpticalRay ( const QucOpticalRay & aRef ) const QucOpticalRay & aRef
QucOpticalRay &	operator= ( const QucOpticalRay & aRef ) const QucOpticalRay & aRef
CorBool	operator== ( const QucOpticalRay & aRef ) const const QucOpticalRay & aRef
CorBool	operator!= ( const QucOpticalRay & aRef ) const const QucOpticalRay & aRef
virtual	~QucOpticalRay ()
double	getU ( QucUnitType aType = QucDirectionalAngleUnit ) const QucUnitType aType
double	getV ( QucUnitType aType = QucDirectionalAngleUnit ) const QucUnitType aType
double	getX ( QucUnitType aType = QucTangentialProjectionUnit ) const QucUnitType aType
double	getY ( QucUnitType aType = QucTangentialProjectionUnit ) const QucUnitType aType
double	getTime ( QucUnitType aType = QucTimeUnit ) const QucUnitType aType
double	getWavelength ( QucUnitType aType = QucWaveLengthUnit ) const QucUnitType aType
double	getIntensity ( QucUnitType aType = QucIntensityUnit ) const QucUnitType aType
void	setIntensity ( double anIntensity ) double anIntensity
void	setWavelength ( double aWaveLength ) double aWaveLength
void	setXY ( double anIntensity = 1, double anX = 0, double aY = 0, double aWaveLength = 550, double aTime = 0 ) double anIntensity double anX double aY double aWaveLength double aTime
void	setUV ( double anIntensity = 1, double aU = 0, double aV = 0, double aWaveLength = 550, double aTime = 0 ) double anIntensity double aU double aV double aWaveLength double aTime
void	scale ( double aU = 0, double aV = 0, double aX = 0, double aY = 0, double aWaveLength = 5500, double aTime = 0, double anIntensity = 1 ) double aU double aV double aX double aY double aWaveLength double aTime double anIntensity

protected members:

virtual void

become ( const QucOpticalRay & aRef ) const QucOpticalRay & aRef

QucOpticalRay ()

Purpose
The default c'tor.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

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

the reference instance

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

the reference instance

CorBool operator== ( const QucOpticalRay & aRef ) const

Purpose
Check if two instances hold the same attributes.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns corTRUE if this instance is indeed equal to a reference instance.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucOpticalRay & aRef

the reference instance

CorBool operator!= ( const QucOpticalRay & aRef ) const

Purpose
Check if two instances hold the same attributes.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns corTRUE if this instance is not equal to a reference instance.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucOpticalRay & aRef

the reference instance

virtual ~QucOpticalRay ()

Purpose
The d'tor.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

double getU ( QucUnitType aType = QucDirectionalAngleUnit ) const

Purpose
Query the u direction angle (with respect to a unit type).

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the value of the u direction of this instance.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucUnitType aType

unit type to consider

double getV ( QucUnitType aType = QucDirectionalAngleUnit ) const

Purpose
Query the v direction angle (with respect to a unit type).

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the value of the v direction of this instance.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucUnitType aType

unit type to consider

double getX ( QucUnitType aType = QucTangentialProjectionUnit ) const

Purpose
Query the x tangent (with respect to a unit type).

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the value of the x tangent of this instance.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucUnitType aType

unit type to consider

double getY ( QucUnitType aType = QucTangentialProjectionUnit ) const

Purpose
Query the y tangent (with respect to a unit type).

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the value of the y tangent of this instance.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucUnitType aType

unit type to consider

double getTime ( QucUnitType aType = QucTimeUnit ) const

Purpose
Query the time of impact (with respect to a unit type).

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the time of impact.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucUnitType aType

time unit type

double getWavelength ( QucUnitType aType = QucWaveLengthUnit ) const

Purpose
Query the wavelength of this beam (wit respect to a unit type).

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the wavelength of this instance.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucUnitType aType

unit type to consider

double getIntensity ( QucUnitType aType = QucIntensityUnit ) const

Purpose
Query the intensity of this beam (with respect to a unit type).

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the intensity of this beam.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

QucUnitType aType

unit type to consider

void setIntensity ( double anIntensity )

Purpose
Set the intensity of this instance.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double anIntensity

new intensity value

void setWavelength ( double aWaveLength )

Purpose
Set the wavelenght of this instance.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aWaveLength

new wave length value

void setXY ( double anIntensity = 1, double anX = 0, double aY = 0, double aWaveLength = 550, double aTime = 0 )

Purpose
Set the components of the optical ray using the XY direction representation. UV are computed automatically.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double anIntensity

new intensity value

double anX

new x tangent

double aY

new y tangent

double aWaveLength

new wavelength, in nm

double aTime

new time, in seconds

void setUV ( double anIntensity = 1, double aU = 0, double aV = 0, double aWaveLength = 550, double aTime = 0 )

Purpose
Set the components of the optical ray using the UV direction representation. XY are computed automatically.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double anIntensity

new intensity value

double aU

new u direction, in degrees

double aV

new v direction, in degrees

double aWaveLength

new wavelength, in nm

double aTime

new time, in seconds

void scale ( double aU = 0, double aV = 0, double aX = 0, double aY = 0, double aWaveLength = 5500, double aTime = 0, double anIntensity = 1 )

Purpose
Apply the following scaling factors to the components of the optical ray.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

double aU

scaling factor for u direction

double aV

scaling factor for v direction

double aX

scaling factor for u direction

double aY

scaling factor for v direction

double aWaveLength

scaling factor for wave length

double aTime

scaling factor for time

double anIntensity

scaling factor for intensity value

virtual void become ( const QucOpticalRay & aRef )

Purpose
This instance will look like another one.

Preconditions

• Itemize this section if necessary. Remove itemization otherwise.

Exceptions

• Itemize this section if necessary. Remove itemization otherwise.

Arguments

const QucOpticalRay & aRef

reference instance

this class has no child classes.

generated by doc++