Part::GeomCircle Class Reference
#include <Geometry.h>
Public Member Functions | |
| virtual Geometry * | clone (void) const |
| returns a cloned object | |
| GeomCircle (const Handle_Geom_Circle &) | |
| GeomCircle () | |
| Base::Vector3d | getCenter (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? | |
| virtual PyObject * | getPyObject (void) |
| This method returns the Python wrapper for a C++ object. | |
| double | getRadius (void) const |
| virtual Base::Type | getTypeId (void) const |
| const Handle_Geom_Geometry & | handle () const |
| virtual void | Restore (Base::XMLReader &) |
| This method is used to restore properties from an XML document. | |
| virtual void | Save (Base::Writer &) const |
| This method is used to save properties to an XML document. | |
| void | setCenter (const Base::Vector3d &Center) |
| void | setRadius (double Radius) |
| virtual | ~GeomCircle () |
Static Public Member Functions | |
| static void * | create (void) |
| static Base::Type | getClassTypeId (void) |
| static void | init (void) |
Detailed Description
Definition at line 172 of file Geometry.h.
Constructor & Destructor Documentation
| GeomCircle::GeomCircle | ( | ) |
Definition at line 471 of file Geometry.cpp.
Referenced by clone().
| GeomCircle::GeomCircle | ( | const Handle_Geom_Circle & | c | ) |
Definition at line 477 of file Geometry.cpp.
| GeomCircle::~GeomCircle | ( | ) | [virtual] |
Definition at line 482 of file Geometry.cpp.
Member Function Documentation
| Geometry * GeomCircle::clone | ( | void | ) | const [virtual] |
returns a cloned object
Implements Part::Geometry.
Definition at line 491 of file Geometry.cpp.
References Part::Geometry::Construction, and GeomCircle().
Referenced by Sketcher::Sketch::addCircle(), and getPyObject().
| void * Part::GeomCircle::create | ( | void | ) | [static] |
Reimplemented from Part::GeomCurve.
Definition at line 469 of file Geometry.cpp.
| Base::Vector3d GeomCircle::getCenter | ( | void | ) | const |
Definition at line 498 of file Geometry.cpp.
References handle().
Referenced by Sketcher::Sketch::addCircle(), SketcherGui::ViewProviderSketch::draw(), Sketcher::SketchObject::getPoint(), SketcherGui::ViewProviderSketch::moveConstraint(), SketcherGui::DrawSketchHandler::seekAutoConstraint(), and Sketcher::SketchObject::trim().
| Base::Type Part::GeomCircle::getClassTypeId | ( | void | ) | [static] |
Reimplemented from Part::GeomCurve.
Definition at line 469 of file Geometry.cpp.
Referenced by CmdSketcherConstrainEqual::activated(), CmdSketcherConstrainRadius::activated(), CmdSketcherConstrainPointOnObject::activated(), SketcherGui::TrimmingSelection::allow(), DrawSketchHandlerTrimming::releaseButton(), and SketcherGui::DrawSketchHandler::seekAutoConstraint().
| unsigned int GeomCircle::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?
Reimplemented from Part::Geometry.
Definition at line 542 of file Geometry.cpp.
| PyObject * GeomCircle::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'.
Reimplemented from Base::BaseClass.
Definition at line 601 of file Geometry.cpp.
References clone().
| double GeomCircle::getRadius | ( | void | ) | const |
Definition at line 506 of file Geometry.cpp.
References handle().
Referenced by CmdSketcherConstrainRadius::activated(), Sketcher::Sketch::addCircle(), SketcherGui::ViewProviderSketch::draw(), SketcherGui::ViewProviderSketch::moveConstraint(), SketcherGui::DrawSketchHandler::seekAutoConstraint(), and Sketcher::SketchObject::trim().
| Base::Type Part::GeomCircle::getTypeId | ( | void | ) | const [virtual] |
Reimplemented from Part::GeomCurve.
Definition at line 469 of file Geometry.cpp.
| const Handle_Geom_Geometry & GeomCircle::handle | ( | ) | const [virtual] |
Implements Part::Geometry.
Definition at line 486 of file Geometry.cpp.
Referenced by SketcherGui::ViewProviderSketch::draw(), getCenter(), Part::TopoShapeEdgePy::getCurve(), getRadius(), Part::CylinderPy::PyInit(), Part::CirclePy::PyInit(), setCenter(), and setRadius().
| void Part::GeomCircle::init | ( | void | ) | [static] |
Reimplemented from Part::GeomCurve.
Definition at line 469 of file Geometry.cpp.
Referenced by initPart().
| void GeomCircle::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 = (float)reader.getAttributeAsFloat("valueX"); _cVec.y = (float)reader.getAttributeAsFloat("valueY"); _cVec.z = (float)reader.getAttributeAsFloat("valueZ"); }
Reimplemented from Part::Geometry.
Definition at line 568 of file Geometry.cpp.
References gce_ErrorStatusText(), Base::XMLReader::getAttributeAsFloat(), Sketcher::Radius, and Base::XMLReader::readElement().
| void GeomCircle::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 indention, 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.
Definition at line 547 of file Geometry.cpp.
References Base::Writer::ind(), and Base::Writer::Stream().
| void GeomCircle::setCenter | ( | const Base::Vector3d & | Center | ) |
Definition at line 512 of file Geometry.cpp.
References handle(), Base::Vector3< _Precision >::x, Base::Vector3< _Precision >::y, and Base::Vector3< _Precision >::z.
Referenced by Part::CirclePy::setCenter().
| void GeomCircle::setRadius | ( | double | Radius | ) |
Definition at line 526 of file Geometry.cpp.
References handle().
The documentation for this class was generated from the following files:
