GeometricObjects Interface CATPlane

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATPlane

Interface representing a geometrical plane.

The CATPlane is created by the CreatePlane method of the CATGeoFactory interface and deleted with the Remove method.
A CATPlane is defined with:
CATMathPoint Origin The plane origin
CATMathDirection FirstDirection The first normalized direction
CATMathDirection SecondDirection The second normalized direction, othogonal to the first one
CATSurLimits Limits The limitations if needed

Method Index


o GetAxis()
Retrieves the mathematical plane representing this CATPlane.
o GetAxis(CATMathPlane&)
Retrieves the mathematical plane representing this CATPlane.
o GetAxis(CATMathPoint&,CATMathDirection&,CATMathDirection&)
Retrieves the origin and the two orthonormalized directions of this CATPlane.
o GetNormal(CATMathPoint&,CATMathVector&)
Retrieves the origin and the normal of this CATPlane.
o SetAxis(CATMathPlane&)
Modifies the characteristics of this CATPlane.

Methods


o GetAxis
public virtual CATMathPlane GetAxis()const = 0
Retrieves the mathematical plane representing this CATPlane. Use preferably the signature which returns the CATMathPlane in output argument.
Returns:
The corresponding mathematical definition.
o GetAxis
public virtual void GetAxis(CATMathPlane& ioMathPlane) const = 0
Retrieves the mathematical plane representing this CATPlane.
Parameters:
ioMathPlane
The corresponding mathematical definition.
o GetAxis
public virtual void GetAxis(CATMathPoint& ioOrigin,
CATMathDirection& ioFirstDirection,
CATMathDirection& ioSecondDirection)const = 0
Retrieves the origin and the two orthonormalized directions of this CATPlane.
Parameters:
ioOrigin
The origin.
ioFirstDirection
The first normalized direction.
ioSecondDirection
The second orhto-normalized direction.
o GetNormal
public virtual void GetNormal(CATMathPoint& ioOrigin,
CATMathVector& ioNormal) const = 0
Retrieves the origin and the normal of this CATPlane.
Parameters:
ioOrigin
The origin.
ioNormal
The normal.
o SetAxis
public virtual void SetAxis( const CATMathPlane& iPlaneToCopy) = 0
Modifies the characteristics of this CATPlane.
Parameters:
iPlaneToCopy
The new mathematical definition.
This object is included in the file: CATPlane.h
If needed, your Imakefile.mk should include the module: CATGMGeometricInterfaces

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.