All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

Mathematics Class CATMathDirection

Mathematics.CATMathVector
  |
  +---CATMathDirection
 

Usage: you must use this class as is. You should never derive it.


public class CATMathDirection

Class defining a normalized vector.
Use now CATMathVector directly and normalize if needed.


Constructor and Destructor Index


o CATMathDirection()
Constructs a (1,0,0) vector.
o CATMathDirection(CATMathDirection&)
Copy constructor.
o CATMathDirection(CATMathVector&)
Constructs from a CATMathVector.
o CATMathDirection(double,double,double)
Constructs a direction from coordinates.

Method Index


o Norm()
Returns the euclidean norm.
o SetCoord(double,double,double)
Modifies the direction coordinates from three doubles.
o SetCoord(double[])
Modifies the direction coordinates from an array of three doubles.
o SetCylindricalCoord(double,CATAngle,double)
Modifies this CATMathDirection with cylindrical coordinates.
o SetSphericalCoord(double,CATAngle,CATAngle)
Modifies this CATMathDirection with spherical coordinates.
o SetX(double)
Modifies the direction first coordinate.
o SetY(double)
Modifies the direction second coordinate.
o SetZ(double)
Modifies the direction third coordinate.
o SquareNorm()
Returns the square of the euclidean norm.
o operator -(CATMathDirection&)
Defines the opposite of this CATMathDirection.

Constructor and Destructor


o CATMathDirection
public INLINE CATMathDirection()
Constructs a (1,0,0) vector.
o CATMathDirection
public INLINE CATMathDirection( const CATMathDirection& iDirectionToCopy)
Copy constructor.
o CATMathDirection
public INLINE CATMathDirection( const CATMathVector& iVector)
Constructs from a CATMathVector.
o CATMathDirection
public INLINE CATMathDirection( const double iFirstCoord,
const double iSecondCoord,
const double iThirdCoord)
Constructs a direction from coordinates.

Methods


o Norm
public double Norm()const
Returns the euclidean norm.
o SetCoord
public INLINE void SetCoord( const double iFirstCoord,
const double iSecondCoord,
const double iThirdCoord)
Modifies the direction coordinates from three doubles.
o SetCoord
public INLINE void SetCoord( const double[] iCoord)
Modifies the direction coordinates from an array of three doubles.
o SetCylindricalCoord
public void SetCylindricalCoord( const double iRadius,
const CATAngle iAngle,
const double iHeight)
Modifies this CATMathDirection with cylindrical coordinates.
iAngle is expressed in radians.
o SetSphericalCoord
public void SetSphericalCoord( const double iRadius,
const CATAngle iLongitudeAngle,
const CATAngle iLatitudeAngle)
Modifies this CATMathDirection with spherical coordinates.
iLongitudeAngle and iLatitudeAngle are expressed in radians.
o SetX
public INLINE void SetX( const double iFirstCoord)
Modifies the direction first coordinate.
o SetY
public INLINE void SetY( const double iSecondCoord)
Modifies the direction second coordinate.
o SetZ
public INLINE void SetZ( const double iThirdCoord)
Modifies the direction third coordinate.
o SquareNorm
public double SquareNorm()const
Returns the square of the euclidean norm.
o operator -
public INLINE friend CATMathDirection operator -( const CATMathDirection& iDirection)
Defines the opposite of this CATMathDirection.
Parameters:
iDirection
The CATMathDirection of (u1,u2,u3) coordinates.
Returns:
The CATMathDirection of (-u1,-u2,-u3) coordinates.

This object is included in the file: CATMathDirection.h
If needed, your Imakefile.mk should include the module: CATMathematics

Copyright © 2003, Dassault Systèmes. All rights reserved.