Open CASCADE Technology  7.6.0.dev
Public Member Functions

gp_Elips Class Reference

Describes an ellipse in 3D space. An ellipse is defined by its major and minor radii and positioned in space with a coordinate system (a gp_Ax2 object) as follows: More...

#include <gp_Elips.hxx>

Public Member Functions

 gp_Elips ()
 Creates an indefinite ellipse. More...
 
 gp_Elips (const gp_Ax2 &theA2, const Standard_Real theMajorRadius, const Standard_Real theMinorRadius)
 The major radius of the ellipse is on the "XAxis" and the minor radius is on the "YAxis" of the ellipse. The "XAxis" is defined with the "XDirection" of theA2 and the "YAxis" is defined with the "YDirection" of theA2. Warnings : It is not forbidden to create an ellipse with theMajorRadius = theMinorRadius. Raises ConstructionError if theMajorRadius < theMinorRadius or theMinorRadius < 0. More...
 
void SetAxis (const gp_Ax1 &theA1)
 Changes the axis normal to the plane of the ellipse. It modifies the definition of this plane. The "XAxis" and the "YAxis" are recomputed. The local coordinate system is redefined so that: More...
 
void SetLocation (const gp_Pnt &theP)
 Modifies this ellipse, by redefining its local coordinate so that its origin becomes theP. More...
 
void SetMajorRadius (const Standard_Real theMajorRadius)
 The major radius of the ellipse is on the "XAxis" (major axis) of the ellipse. Raises ConstructionError if theMajorRadius < MinorRadius. More...
 
void SetMinorRadius (const Standard_Real theMinorRadius)
 The minor radius of the ellipse is on the "YAxis" (minor axis) of the ellipse. Raises ConstructionError if theMinorRadius > MajorRadius or MinorRadius < 0. More...
 
void SetPosition (const gp_Ax2 &theA2)
 Modifies this ellipse, by redefining its local coordinate so that it becomes theA2. More...
 
Standard_Real Area () const
 Computes the area of the Ellipse. More...
 
const gp_Ax1Axis () const
 Computes the axis normal to the plane of the ellipse. More...
 
gp_Ax1 Directrix1 () const
 Computes the first or second directrix of this ellipse. These are the lines, in the plane of the ellipse, normal to the major axis, at a distance equal to MajorRadius/e from the center of the ellipse, where e is the eccentricity of the ellipse. The first directrix (Directrix1) is on the positive side of the major axis. The second directrix (Directrix2) is on the negative side. The directrix is returned as an axis (gp_Ax1 object), the origin of which is situated on the "X Axis" of the local coordinate system of this ellipse. Exceptions Standard_ConstructionError if the eccentricity is null (the ellipse has degenerated into a circle). More...
 
gp_Ax1 Directrix2 () const
 This line is obtained by the symmetrical transformation of "Directrix1" with respect to the "YAxis" of the ellipse. Exceptions Standard_ConstructionError if the eccentricity is null (the ellipse has degenerated into a circle). More...
 
Standard_Real Eccentricity () const
 Returns the eccentricity of the ellipse between 0.0 and 1.0 If f is the distance between the center of the ellipse and the Focus1 then the eccentricity e = f / MajorRadius. Raises ConstructionError if MajorRadius = 0.0. More...
 
Standard_Real Focal () const
 Computes the focal distance. It is the distance between the two focus focus1 and focus2 of the ellipse. More...
 
gp_Pnt Focus1 () const
 Returns the first focus of the ellipse. This focus is on the positive side of the "XAxis" of the ellipse. More...
 
gp_Pnt Focus2 () const
 Returns the second focus of the ellipse. This focus is on the negative side of the "XAxis" of the ellipse. More...
 
const gp_PntLocation () const
 Returns the center of the ellipse. It is the "Location" point of the coordinate system of the ellipse. More...
 
Standard_Real MajorRadius () const
 Returns the major radius of the ellipse. More...
 
Standard_Real MinorRadius () const
 Returns the minor radius of the ellipse. More...
 
Standard_Real Parameter () const
 Returns p = (1 - e * e) * MajorRadius where e is the eccentricity of the ellipse. Returns 0 if MajorRadius = 0. More...
 
const gp_Ax2Position () const
 Returns the coordinate system of the ellipse. More...
 
gp_Ax1 XAxis () const
 Returns the "XAxis" of the ellipse whose origin is the center of this ellipse. It is the major axis of the ellipse. More...
 
gp_Ax1 YAxis () const
 Returns the "YAxis" of the ellipse whose unit vector is the "X Direction" or the "Y Direction" of the local coordinate system of this ellipse. This is the minor axis of the ellipse. More...
 
void Mirror (const gp_Pnt &theP)
 
gp_Elips Mirrored (const gp_Pnt &theP) const
 Performs the symmetrical transformation of an ellipse with respect to the point theP which is the center of the symmetry. More...
 
void Mirror (const gp_Ax1 &theA1)
 
gp_Elips Mirrored (const gp_Ax1 &theA1) const
 Performs the symmetrical transformation of an ellipse with respect to an axis placement which is the axis of the symmetry. More...
 
void Mirror (const gp_Ax2 &theA2)
 
gp_Elips Mirrored (const gp_Ax2 &theA2) const
 Performs the symmetrical transformation of an ellipse with respect to a plane. The axis placement theA2 locates the plane of the symmetry (Location, XDirection, YDirection). More...
 
void Rotate (const gp_Ax1 &theA1, const Standard_Real theAng)
 
gp_Elips Rotated (const gp_Ax1 &theA1, const Standard_Real theAng) const
 Rotates an ellipse. theA1 is the axis of the rotation. theAng is the angular value of the rotation in radians. More...
 
void Scale (const gp_Pnt &theP, const Standard_Real theS)
 
gp_Elips Scaled (const gp_Pnt &theP, const Standard_Real theS) const
 Scales an ellipse. theS is the scaling value. More...
 
void Transform (const gp_Trsf &theT)
 
gp_Elips Transformed (const gp_Trsf &theT) const
 Transforms an ellipse with the transformation theT from class Trsf. More...
 
void Translate (const gp_Vec &theV)
 
gp_Elips Translated (const gp_Vec &theV) const
 Translates an ellipse in the direction of the vector theV. The magnitude of the translation is the vector's magnitude. More...
 
void Translate (const gp_Pnt &theP1, const gp_Pnt &theP2)
 
gp_Elips Translated (const gp_Pnt &theP1, const gp_Pnt &theP2) const
 Translates an ellipse from the point theP1 to the point theP2. More...
 

Detailed Description

Describes an ellipse in 3D space. An ellipse is defined by its major and minor radii and positioned in space with a coordinate system (a gp_Ax2 object) as follows:

Constructor & Destructor Documentation

◆ gp_Elips() [1/2]

gp_Elips::gp_Elips ( )
inline

Creates an indefinite ellipse.

◆ gp_Elips() [2/2]

gp_Elips::gp_Elips ( const gp_Ax2 theA2,
const Standard_Real  theMajorRadius,
const Standard_Real  theMinorRadius 
)
inline

The major radius of the ellipse is on the "XAxis" and the minor radius is on the "YAxis" of the ellipse. The "XAxis" is defined with the "XDirection" of theA2 and the "YAxis" is defined with the "YDirection" of theA2. Warnings : It is not forbidden to create an ellipse with theMajorRadius = theMinorRadius. Raises ConstructionError if theMajorRadius < theMinorRadius or theMinorRadius < 0.

Member Function Documentation

◆ Area()

Standard_Real gp_Elips::Area ( ) const
inline

Computes the area of the Ellipse.

◆ Axis()

const gp_Ax1& gp_Elips::Axis ( ) const
inline

Computes the axis normal to the plane of the ellipse.

◆ Directrix1()

gp_Ax1 gp_Elips::Directrix1 ( ) const
inline

Computes the first or second directrix of this ellipse. These are the lines, in the plane of the ellipse, normal to the major axis, at a distance equal to MajorRadius/e from the center of the ellipse, where e is the eccentricity of the ellipse. The first directrix (Directrix1) is on the positive side of the major axis. The second directrix (Directrix2) is on the negative side. The directrix is returned as an axis (gp_Ax1 object), the origin of which is situated on the "X Axis" of the local coordinate system of this ellipse. Exceptions Standard_ConstructionError if the eccentricity is null (the ellipse has degenerated into a circle).

◆ Directrix2()

gp_Ax1 gp_Elips::Directrix2 ( ) const
inline

This line is obtained by the symmetrical transformation of "Directrix1" with respect to the "YAxis" of the ellipse. Exceptions Standard_ConstructionError if the eccentricity is null (the ellipse has degenerated into a circle).

◆ Eccentricity()

Standard_Real gp_Elips::Eccentricity ( ) const
inline

Returns the eccentricity of the ellipse between 0.0 and 1.0 If f is the distance between the center of the ellipse and the Focus1 then the eccentricity e = f / MajorRadius. Raises ConstructionError if MajorRadius = 0.0.

◆ Focal()

Standard_Real gp_Elips::Focal ( ) const
inline

Computes the focal distance. It is the distance between the two focus focus1 and focus2 of the ellipse.

◆ Focus1()

gp_Pnt gp_Elips::Focus1 ( ) const
inline

Returns the first focus of the ellipse. This focus is on the positive side of the "XAxis" of the ellipse.

◆ Focus2()

gp_Pnt gp_Elips::Focus2 ( ) const
inline

Returns the second focus of the ellipse. This focus is on the negative side of the "XAxis" of the ellipse.

◆ Location()

const gp_Pnt& gp_Elips::Location ( ) const
inline

Returns the center of the ellipse. It is the "Location" point of the coordinate system of the ellipse.

◆ MajorRadius()

Standard_Real gp_Elips::MajorRadius ( ) const
inline

Returns the major radius of the ellipse.

◆ MinorRadius()

Standard_Real gp_Elips::MinorRadius ( ) const
inline

Returns the minor radius of the ellipse.

◆ Mirror() [1/3]

void gp_Elips::Mirror ( const gp_Ax1 theA1)

◆ Mirror() [2/3]

void gp_Elips::Mirror ( const gp_Ax2 theA2)

◆ Mirror() [3/3]

void gp_Elips::Mirror ( const gp_Pnt theP)

◆ Mirrored() [1/3]

gp_Elips gp_Elips::Mirrored ( const gp_Ax1 theA1) const

Performs the symmetrical transformation of an ellipse with respect to an axis placement which is the axis of the symmetry.

◆ Mirrored() [2/3]

gp_Elips gp_Elips::Mirrored ( const gp_Ax2 theA2) const

Performs the symmetrical transformation of an ellipse with respect to a plane. The axis placement theA2 locates the plane of the symmetry (Location, XDirection, YDirection).

◆ Mirrored() [3/3]

gp_Elips gp_Elips::Mirrored ( const gp_Pnt theP) const

Performs the symmetrical transformation of an ellipse with respect to the point theP which is the center of the symmetry.

◆ Parameter()

Standard_Real gp_Elips::Parameter ( ) const
inline

Returns p = (1 - e * e) * MajorRadius where e is the eccentricity of the ellipse. Returns 0 if MajorRadius = 0.

◆ Position()

const gp_Ax2& gp_Elips::Position ( ) const
inline

Returns the coordinate system of the ellipse.

◆ Rotate()

void gp_Elips::Rotate ( const gp_Ax1 theA1,
const Standard_Real  theAng 
)
inline

◆ Rotated()

gp_Elips gp_Elips::Rotated ( const gp_Ax1 theA1,
const Standard_Real  theAng 
) const
inline

Rotates an ellipse. theA1 is the axis of the rotation. theAng is the angular value of the rotation in radians.

◆ Scale()

void gp_Elips::Scale ( const gp_Pnt theP,
const Standard_Real  theS 
)
inline

◆ Scaled()

gp_Elips gp_Elips::Scaled ( const gp_Pnt theP,
const Standard_Real  theS 
) const
inline

Scales an ellipse. theS is the scaling value.

◆ SetAxis()

void gp_Elips::SetAxis ( const gp_Ax1 theA1)
inline

Changes the axis normal to the plane of the ellipse. It modifies the definition of this plane. The "XAxis" and the "YAxis" are recomputed. The local coordinate system is redefined so that:

  • its origin and "main Direction" become those of the axis theA1 (the "X Direction" and "Y Direction" are then recomputed in the same way as for any gp_Ax2), or Raises ConstructionError if the direction of theA1 is parallel to the direction of the "XAxis" of the ellipse.

◆ SetLocation()

void gp_Elips::SetLocation ( const gp_Pnt theP)
inline

Modifies this ellipse, by redefining its local coordinate so that its origin becomes theP.

◆ SetMajorRadius()

void gp_Elips::SetMajorRadius ( const Standard_Real  theMajorRadius)
inline

The major radius of the ellipse is on the "XAxis" (major axis) of the ellipse. Raises ConstructionError if theMajorRadius < MinorRadius.

◆ SetMinorRadius()

void gp_Elips::SetMinorRadius ( const Standard_Real  theMinorRadius)
inline

The minor radius of the ellipse is on the "YAxis" (minor axis) of the ellipse. Raises ConstructionError if theMinorRadius > MajorRadius or MinorRadius < 0.

◆ SetPosition()

void gp_Elips::SetPosition ( const gp_Ax2 theA2)
inline

Modifies this ellipse, by redefining its local coordinate so that it becomes theA2.

◆ Transform()

void gp_Elips::Transform ( const gp_Trsf theT)
inline

◆ Transformed()

gp_Elips gp_Elips::Transformed ( const gp_Trsf theT) const
inline

Transforms an ellipse with the transformation theT from class Trsf.

◆ Translate() [1/2]

void gp_Elips::Translate ( const gp_Pnt theP1,
const gp_Pnt theP2 
)
inline

◆ Translate() [2/2]

void gp_Elips::Translate ( const gp_Vec theV)
inline

◆ Translated() [1/2]

gp_Elips gp_Elips::Translated ( const gp_Pnt theP1,
const gp_Pnt theP2 
) const
inline

Translates an ellipse from the point theP1 to the point theP2.

◆ Translated() [2/2]

gp_Elips gp_Elips::Translated ( const gp_Vec theV) const
inline

Translates an ellipse in the direction of the vector theV. The magnitude of the translation is the vector's magnitude.

◆ XAxis()

gp_Ax1 gp_Elips::XAxis ( ) const
inline

Returns the "XAxis" of the ellipse whose origin is the center of this ellipse. It is the major axis of the ellipse.

◆ YAxis()

gp_Ax1 gp_Elips::YAxis ( ) const
inline

Returns the "YAxis" of the ellipse whose unit vector is the "X Direction" or the "Y Direction" of the local coordinate system of this ellipse. This is the minor axis of the ellipse.


The documentation for this class was generated from the following file: