All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

Mathematics Class CATMathAxis2D

CATMathAxis2D
 

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


public class CATMathAxis2D

Class representing a mathematical axis system in dimension 2.
Role:
It is composed of an Origin, and of two directions (normalized vectors) FirstDirection, SecondDirection. If the two directions are not directly orthogonal or normalized, it will be done internally.


Constructor and Destructor Index


o CATMathAxis2D()
Constructs a canonical CATMathAxis2D.
o CATMathAxis2D(CATMathAxis2D&)
Copy constructor.
o CATMathAxis2D(CATMathPoint2D&,CATMathVector2D&,CATMathVector2D&)
Constructs CATMathAxis2D from a CATMathPoint2D and two CATMathVector2D.

Method Index


o GetDirections(CATMathVector2D&,CATMathVector2D&)
Retrieves the two (orthonormalized) directions of this CATMathAxis2D.
o GetFirstDirection(CATMathVector2D&)
Returns the first (normalized) direction of this CATMathAxis2D.
o GetOrigin(CATMathPoint2D&)
Returns the origin of this CATMathAxis2D.
o GetSecondDirection(CATMathVector2D&)
Returns the second (normalized) direction of this CATMathAxis2D.
o SetDirections(CATMathVector2D&,CATMathVector2D&)
Modifies the directions of this CATMathAxis2D.
o SetOrigin(CATMathPoint2D&)
Modifies the origin of this CATMathAxis2D.

Constructor and Destructor


o CATMathAxis2D
public CATMathAxis2D()
Constructs a canonical CATMathAxis2D.
Origin=(0,0), FirstDirection = (1,0), SecondDirection =(0,1).
o CATMathAxis2D
public CATMathAxis2D( const CATMathAxis2D& iAxisToCopy)
Copy constructor.
o CATMathAxis2D
public CATMathAxis2D( const CATMathPoint2D& iOrigin,
const CATMathVector2D& iFirstDirection,
const CATMathVector2D& iSecondDirection)
Constructs CATMathAxis2D from a CATMathPoint2D and two CATMathVector2D.
The input vectors must not be colinear, but this is not checked.

Methods


o GetDirections
public void GetDirections(CATMathVector2D& ioFirstDirection,
CATMathVector2D& ioSecondDirection) const
Retrieves the two (orthonormalized) directions of this CATMathAxis2D.
o GetFirstDirection
public void GetFirstDirection(CATMathVector2D& ioFirstDirection) const
Returns the first (normalized) direction of this CATMathAxis2D.
o GetOrigin
public void GetOrigin(CATMathPoint2D& ioOrigin) const
Returns the origin of this CATMathAxis2D.
o GetSecondDirection
public void GetSecondDirection(CATMathVector2D& ioSecondDirection) const
Returns the second (normalized) direction of this CATMathAxis2D.
o SetDirections
public CATBoolean SetDirections( const CATMathVector2D& iFirstDirection,
const CATMathVector2D& iSecondDirection)
Modifies the directions of this CATMathAxis2D.
Returns:
FALSE if the input vectors are colinear, TRUE otherwise.
o SetOrigin
public void SetOrigin( const CATMathPoint2D& iOrigin)
Modifies the origin of this CATMathAxis2D.

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

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