All Frameworks Class Hierarchy This Framework Indexes Previous Next

Mathematics CATMathPlane

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

public class CATMathPlane

Class representing a mathematical plane in 3D.

It is composed of an Origin and of two normalized vectors FirstDirection and SecondDirection.

Constructor and Destructor Index

o CATMathPlane(): Constructs a plane where Origin=(0,0,0), FirstDirection=(1,0,0) and SecondDirection=(0,1,0) .
o CATMathPlane(CATMathPlane&): Copy constructor.
o CATMathPlane(CATCanonicalPlane): Constructs one of the three canonical plane with Origin=(0,0,0), FirstDirection=(1,0,0) and SecondDirection=(0,1,0) for CATMathPlaneOIJ .
o CATMathPlane(CATMathPoint&,CATMathVector&): Constructs a plane from a point and a normal.
o CATMathPlane(CATMathPoint&,CATMathPoint&,CATMathPoint&)
o CATMathPlane(CATMathPoint&,CATMathVector&,CATMathVector&)

Method Index

o DistanceTo(CATMathPoint&): Returns the distance between this CATMathPlane and a CATMathPoint.
o Dump(ostream*): Dumps this CATMathPlane.
o EvalPoint(double,double)
o EvalPoint(double,double,CATMathPoint&): Returns the point of this CATMathPlane corresponding to given parameters.
o GetDirections(CATMathVector&,CATMathVector&): Retrieves the orthonormalized directions of this CATMathPlane.
o GetFirstDirection()
o GetFirstDirection(CATMathVector&): Retrieves the first (normalized) direction of this CATMathPlane.
o GetNormal()
o GetNormal(CATMathVector&): Retrieves the (normalized) normal to this CATMathPlane.
o GetOrigin()
o GetOrigin(CATMathPoint&): Retrieves the origin of this CATMathPlane.
o GetSecondDirection()
o GetSecondDirection(CATMathVector&): Retrieves the second (normalized) direction of this CATMathPlane.
o Intersect(CATMathPlane&,CATMathLine&): Intersects this CATMathPlane with another one.
o Intersect(CATMathLine&,double&,double&,double&,double): Intersects this CATMathPlane with a CATMathLine.
o Project(CATMathPoint&,CATMathPoint&): Returns the projection of a CATMathPoint on a CATMathPlane.
o Project(CATMathPoint&,double&,double&): Retrieves the projection of a CATMathPoint on a CATMathPlane.
o Set(CATMathPoint&,CATMathPoint&,CATMathPoint&): Constructs a plane passing through three points.
o Set(CATMathPoint&,CATMathVector&,CATMathVector&): Constructs a plane from a point and two vectors.
o SetDirections(CATMathVector&,CATMathVector&)
o SetOrigin(CATMathPoint&): Modifies the origin of this CATMathPlane.
o SetVectors(CATMathVector&,CATMathVector&): Modifies the directions of this CATMathPlane.

Constructor and Destructor

o CATMathPlane

public CATMathPlane(

)

Constructs a plane where Origin=(0,0,0), FirstDirection=(1,0,0) and SecondDirection=(0,1,0) .

o CATMathPlane

public CATMathPlane( const iPlaneToCopy)

Copy constructor.

o CATMathPlane

public CATMathPlane( Plane)

Constructs one of the three canonical plane with Origin=(0,0,0), FirstDirection=(1,0,0) and SecondDirection=(0,1,0) for CATMathPlaneOIJ . FirstDirection=(0,1,0) and SecondDirection=(0,0,1) for CATMathPlaneOJK. FirstDirection=(0,0,1) and SecondDirection=(1,0,0) for CATMathPlaneOKI.

o CATMathPlane

public CATMathPlane(	const	`iOrigin`,
	const	`iNormal`)

Constructs a plane from a point and a normal.
The normal must not be null, but this is not checked.

o CATMathPlane

public CATMathPlane(	const	`iOrigin`,
	const	`iSecondPoint`,
	const	`iThirdPoint`)

Deprecated:: V5R15 Set Constructs a plane passing through three points.
Throws an error if the three points are aligned.

o CATMathPlane

public CATMathPlane(	const	`iOrigin`,
	const	`iFirstDirection`,
	const	`iSecondDirection`)

Deprecated:: V5R15 Set Constructs a plane from a point and two vectors.
Throws an error if the input vectors are colinear. The input vectors are used to compute the normalized and orthogonal directions of the plane.

Methods

o DistanceTo

public DistanceTo( const iPoint)

Returns the distance between this CATMathPlane and a CATMathPoint.

o Dump

public Dump( iStream =0L)

Dumps this CATMathPlane.
This writes the following lines on the ostream:

 Origin    = ( OriginFirstCoord    , OriginSecondCoord    , OriginThirdCoord )
 FirstDir  = ( FirstDirFirstCoord  , FirstDirSecondCoord  , FirstDirThirdCoord )
 SecondDir = ( SecondDirFirstCoord , SecondDirSecondCoord , SecondDirThirdCoord )

Parameters:

iStream: A pointer to the output. If 0L, the method dumps the coordinates on the cout output.

o EvalPoint

public EvalPoint(	const	`iBid1`,
	const	`iBid2`)

Deprecated:

V5R20 EvalPoint Returns the point of this CATMathPlane corresponding to given parameters. You should use preferably the

EvalPoint(const double iParam1, const double iParam2, CATMathPoint & ioResult

signature.

o EvalPoint

public EvalPoint(	const	`iParam1`,
	const	`iParam2`,
		`ioResult`)

Returns the point of this CATMathPlane corresponding to given parameters.

Returns:: ioResult=Plane.Origin + iParam1 * Plane.FirstDirection + iParam2 * Plane.SecondDirection

o GetDirections

public GetDirections(		`ioFirstDirection`,
		`ioSecondDirection`)

Retrieves the orthonormalized directions of this CATMathPlane.

o GetFirstDirection

public GetFirstDirection(

)

Deprecated:

V5R20 GetFirstDirection Retrieves the first (normalized) direction of this CATMathPlane. You should use preferably the

GetFirstDirection (CATMathVector & ioFirstDirection)

signature.

o GetFirstDirection

public GetFirstDirection( ioFirstDirection)

Retrieves the first (normalized) direction of this CATMathPlane.

o GetNormal

public GetNormal(

)

Deprecated:

V5R20 GetNormal Retrieves the (normalized) normal to this CATMathPlane. You should use preferably the

GetNormal (CATMathVector & ioNormal)

signature.

o GetNormal

public GetNormal( ioNormal)

Retrieves the (normalized) normal to this CATMathPlane.

o GetOrigin

public GetOrigin(

)

Deprecated:

V5R20 GetOrigin Retrieves the origin of this CATMathPlane. You should use preferably the

GetOrigin (CATMathPoint & ioOrigin)

signature.

o GetOrigin

public GetOrigin( ioOrigin)

Retrieves the origin of this CATMathPlane.

o GetSecondDirection

public GetSecondDirection(

)

Deprecated:

V5R20 GetSecondDirection Retrieves the fisecondrst (normalized) direction of this CATMathPlane. You should use preferably the

GetSecondDirection (CATMathVector & ioFirstDirection)

signature.

o GetSecondDirection

public GetSecondDirection( ioSecondDirection)

Retrieves the second (normalized) direction of this CATMathPlane.

o Intersect

public Intersect(	const	`iOtherPlane`,
		`ioIntersectionLine`)

Intersects this CATMathPlane with another one.

Parameters:

iOtherPlane: The other CATMathPlane to intersect.
ioIntersectionLine: The resulting CATMathLine.

Returns:

0: if there is no intersection
1: if there is an intersection
2: if they are identical

o Intersect

public Intersect(	const	`iLine`,
		`ioParamOnLine`,
		`ioFirstParamOnPlane`,
		`ioSecondParamOnPlane`,
		`iTol`	`=CATGetDefaultTolerance().EpsgForRelativeTest()`)

Intersects this CATMathPlane with a CATMathLine.

Parameters:

iLine: The CATMathLine to intersect.
ioParamOnLine: The parameter of the intersection on the line.
ioFirstParamOnThis: The parameter of the intersection on this CATMathPlane.
ioSecondParamOnThis: The parameter of the intersection on the second direction of this CATMathPlane.
iTol: The default tolerance.

Returns:

0: if there is no intersection
1: if there is an intersection
2: if the line is included in the plane

o Project

public Project(	const	`iPointToProject`,
		`ioResult`)

Returns the projection of a CATMathPoint on a CATMathPlane.

o Project

public Project(	const	`iPointToProject`,
		`ioFirstParamOnPlane`,
		`ioSecondParamOnPLane`)

Retrieves the projection of a CATMathPoint on a CATMathPlane.

Parameters:

ioFirstParamOnPlane: The parameter of the projection on the first direction of the plane.
ioSecondParamOnPlane: The parameter of the projection on second direction of the plane.

o Set

public Set(	const	`iOrigin`,
	const	`iSecondPoint`,
	const	`iThirdPoint`)

Constructs a plane passing through three points.

Returns:: E_FAIL if the three points are aligned, S_OK otherwise.

o Set

public Set(	const	`iOrigin`,
	const	`iFirstDirection`,
	const	`iSecondDirection`)

Constructs a plane from a point and two vectors. The input vectors are used to compute the normalized and orthogonal directions of the plane.

Returns:: E_FAIL if the input vectors are colinear, S_OK otherwise.

o SetDirections

public SetDirections(	const	`iFirstDirection`,
	const	`iSecondDirection`)

Deprecated:: V5R15 SetVectors Modifies the directions of this CATMathPlane.
Throws an error if the new directions are colinear.
Returns:: FALSE if the new directions are colinear, TRUE otherwise.

o SetOrigin

public SetOrigin( const iOrigin)

Modifies the origin of this CATMathPlane.

o SetVectors

public SetVectors(	const	`iFirstDirection`,
	const	`iSecondDirection`)

Modifies the directions of this CATMathPlane.

Returns:: E_FAIL if the new directions are colinear, S_OK otherwise.

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

Mathematics writeClassCharacteristic(); CATMathPlane

Constructor and Destructor Index

Method Index

Constructor and Destructor

Methods

Mathematics CATMathPlane