Part::Geom2dEllipse Class Reference

#include <Geometry2d.h>

Public Member Functions

virtual Geometry2dclone (void) const
 returns a cloned object More...
 
 Geom2dEllipse ()
 
 Geom2dEllipse (const Handle(Geom2d_Ellipse)&)
 
Base::Vector2d getMajorAxisDir () const
 Geom2dEllipse::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...
 
double getMinorRadius (void) const
 
virtual PyObjectgetPyObject (void)
 This method returns the Python wrapper for a C++ object. More...
 
const Handle (Geom2d_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(Geom2d_Ellipse) &e)
 
void setMajorAxisDir (Base::Vector2d newdir)
 Geom2dEllipse::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 ~Geom2dEllipse ()
 
- Public Member Functions inherited from Part::Geom2dConic
virtual Geometry2dclone (void) const =0
 returns a cloned object More...
 
Base::Vector2d 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 (Geom2d_Geometry) &handle() const =0
 
bool isReversed () const
 
void setLocation (const Base::Vector2d &Center)
 
virtual ~Geom2dConic ()
 
- Public Member Functions inherited from Part::Geom2dCurve
bool closestParameter (const Base::Vector2d &point, double &u) const
 
bool closestParameterToBasicCurve (const Base::Vector2d &point, double &u) const
 
Base::Vector2d firstDerivativeAtParameter (double u) const
 
 Geom2dCurve ()
 
bool normal (double u, gp_Dir2d &dir) const
 
Base::Vector2d pointAtParameter (double u) const
 
Base::Vector2d secondDerivativeAtParameter (double u) const
 
bool tangent (double u, gp_Dir2d &) const
 
virtual TopoDS_Shape toShape () const
 
virtual ~Geom2dCurve ()
 
- Public Member Functions inherited from Part::Geometry2d
virtual Geometry2dclone (void) const =0
 returns a cloned object More...
 
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...
 
virtual const Handle (Geom2d_Geometry) &handle() const =0
 
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...
 
virtual TopoDS_Shape toShape () const =0
 
virtual ~Geometry2d ()
 
- 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::Geom2dConic
 Geom2dConic ()
 
void RestoreAxis (Base::XMLReader &reader, gp_Ax22d &)
 
void SaveAxis (Base::Writer &writer, const gp_Ax22d &) const
 
- Protected Member Functions inherited from Part::Geometry2d
 Geometry2d ()
 
- Static Protected Member Functions inherited from Base::BaseClass
static void initSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Type::instantiationMethod method=nullptr)
 

Constructor & Destructor Documentation

◆ Geom2dEllipse() [1/2]

Geom2dEllipse::Geom2dEllipse ( )

◆ Geom2dEllipse() [2/2]

Geom2dEllipse::Geom2dEllipse ( const Handle(Geom2d_Ellipse)&  e)

References Handle().

◆ ~Geom2dEllipse()

Geom2dEllipse::~Geom2dEllipse ( )
virtual

Member Function Documentation

◆ clone()

◆ getMajorAxisDir()

Base::Vector2d Geom2dEllipse::getMajorAxisDir ( ) const

Geom2dEllipse::getMajorAxisDir.

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

◆ getMajorRadius()

double Part::Geom2dEllipse::getMajorRadius ( void  ) const

◆ getMemSize()

unsigned int Geom2dEllipse::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::Geom2dConic.

◆ getMinorRadius()

double Geom2dEllipse::getMinorRadius ( void  ) const

References Handle().

◆ getPyObject()

PyObject * Geom2dEllipse::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::Geom2dConic.

References clone().

◆ Handle()

const Part::Geom2dEllipse::Handle ( Geom2d_Geometry  ) const &
virtual

◆ Restore()

void Geom2dEllipse::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::Geometry2d.

References Base::XMLReader::getAttributeAsFloat(), Base::XMLReader::readElement(), Part::Geometry2d::Restore(), and Part::Geom2dConic::RestoreAxis().

◆ Save()

void Geom2dEllipse::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::Geometry2d.

References Base::Writer::ind(), Part::Geometry2d::Save(), Part::Geom2dConic::SaveAxis(), and Base::Writer::Stream().

◆ setHandle()

void Geom2dEllipse::setHandle ( const Handle(Geom2d_Ellipse) &  e)

References Handle().

◆ setMajorAxisDir()

void Geom2dEllipse::setMajorAxisDir ( Base::Vector2d  newdir)

Geom2dEllipse::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::Vector2d::Length(), Base::Vector2d::x, and Base::Vector2d::y.

◆ setMajorRadius()

void Part::Geom2dEllipse::setMajorRadius ( double  Radius)

◆ setMinorRadius()

void Geom2dEllipse::setMinorRadius ( double  Radius)

References Handle().


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