Mathematics CATMathPoint2D
Usage: you must use this class as is. You should never derive it.
public class CATMathPoint2D
Class representing a mathematical cartesian point in dimension 2.
Constructor and Destructor Index
- o
CATMathPoint2D()
- Constructs a CATMathPoint2D with (0,0) coordinates.
- o
CATMathPoint2D(double[])
- Constructs a CATMathPoint2D from an array of 2 coordinates.
- o
CATMathPoint2D(double,double)
- Constructs a CATMathPoint2D from 2 coordinates.
- o
CATMathPoint2D(CATMathPoint2D&)
- Copy constructor.
Method Index
- o
DistanceTo(CATMathPoint2D&)
- Returns the distance this CAMathPoint2D and another CATMathPoint2D.
- o
GetCoord(double[])
- Retrieves the coordinates of this CATMathPoint2D in an array of 2 doubles.
- o
GetCoord(double&,double&)
- Retrieves the coordinates of this CATMathPoint2D.
- o
GetX()
- Returns the X coordinate of this CATMathPoint2D.
- o
GetY()
- Returns the Y coordinate of this CATMathPoint2D.
- o
SetCoord(double[])
- Modifies the coordinates of this CATMathPoint2D from an array of 2 values.
- o
SetCoord(double,double)
- Modifies the coordinates of this CATMathPoin2D from 2 doubles.
- o
SetX(double)
- Modifies the X coordinate of this CATMathPoint2D.
- o
SetY(double)
- Modifies the Y coordinate of this CATMathPoint2D.
- o
SquareDistanceTo(CATMathPoint2D&)
- Returns the square distance between this CAMathPoint2D and another CATMathPoint2D.
- o
operator *(double)
- Defines the right side scalar multiplication.
- o
operator *(double,CATMathPoint2D&)
- Defines the left side scalar multiplication.
- o
operator +(CATMathVector2D&)
- Translates a CATMathPoint2D by a CATMathVector2D.
- o
operator -(CATMathPoint2D&)
- Builds a CATMathVector2D as the difference of two CATMathPoint2Ds.
- o
operator -(CATMathVector2D&)
- Translates a CATMathPoint2D by a CATMathVector2D.
- o
operator /(double)
- Defines the scalar division.
Constructor and Destructor
o CATMathPoint2D
-
Constructs a CATMathPoint2D with (0,0) coordinates.
o CATMathPoint2D
| public CATMathPoint2D( | const | iCoord) |
-
Constructs a CATMathPoint2D from an array of 2 coordinates.
o CATMathPoint2D
| public CATMathPoint2D( | const | iX, |
| const | iY) |
-
Constructs a CATMathPoint2D from 2 coordinates.
o CATMathPoint2D
| public CATMathPoint2D( | const | iPointToCopy) |
-
Copy constructor.
Methods
o DistanceTo
| public DistanceTo( | const | iOtherPoint) |
-
Returns the distance this CAMathPoint2D and another CATMathPoint2D.
o GetCoord
-
Retrieves the coordinates of this CATMathPoint2D in an array of 2 doubles.
o GetCoord
| public GetCoord( | | ioX, |
| | ioY) |
-
Retrieves the coordinates of this CATMathPoint2D.
o GetX
-
Returns the X coordinate of this CATMathPoint2D.
o GetY
-
Returns the Y coordinate of this CATMathPoint2D.
o SetCoord
| public SetCoord( | const | iCoord) |
-
Modifies the coordinates of this CATMathPoint2D from an array of 2 values.
o SetCoord
| public SetCoord( | const | iX, |
| const | iY) |
-
Modifies the coordinates of this CATMathPoin2D from 2 doubles.
o SetX
-
Modifies the X coordinate of this CATMathPoint2D.
o SetY
-
Modifies the Y coordinate of this CATMathPoint2D.
o SquareDistanceTo
| public SquareDistanceTo( | const | iOtherPoint) |
-
Returns the square distance between this CAMathPoint2D and another CATMathPoint2D.
o operator *
| public operator *( | | iScalar) |
-
Defines the right side scalar multiplication.
- Parameters:
-
- iPoint
- The CATMathPoint2D of (p1,p2,p3) coordinates.
- iScalar
- The scalar.
- Returns:
- The CATMathPoint2D of (p1*iScalar,p2*iScalar,p3*iScalar) coordinates.
o operator *
| public operator *( | | iScalar, |
| const | iPoint) |
-
Defines the left side scalar multiplication.
- Parameters:
-
- iScalar
- The scalar.
- iPoint
- The CATMathPoint2D of (p1,p2,p3) coordinates.
- Returns:
- The CATMathPoint2D of (iScalar*p1,iScalar*p2,iScalar*p3) coordinates.
o operator +
| public operator +( | const | iTranslationVector) |
-
Translates a CATMathPoint2D by a CATMathVector2D.
- Parameters:
-
- iPoint
- The CATMathPoint2D of (p1,p2) coordinates.
- iVector
- The CATMathVector2D of (u1,u2) coordinates.
- Returns:
- The CATMathPoint2D of (p1+u1,p2+u2) coordinates.
o operator -
| public operator -( | const | iPoint2) |
-
Builds a CATMathVector2D as the difference of two CATMathPoint2Ds.
Note that the iPoint1iPoint2 vector is given by iPoint2-iPoint1.
- Parameters:
-
- iPoint1
- The CATMathPoint2D of (p1,p2) coordinates.
- iPoint2
- The CATMathPoint2D of (q1,q2) coordinates.
- Returns:
- The CATMathVector2D of (p1-q1,p2-q2) coordinates.
o operator -
| public operator -( | const | iTranslationVector) |
-
Translates a CATMathPoint2D by a CATMathVector2D.
- Parameters:
-
- iPoint
- The CATMathPoint2D of (p1,p2) coordinates.
- iVector
- The CATMathVector2D of (u1,u2) coordinates.
- Returns:
- The CATMathPoint2D of (p1-u1,p2-u2) coordinates.
o operator /
| public operator /( | | iScalar) |
-
Defines the scalar division.
- Parameters:
-
- iPoint
- The CATMathPoint2D of (p1,p2,p3) coordinates.
- iScalar
- The scalar.
- Returns:
- The CATMathPoint2D of (p1/iScalar,p2/iScalar,p3/iScalar) coordinates.
This object is included in the file: CATMathPoint2D.h
If needed, your Imakefile.mk should include the module: CATMathematics
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.