Part::GeomEllipse Class Reference

#include <Geometry.h>

Public Member Functions

virtual Geometrycopy (void) const
 returns a copy of this object having a new randomly generated tag. More...
 
 GeomEllipse ()
 
 GeomEllipse (const Handle(Geom_Ellipse)&)
 
Base::Vector3d getMajorAxisDir () const
 GeomEllipse::getMajorAxisDir. More...
 
double getMajorRadius (void) const
 
virtual unsigned int getMemSize (void) const
 This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? More...
 
Base::Vector3d getMinorAxisDir () const
 GeomEllipse::getMinorAxisDir. More...
 
double getMinorRadius (void) const
 
virtual PyObjectgetPyObject (void)
 This method returns the Python wrapper for a C++ object. More...
 
const Handle (Geom_Geometry) &handle() const
 
virtual void Restore (Base::XMLReader &)
 This method is used to restore properties from an XML document. More...
 
virtual void Save (Base::Writer &) const
 This method is used to save properties to an XML document. More...
 
void setHandle (const Handle(Geom_Ellipse) &e)
 
void setMajorAxisDir (Base::Vector3d newdir)
 GeomEllipse::setMajorAxisDir Rotates the ellipse in its plane, so that its major axis is as close as possible to the provided direction. More...
 
void setMajorRadius (double Radius)
 
void setMinorRadius (double Radius)
 
virtual GeomBSplineCurvetoNurbs (double first, double last) const
 
virtual ~GeomEllipse ()
 
- Public Member Functions inherited from Part::GeomConic
virtual Geometrycopy (void) const =0
 returns a copy of this object having a new randomly generated tag. More...
 
double getAngleXU (void) const
 GeomConic::getAngleXU. More...
 
Base::Vector3d getAxisDirection (void) const
 
Base::Vector3d getCenter (void) const
 getCenter More...
 
Base::Vector3d getLocation (void) const
 
virtual unsigned int getMemSize (void) const =0
 This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? More...
 
virtual PyObjectgetPyObject (void)=0
 This method returns the Python wrapper for a C++ object. More...
 
const Handle (Geom_Geometry) &handle() const =0
 
bool isReversed () const
 GeomConic::isReversed tests if an ellipse that lies in XY plane is reversed (i.e. drawn from startpoint to endpoint in CW direction instead of CCW.) More...
 
void setAngleXU (double angle)
 GeomConic::setAngleXU complements getAngleXU. More...
 
void setCenter (const Base::Vector3d &Center)
 setCenter More...
 
void setLocation (const Base::Vector3d &Center)
 
virtual ~GeomConic ()
 
- Public Member Functions inherited from Part::GeomCurve
bool closestParameter (const Base::Vector3d &point, double &u) const
 
bool closestParameterToBasisCurve (const Base::Vector3d &point, double &u) const
 
double curvatureAt (double u) const
 
Base::Vector3d firstDerivativeAtParameter (double u) const
 
 GeomCurve ()
 
double getFirstParameter () const
 
double getLastParameter () const
 
bool intersect (const GeomCurve *c, std::vector< std::pair< Base::Vector3d, Base::Vector3d > > &points, double tol=Precision::Confusion()) const
 
double length (double u, double v) const
 
bool normalAt (const Base::Vector3d &curvepoint, Base::Vector3d &dir) const
 
bool normalAt (double u, Base::Vector3d &dir) const
 
Base::Vector3d pointAtParameter (double u) const
 
void reverse (void)
 
Base::Vector3d secondDerivativeAtParameter (double u) const
 
bool tangent (double u, Base::Vector3d &dir) const
 
bool tangent (double u, gp_Dir &) const
 
GeomBSplineCurvetoBSpline (double first, double last) const
 toBSpline Converts the curve to a B-spline More...
 
virtual GeomBSplineCurvetoNurbs (double first, double last) const
 
TopoDS_Shape toShape () const
 
Base::Vector3d value (double u) const
 
virtual ~GeomCurve ()
 
- Public Member Functions inherited from Part::Geometry
Geometryclone (void) const
 returns a cloned object. More...
 
virtual Geometrycopy (void) const =0
 returns a copy of this object having a new randomly generated tag. More...
 
void deleteExtension (Base::Type type)
 
void deleteExtension (const std::string &name)
 
std::weak_ptr< GeometryExtensiongetExtension (Base::Type type)
 
std::weak_ptr< const GeometryExtensiongetExtension (Base::Type type) const
 
std::weak_ptr< GeometryExtensiongetExtension (const std::string &name)
 
std::weak_ptr< const GeometryExtensiongetExtension (const std::string &name) const
 
std::vector< std::weak_ptr< const GeometryExtension > > getExtensions () const
 
virtual unsigned int getMemSize (void) const
 This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? More...
 
boost::uuids::uuid getTag () const
 returns the tag of the geometry object More...
 
virtual const Handle (Geom_Geometry) &handle() const =0
 
bool hasExtension (Base::Type type) const
 
bool hasExtension (const std::string &name) const
 
void mirror (const Base::Vector3d &point)
 
void mirror (const Base::Vector3d &point, const Base::Vector3d &dir)
 
virtual void Restore (Base::XMLReader &)
 This method is used to restore properties from an XML document. More...
 
void rotate (const Base::Placement &plm)
 
virtual void Save (Base::Writer &) const
 This method is used to save properties to an XML document. More...
 
void scale (const Base::Vector3d &vec, double scale)
 
void setExtension (std::unique_ptr< GeometryExtension > &&geo)
 
virtual TopoDS_Shape toShape () const =0
 
void transform (const Base::Matrix4D &mat)
 
void translate (const Base::Vector3d &vec)
 
virtual ~Geometry ()
 
- Public Member Functions inherited from Base::Persistence
void dumpToStream (std::ostream &stream, int compression)
 
virtual unsigned int getMemSize () const =0
 This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? More...
 
virtual Base::Type getTypeId (void) const
 
virtual void Restore (XMLReader &)=0
 This method is used to restore properties from an XML document. More...
 
virtual void RestoreDocFile (Reader &)
 This method is used to restore large amounts of data from a file In this method you simply stream in your SaveDocFile() saved data. More...
 
void restoreFromStream (std::istream &stream)
 
virtual void Save (Writer &) const =0
 This method is used to save properties to an XML document. More...
 
virtual void SaveDocFile (Writer &) const
 This method is used to save large amounts of data to a binary file. More...
 
- Public Member Functions inherited from Base::BaseClass
 BaseClass ()
 Construction. More...
 
 BaseClass (const BaseClass &)=default
 
virtual PyObjectgetPyObject ()
 This method returns the Python wrapper for a C++ object. More...
 
virtual Type getTypeId () const
 
bool isDerivedFrom (const Type type) const
 
BaseClassoperator= (const BaseClass &)=default
 
virtual void setPyObject (PyObject *)
 
virtual ~BaseClass ()
 Destruction. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Base::Persistence
static void * create (void)
 
static std::string encodeAttribute (const std::string &)
 Encodes an attribute upon saving. More...
 
static Base::Type getClassTypeId (void)
 
static void init (void)
 
- Static Public Member Functions inherited from Base::BaseClass
static void * create ()
 
static Type getClassTypeId ()
 
static void init ()
 
- Protected Member Functions inherited from Part::GeomConic
 GeomConic ()
 
- Protected Member Functions inherited from Part::Geometry
void assignTag (const Part::Geometry *)
 copies the tag from the geometry passed as a parameter to this object More...
 
void copyNonTag (const Part::Geometry *)
 
void createNewTag ()
 create a new tag for the geometry object More...
 
 Geometry ()
 
- Static Protected Member Functions inherited from Part::GeomCurve
static bool intersect (const Handle(Geom_Curve) c, const Handle(Geom_Curve) c2, std::vector< std::pair< Base::Vector3d, Base::Vector3d > > &points, double tol=Precision::Confusion())
 
- Static Protected Member Functions inherited from Base::BaseClass
static void initSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Type::instantiationMethod method=nullptr)
 
- Protected Attributes inherited from Part::Geometry
std::vector< std::shared_ptr< GeometryExtension > > extensions
 
boost::uuids::uuid tag
 

Constructor & Destructor Documentation

◆ GeomEllipse() [1/2]

GeomEllipse::GeomEllipse ( )

Referenced by copy().

◆ GeomEllipse() [2/2]

GeomEllipse::GeomEllipse ( const Handle(Geom_Ellipse)&  e)

References setHandle().

◆ ~GeomEllipse()

GeomEllipse::~GeomEllipse ( )
virtual

Member Function Documentation

◆ copy()

Geometry * GeomEllipse::copy ( void  ) const
virtual

returns a copy of this object having a new randomly generated tag.

If you also want to copy the tag, you may use clone() instead. For creation of geometry with other handles, with or without the same tag, you may use the constructors and the sethandle functions. The tag of a geometry can be copied to another geometry using the assignTag function.

Implements Part::GeomConic.

References Part::Geometry::copyNonTag(), and GeomEllipse().

◆ getMajorAxisDir()

Base::Vector3d GeomEllipse::getMajorAxisDir ( ) const

GeomEllipse::getMajorAxisDir.

Returns
the direction vector (unit-length) of major axis of the ellipse. The direction also points to the first focus.

Referenced by Sketcher::Sketch::addEllipse(), and Sketcher::SketchObject::addSymmetric().

◆ getMajorRadius()

double GeomEllipse::getMajorRadius ( void  ) const

◆ getMemSize()

unsigned int GeomEllipse::getMemSize ( void  ) const
virtual

This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB?

Implements Part::GeomConic.

◆ getMinorAxisDir()

Base::Vector3d GeomEllipse::getMinorAxisDir ( ) const

GeomEllipse::getMinorAxisDir.

Returns
the direction vector (unit-length) of minor axis of the ellipse.

◆ getMinorRadius()

double GeomEllipse::getMinorRadius ( void  ) const

◆ getPyObject()

PyObject * GeomEllipse::getPyObject ( void  )
virtual

This method returns the Python wrapper for a C++ object.

It's in the responsibility of the programmer to do the correct reference counting. Basically there are two ways how to implement that: Either always return a new Python object then reference counting is not a matter or return always the same Python object then the reference counter must be incremented by one. However, it's absolutely forbidden to return always the same Python object without incrementing the reference counter.

The default implementation returns 'None'.

Implements Part::GeomConic.

References Part::Geometry::clone().

◆ Handle()

const Part::GeomEllipse::Handle ( Geom_Geometry  ) const &
virtual

◆ Restore()

void GeomEllipse::Restore ( Base::XMLReader )
virtual

This method is used to restore properties from an XML document.

It uses the XMLReader class, which bases on SAX, to read the in Save() written information. Again the Vector as an example:

void PropertyVector::Restore(Base::XMLReader &reader)
{
// read my Element
reader.readElement("PropertyVector");
// get the value of my Attribute
_cVec.x = reader.getAttributeAsFloat("valueX");
_cVec.y = reader.getAttributeAsFloat("valueY");
_cVec.z = reader.getAttributeAsFloat("valueZ");
}

Reimplemented from Part::Geometry.

References Base::XMLReader::getAttributeAsFloat(), Base::XMLReader::hasAttribute(), Base::XMLReader::readElement(), and Part::Geometry::Restore().

◆ Save()

void GeomEllipse::Save ( Base::Writer ) const
virtual

This method is used to save properties to an XML document.

A good example you'll find in PropertyStandard.cpp, e.g. the vector:

void PropertyVector::Save (Writer &writer) const
{
writer << writer.ind() << "<PropertyVector valueX=\"" << _cVec.x <<
"\" valueY=\"" << _cVec.y <<
"\" valueZ=\"" << _cVec.z <<"\"/>" << endl;
}

The writer.ind() expression writes the indentation, just for pretty printing of the XML. As you see, the writing of the XML document is not done with a DOM implementation because of performance reasons. Therefore the programmer has to take care that a valid XML document is written. This means closing tags and writing UTF-8.

See also
Base::Writer

Reimplemented from Part::Geometry.

References Base::Writer::ind(), Part::Geometry::Save(), and Base::Writer::Stream().

◆ setHandle()

void Part::GeomEllipse::setHandle ( const Handle(Geom_Ellipse) &  e)

Referenced by GeomEllipse().

◆ setMajorAxisDir()

void GeomEllipse::setMajorAxisDir ( Base::Vector3d  newdir)

GeomEllipse::setMajorAxisDir Rotates the ellipse in its plane, so that its major axis is as close as possible to the provided direction.

Parameters
newdir[in] is the new direction. If the vector is small, the orientation of the ellipse will be preserved. If the vector is not small, but its projection onto plane of the ellipse is small, an exception will be thrown.

References Base::Vector3< _Precision >::Sqr(), Base::Vector3< _Precision >::x, Base::Vector3< _Precision >::y, and Base::Vector3< _Precision >::z.

Referenced by Sketcher::SketchObject::addSymmetric().

◆ setMajorRadius()

void GeomEllipse::setMajorRadius ( double  Radius)

References Handle().

◆ setMinorRadius()

void GeomEllipse::setMinorRadius ( double  Radius)

References Handle().

◆ toNurbs()

GeomBSplineCurve * GeomEllipse::toNurbs ( double  first,
double  last 
) const
virtual

The default implementation does the same as toBSpline. In sub-classes this can be reimplemented to create a real NURBS curve and not just an approximation.

Reimplemented from Part::GeomCurve.

References Handle(), and Part::GeomCurve::toNurbs().


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