Part::GeomPoint Class Reference

#include <Geometry.h>

Public Member Functions
virtual Geometry *	copy (void) const
	returns a copy of this object having a new randomly generated tag. More...
	GeomPoint ()
	GeomPoint (const Base::Vector3d &)
	GeomPoint (const Handle(Geom_CartesianPoint)&)
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	getPoint (void) const
virtual PyObject *	getPyObject (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_CartesianPoint)&)
void	setPoint (const Base::Vector3d &)
virtual TopoDS_Shape	toShape () const
virtual	~GeomPoint ()
Public Member Functions inherited from Part::Geometry
Geometry *	clone (void) const
	returns a cloned object. More...
void	deleteExtension (Base::Type type)
void	deleteExtension (std::string name)
const std::weak_ptr< GeometryExtension >	getExtension (Base::Type type) const
const std::weak_ptr< GeometryExtension >	getExtension (std::string name) const
const std::vector< std::weak_ptr< GeometryExtension > >	getExtensions () const
boost::uuids::uuid	getTag () const
	returns the tag of the geometry object More...
bool	hasExtension (Base::Type type) const
bool	hasExtension (std::string name) const
void	setExtension (std::unique_ptr< GeometryExtension > &&geo)
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...
bool	isDerivedFrom (const Type type) const
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 (void)
static Type	getClassTypeId (void)
static void	init (void)
Public Attributes inherited from Part::Geometry
bool	Construction
	construction geometry (means no impact on a later built topo) Note: In the Sketcher and only for the specific case of a point, it has a special meaning: a construction point has fixed coordinates for the solver (it has fixed parameters) More...
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	createNewTag ()
	create a new tag for the geometry object More...
	Geometry ()
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

GeomPoint() [1/3]

GeomPoint::GeomPoint

(

)

Referenced by copy(), and getPyObject().

GeomPoint() [2/3]

GeomPoint::GeomPoint

(

const Handle(Geom_CartesianPoint)&

p

)

References setHandle().

GeomPoint() [3/3]

GeomPoint::GeomPoint

(

const Base::Vector3d &

p

)

~GeomPoint()

GeomPoint::~GeomPoint ( )

virtual

Member Function Documentation

copy()

Geometry * GeomPoint::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::Geometry.

References Part::Geometry::Construction, and GeomPoint().

getMemSize()

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

getPoint()

Base::Vector3d GeomPoint::getPoint

(

void

)

const

Referenced by Sketcher::SketchObject::addCopy(), Sketcher::SketchObject::addSymmetric(), Sketcher::SketchObject::getPoint(), getPyObject(), Part::PointPy::representation(), and Save().

getPyObject()

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

References GeomPoint(), and getPoint().

Handle()

const Part::GeomPoint::Handle ( Geom_Geometry  ) const &

virtual

Implements Part::Geometry.

Restore()

void GeomPoint::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::readElement(), Part::Geometry::Restore(), and setPoint().

Save()

void GeomPoint::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 getPoint(), Base::Writer::ind(), Part::Geometry::Save(), Base::Writer::Stream(), Point::x, and Point::y.

setHandle()

void Part::GeomPoint::setHandle

(

const Handle(Geom_CartesianPoint)&

)

Referenced by GeomPoint().

setPoint()

void GeomPoint::setPoint

(

const Base::Vector3d &

p

)

Referenced by Sketcher::SketchObject::addCopy(), Sketcher::SketchObject::addSymmetric(), Sketcher::SketchObject::exposeInternalGeometry(), and Restore().

toShape()

TopoDS_Shape GeomPoint::toShape ( ) const

virtual

Implements Part::Geometry.

---

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

• src/Mod/Part/App/Geometry.h
• src/Mod/Part/App/Geometry.cpp