#include <Geometry.h>

Public Member Functions

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 (std::string name)
 
std::weak_ptr< GeometryExtensiongetExtension (Base::Type type)
 
std::weak_ptr< const GeometryExtensiongetExtension (Base::Type type) const
 
std::weak_ptr< GeometryExtensiongetExtension (std::string name)
 
std::weak_ptr< const GeometryExtensiongetExtension (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 (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 Base::Type getTypeId (void) const
 
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 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...
 
virtual PyObjectgetPyObject (void)
 This method returns the Python wrapper for a C++ object. More...
 
bool isDerivedFrom (const Type type) const
 
virtual void setPyObject (PyObject *)
 
virtual ~BaseClass ()
 Destruction. More...
 

Protected Member Functions

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 ()
 

Protected Attributes

std::vector< std::shared_ptr< GeometryExtension > > extensions
 
boost::uuids::uuid tag
 

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 (void)
 
static Type getClassTypeId (void)
 
static void init (void)
 
- 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

◆ ~Geometry()

Geometry::~Geometry ( )
virtual

◆ Geometry()

Geometry::Geometry ( )
protected

Member Function Documentation

◆ assignTag()

void Geometry::assignTag ( const Part::Geometry geo)
protected

copies the tag from the geometry passed as a parameter to this object

References Base::Persistence::getTypeId(), and tag.

◆ clone()

Geometry * Geometry::clone ( void  ) const

returns a cloned object.

A cloned object has the same tag (see getTag) as the original object. if you want a copy not having the same tag, you can use copy() instead. If you want a clone with another geometry handle, it is possible to clone an object and then assign another handle or to create an object via constructor and use assignTag to assign the tag of the other geometry. If you do not desire to have the same tag, then a copy can be performed by using a constructor (which will generate another tag) and then, if necessary (e.g. if the constructor did not take a handle as a parameter), set a new handle.

References copy(), and tag.

Referenced by ArchPanel.CommandPanelSheet::Activated(), Sketcher::Sketch::addArc(), Sketcher::Sketch::addArcOfEllipse(), Sketcher::Sketch::addArcOfHyperbola(), Sketcher::Sketch::addArcOfParabola(), Sketcher::Sketch::addCircle(), Sketcher::Sketch::addEllipse(), Sketcher::Sketch::addLineSegment(), Part::GeometryPy::clone(), Sketcher::ExternalGeometryFacade::clone(), Sketcher::GeometryFacade::clone(), ArchComponent.Component::execute(), ArchCurtainWall.CurtainWall::execute(), ArchTruss.Truss::execute(), Part::GeomBezierCurve::getPyObject(), Part::GeomBSplineCurve::getPyObject(), Part::GeomTrimmedCurve::getPyObject(), Part::GeomCircle::getPyObject(), Part::GeomArcOfCircle::getPyObject(), Part::GeomEllipse::getPyObject(), Part::GeomArcOfEllipse::getPyObject(), Part::GeomHyperbola::getPyObject(), Part::GeomArcOfHyperbola::getPyObject(), Part::GeomParabola::getPyObject(), Part::GeomArcOfParabola::getPyObject(), Part::GeomLine::getPyObject(), Part::GeomLineSegment::getPyObject(), Part::GeomOffsetCurve::getPyObject(), Part::GeomBezierSurface::getPyObject(), Part::GeomBSplineSurface::getPyObject(), Part::GeomCylinder::getPyObject(), Part::GeomCone::getPyObject(), Part::GeomSphere::getPyObject(), Part::GeomToroid::getPyObject(), Part::GeomPlane::getPyObject(), Part::GeomOffsetSurface::getPyObject(), Part::GeomPlateSurface::getPyObject(), Part::GeomTrimmedSurface::getPyObject(), Part::GeomSurfaceOfRevolution::getPyObject(), Part::GeomSurfaceOfExtrusion::getPyObject(), Mod.PartDesign.WizardShaft.SegmentFunction.SegmentFunction::integrated(), Sketcher::SketchObject::modifyBSplineKnotMultiplicity(), Sketcher::ExternalGeometryFacadePy::PyInit(), Sketcher::GeometryFacadePy::PyInit(), Sketcher::ExternalGeometryFacadePy::setGeometry(), Sketcher::GeometryFacadePy::setGeometry(), Part::PropertyGeometryList::setValue(), and PathTests.TestPathHelix.TestPathHelix::test04().

◆ copy()

◆ copyNonTag()

◆ createNewTag()

void Geometry::createNewTag ( )
protected

create a new tag for the geometry object

References tag.

◆ deleteExtension() [1/2]

void Geometry::deleteExtension ( Base::Type  type)

◆ deleteExtension() [2/2]

void Geometry::deleteExtension ( std::string  name)

References extensions.

◆ getExtension() [1/4]

std::weak_ptr< GeometryExtension > Geometry::getExtension ( Base::Type  type)

References extensions.

◆ getExtension() [2/4]

◆ getExtension() [3/4]

std::weak_ptr< GeometryExtension > Geometry::getExtension ( std::string  name)

References extensions.

◆ getExtension() [4/4]

std::weak_ptr< const GeometryExtension > Geometry::getExtension ( std::string  name) const

References getExtension().

◆ getExtensions()

std::vector< std::weak_ptr< const GeometryExtension > > Geometry::getExtensions ( ) const

References extensions.

Referenced by Part::GeometryPy::getExtensions().

◆ getMemSize()

◆ getTag()

boost::uuids::uuid Geometry::getTag ( void  ) const

returns the tag of the geometry object

References tag.

◆ Handle()

virtual const Part::Geometry::Handle ( Geom_Geometry  ) const &
pure virtual

Implemented in Part::GeomArcOfConic, Part::GeomConic, Part::GeomSurfaceOfExtrusion, Part::GeomSurfaceOfRevolution, Part::GeomTrimmedSurface, Part::GeomPlateSurface, Part::GeomOffsetSurface, Part::GeomPlane, Part::GeomToroid, Part::GeomSphere, Part::GeomCone, Part::GeomCylinder, Part::GeomBSplineSurface, Part::GeomBezierSurface, Part::GeomOffsetCurve, Part::GeomLineSegment, Part::GeomLine, Part::GeomArcOfParabola, Part::GeomParabola, Part::GeomArcOfHyperbola, Part::GeomHyperbola, Part::GeomArcOfEllipse, Part::GeomEllipse, Part::GeomArcOfCircle, Part::GeomCircle, Part::GeomTrimmedCurve, Part::GeomBSplineCurve, Part::GeomBezierCurve, and Part::GeomPoint.

Referenced by Part::GeomCurve::closestParameter(), Part::GeomCurve::closestParameterToBasisCurve(), Part::GeomSurface::curvature(), Part::GeomCurve::curvatureAt(), Part::GeomSurface::curvatureDirections(), Part::GeomCurve::firstDerivativeAtParameter(), Part::GeomBoundedCurve::getEndPoint(), Part::GeomCurve::getFirstParameter(), Part::GeomCurve::getLastParameter(), Part::GeomBoundedCurve::getStartPoint(), Part::GeomCurve::intersect(), Part::GeomSurface::isUmbillic(), Part::GeomCurve::length(), Part::GeomSurface::normal(), Part::GeomCurve::normalAt(), Part::GeomCurve::pointAtParameter(), Part::GeomCurve::reverse(), Part::GeomCurve::secondDerivativeAtParameter(), Part::GeomCurve::tangent(), Part::GeomSurface::tangentU(), Part::GeomSurface::tangentV(), Part::GeomCurve::toBSpline(), Part::GeomCurve::toShape(), and Part::GeomSurface::toShape().

◆ hasExtension() [1/2]

◆ hasExtension() [2/2]

bool Geometry::hasExtension ( std::string  name) const

References extensions.

◆ mirror() [1/2]

void Geometry::mirror ( const Base::Vector3d point)

◆ mirror() [2/2]

void Geometry::mirror ( const Base::Vector3d point,
const Base::Vector3d dir 
)

◆ Restore()

void Geometry::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");
}
The XML reader class This is an important helper class for the store and retrieval system of objects ...
Definition: Reader.h:118
void readElement(const char *ElementName=0)
read until a start element is found (<name>) or start-end element (<name/>) (with special name if giv...
Definition: Reader.cpp:240
double getAttributeAsFloat(const char *AttrName) const
return the named attribute as a double floating point (does type checking)
Definition: Reader.cpp:158

Implements Base::Persistence.

Reimplemented in Part::GeomSurfaceOfExtrusion, Part::GeomSurfaceOfRevolution, Part::GeomTrimmedSurface, Part::GeomPlateSurface, Part::GeomOffsetSurface, Part::GeomPlane, Part::GeomToroid, Part::GeomSphere, Part::GeomCone, Part::GeomCylinder, Part::GeomBSplineSurface, Part::GeomBezierSurface, Part::GeomOffsetCurve, Part::GeomLineSegment, Part::GeomLine, Part::GeomArcOfParabola, Part::GeomParabola, Part::GeomArcOfHyperbola, Part::GeomHyperbola, Part::GeomArcOfEllipse, Part::GeomEllipse, Part::GeomArcOfCircle, Part::GeomCircle, Part::GeomTrimmedCurve, Part::GeomBSplineCurve, Part::GeomBezierCurve, and Part::GeomPoint.

References Part::GeometryMigrationExtension::Construction, extensions, Base::Type::fromName(), Base::XMLReader::getAttribute(), Base::XMLReader::getAttributeAsInteger(), Base::BaseClass::getClassTypeId(), getExtension(), hasExtension(), Base::XMLReader::localName(), Base::XMLReader::readElement(), Base::XMLReader::readEndElement(), Part::GeometryPersistenceExtension::Restore(), and setExtension().

Referenced by Part::GeomPoint::Restore(), Part::GeomBSplineCurve::Restore(), Part::GeomCircle::Restore(), Part::GeomArcOfCircle::Restore(), Part::GeomEllipse::Restore(), Part::GeomArcOfEllipse::Restore(), Part::GeomHyperbola::Restore(), Part::GeomArcOfHyperbola::Restore(), Part::GeomParabola::Restore(), Part::GeomArcOfParabola::Restore(), Part::GeomLine::Restore(), Part::GeomLineSegment::Restore(), and Part::PropertyGeometryList::Restore().

◆ rotate()

◆ Save()

void Geometry::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

Implements Base::Persistence.

Reimplemented in Part::GeomSurfaceOfExtrusion, Part::GeomSurfaceOfRevolution, Part::GeomTrimmedSurface, Part::GeomPlateSurface, Part::GeomOffsetSurface, Part::GeomPlane, Part::GeomToroid, Part::GeomSphere, Part::GeomCone, Part::GeomCylinder, Part::GeomBSplineSurface, Part::GeomBezierSurface, Part::GeomOffsetCurve, Part::GeomLineSegment, Part::GeomLine, Part::GeomArcOfParabola, Part::GeomParabola, Part::GeomArcOfHyperbola, Part::GeomHyperbola, Part::GeomArcOfEllipse, Part::GeomEllipse, Part::GeomArcOfCircle, Part::GeomCircle, Part::GeomTrimmedCurve, Part::GeomBSplineCurve, Part::GeomBezierCurve, and Part::GeomPoint.

References Base::Writer::decInd(), extensions, Base::BaseClass::getClassTypeId(), Base::Writer::incInd(), Base::Writer::ind(), and Base::Writer::Stream().

Referenced by Part::GeomPoint::Save(), Part::GeomBSplineCurve::Save(), Part::GeomCircle::Save(), Part::GeomArcOfCircle::Save(), Part::GeomEllipse::Save(), Part::GeomArcOfEllipse::Save(), Part::GeomHyperbola::Save(), Part::GeomArcOfHyperbola::Save(), Part::GeomParabola::Save(), Part::GeomArcOfParabola::Save(), Part::GeomLine::Save(), and Part::GeomLineSegment::Save().

◆ scale()

◆ setExtension()

void Geometry::setExtension ( std::unique_ptr< GeometryExtension > &&  geo)

◆ toShape()

virtual TopoDS_Shape Part::Geometry::toShape ( ) const
pure virtual

◆ transform()

◆ translate()

void Geometry::translate ( const Base::Vector3d vec)

Member Data Documentation

◆ extensions

◆ tag


The documentation for this class was generated from the following files:
  • Sources/FreeCAD/src/Mod/Part/App/Geometry.h
  • Sources/FreeCAD/src/Mod/Part/App/Geometry.cpp