Part::PropertyPartShape Class Reference

The part shape property class. More...

#include <PropertyTopoShape.h>

Inheritance diagram for Part::PropertyPartShape:

Public Member Functions
virtual Base::Type	getTypeId (void) const
	PropertyPartShape ()
	~PropertyPartShape ()
Save/restore

App::Property *	Copy (void) const
	Returns a new copy of the property (mainly for Undo/Redo and transactions).
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? This method is defined in Base::Persistence.
void	Paste (const App::Property &from)
void	Restore (Base::XMLReader &reader)
	This method is used to restore properties from an XML document.
void	RestoreDocFile (Base::Reader &reader)
	This method is used to restore large amounts of data from a file In this method you simply stream in your with SaveDocFile() saved data.
void	Save (Base::Writer &writer) const
	This method is used to save properties to an XML document.
void	SaveDocFile (Base::Writer &writer) const
	This method is used to save large amounts of data to a binary file.
Getting basic geometric entities

Base::BoundBox3d	getBoundingBox () const
	Returns the bounding box around the underlying mesh kernel.
virtual void	getFaces (std::vector< Base::Vector3d > &Points, std::vector< Data::ComplexGeoData::Facet > &Topo, float Accuracy, uint16_t flags=0) const
	Get faces from object with given accuracy.
Getter/setter

const Data::ComplexGeoData *	getComplexData () const
const TopoShape &	getShape () const
const TopoDS_Shape &	getValue (void) const
	get the part shape
void	setValue (const TopoDS_Shape &)
	set the part shape
void	setValue (const TopoShape &)
	set the part shape
Python interface

PyObject *	getPyObject (void)
	This method returns the Python wrapper for a C++ object.
void	setPyObject (PyObject *value)
Modification

void	transformGeometry (const Base::Matrix4D &rclMat)
	Transform the real shape data.
Static Public Member Functions
static void *	create (void)
static Base::Type	getClassTypeId (void)
static void	init (void)

Detailed Description

The part shape property class.

Author:: Werner Mayer

Definition at line 39 of file PropertyTopoShape.h.

Constructor & Destructor Documentation

PropertyPartShape::PropertyPartShape ( )

Definition at line 71 of file PropertyTopoShape.cpp.

Referenced by Copy().

PropertyPartShape::~PropertyPartShape ( )

Definition at line 75 of file PropertyTopoShape.cpp.

Member Function Documentation

App::Property * PropertyPartShape::Copy ( void ) const [virtual]

Returns a new copy of the property (mainly for Undo/Redo and transactions).

Implements App::Property.

Definition at line 193 of file PropertyTopoShape.cpp.

References Part::TopoShape::_Shape, draftlibs::dxfLibrary::copy, and PropertyPartShape().

void * Part::PropertyPartShape::create ( void ) [static]

Reimplemented from App::PropertyComplexGeoData.

Definition at line 69 of file PropertyTopoShape.cpp.

Base::BoundBox3d PropertyPartShape::getBoundingBox ( ) const [virtual]

Returns the bounding box around the underlying mesh kernel.

Implements App::PropertyComplexGeoData.

Definition at line 108 of file PropertyTopoShape.cpp.

References Part::TopoShape::_Shape, KDL::Add(), Base::BoundBox3< _Precision >::MaxX, Base::BoundBox3< _Precision >::MaxY, Base::BoundBox3< _Precision >::MaxZ, Base::BoundBox3< _Precision >::MinX, Base::BoundBox3< _Precision >::MinY, and Base::BoundBox3< _Precision >::MinZ.

Base::Type Part::PropertyPartShape::getClassTypeId ( void ) [static]

Reimplemented from App::PropertyComplexGeoData.

Definition at line 69 of file PropertyTopoShape.cpp.

Referenced by initPartGui().

const Data::ComplexGeoData * PropertyPartShape::getComplexData ( ) const [virtual]

Implements App::PropertyComplexGeoData.

Definition at line 103 of file PropertyTopoShape.cpp.

void PropertyPartShape::getFaces	(	std::vector< Base::Vector3d > &	Points,
		std::vector< Data::ComplexGeoData::Facet > &	Topo,
		float	Accuracy,
		uint16_t	flags = `0`
	)			const `[virtual]`

Get faces from object with given accuracy.

Implements App::PropertyComplexGeoData.

Definition at line 134 of file PropertyTopoShape.cpp.

References Part::TopoShape::getFaces().

unsigned int PropertyPartShape::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? This method is defined in Base::Persistence.

See also:: Base::Persistence

Reimplemented from App::Property.

Definition at line 212 of file PropertyTopoShape.cpp.

References Part::TopoShape::getMemSize().

PyObject * PropertyPartShape::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 148 of file PropertyTopoShape.cpp.

References Part::TopoShape::_Shape, and Py::type().

const TopoShape & PropertyPartShape::getShape ( ) const

Definition at line 98 of file PropertyTopoShape.cpp.

Referenced by Part::Revolution::execute(), Part::Mirroring::execute(), Part::Extrusion::execute(), Part::Feature::getPySubObjects(), and Part::Feature::onChanged().

Base::Type Part::PropertyPartShape::getTypeId ( void ) const [virtual]

Reimplemented from App::PropertyComplexGeoData.

Definition at line 69 of file PropertyTopoShape.cpp.

const TopoDS_Shape & PropertyPartShape::getValue ( void ) const

get the part shape

Definition at line 93 of file PropertyTopoShape.cpp.

References Part::TopoShape::_Shape.

Referenced by CmdSketcherMapSketch::activated(), CmdSketcherNewSketch::activated(), Part::RuledSurface::execute(), Part::Boolean::execute(), Part::Fillet::execute(), Part::Chamfer::execute(), and exporter().

void Part::PropertyPartShape::init ( void ) [static]

Reimplemented from App::PropertyComplexGeoData.

Definition at line 69 of file PropertyTopoShape.cpp.

Referenced by initPart().

void PropertyPartShape::Paste ( const App::Property & from )

Definition at line 205 of file PropertyTopoShape.cpp.

References App::Property::aboutToSetValue(), and App::Property::hasSetValue().

void PropertyPartShape::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");
 }

Implements Base::Persistence.

Definition at line 227 of file PropertyTopoShape.cpp.

References Base::XMLReader::addFile(), DrawingExample::file, Base::XMLReader::getAttribute(), and Base::XMLReader::readElement().

void PropertyPartShape::RestoreDocFile ( Base::Reader & ) [virtual]

This method is used to restore large amounts of data from a file In this method you simply stream in your with SaveDocFile() saved data.

Again you have to apply for the call of this method in the Restore() call:

 void PropertyMeshKernel::Restore(Base::XMLReader &reader)
 {
   reader.readElement("Mesh");
   std::string file (reader.getAttribute("file") );
 
   if(file == "")
   {
     // read XML
     MeshCore::MeshDocXML restorer(*_pcMesh);
     restorer.Restore(reader);
   }else{
     // initate a file read
     reader.addFile(file.c_str(),this);
  }
 }

After you issued the reader.addFile() your RestoreDocFile() is called:

 void PropertyMeshKernel::RestoreDocFile(Base::Reader &reader)
 {
     _pcMesh->Read( reader );
 }

See also:: Base::Reader,Base::XMLReader

Reimplemented from Base::Persistence.

Definition at line 291 of file PropertyTopoShape.cpp.

References Base::Console(), Base::FileInfo::deleteFile(), DrawingExample::file, Base::FileInfo::filePath(), App::PropertyContainer::getClassTypeId(), App::Property::getContainer(), Base::FileInfo::getTempFileName(), Base::BaseClass::isDerivedFrom(), App::DocumentObject::Label, and setValue().

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

Implements Base::Persistence.

Definition at line 217 of file PropertyTopoShape.cpp.

References Base::Writer::addFile(), Base::Writer::ind(), Base::Writer::isForceXML(), and Base::Writer::Stream().

void PropertyPartShape::SaveDocFile ( Base::Writer & ) const [virtual]

This method is used to save large amounts of data to a binary file.

Sometimes it makes no sense to write property data as XML. In case the amount of data is too big or the data type has a more effective way to save itself. In this cases it is possible to write the data in a seperate file inside the document archive. In case you want do so you have to re-implement SaveDocFile(). First, you have to inform the framework in Save() that you want do so. Here an example from the Mesh module which can save a (pontetionaly big) triangle mesh:

 void PropertyMeshKernel::Save (Base::Writer &writer) const
 {
   if (writer.isForceXML())
   {
     writer << writer.ind() << "<Mesh>" << std::endl;
     MeshCore::MeshDocXML saver(*_pcMesh);
     saver.Save(writer);
   }else{
    writer << writer.ind() << "<Mesh file=\"" << writer.addFile("MeshKernel.bms", this) << "\"/>" << std::endl;
 }

The writer.isForceXML() is an indication to force you to write XML. Regardless of size and effectivness. The second part informs the Base::writer through writer.addFile("MeshKernel.bms", this) that this object wants to write a file with the given name. The method addFile() returns a unique name that then is written in the XML stream. This allows your RestoreDocFile() method to identify and read the file again. Later your SaveDocFile() method is called as many times as you issued the addFile() call:

 void PropertyMeshKernel::SaveDocFile (Base::Writer &writer) const
 {
     _pcMesh->Write( writer );
 }

In this method you can simply stream your content to the file (Base::Writer inheriting from ostream).

Reimplemented from Base::Persistence.

Definition at line 238 of file PropertyTopoShape.cpp.

References Part::TopoShape::_Shape, Base::Console(), Base::FileInfo::deleteFile(), Sketcher::end, DrawingExample::file, Base::FileInfo::filePath(), App::PropertyContainer::getClassTypeId(), App::Property::getContainer(), Base::FileInfo::getTempFileName(), Base::BaseClass::isDerivedFrom(), App::DocumentObject::Label, and Base::Writer::Stream().

void PropertyPartShape::setPyObject ( PyObject * value ) [virtual]

Reimplemented from Base::BaseClass.

Definition at line 180 of file PropertyTopoShape.cpp.

References draftlibs::dxfReader::error(), Part::TopoShapePy::getTopoShapePtr(), setValue(), and Part::TopoShapePy::Type.

void PropertyPartShape::setValue ( const TopoDS_Shape & sh )

set the part shape

Definition at line 86 of file PropertyTopoShape.cpp.

References Part::TopoShape::_Shape, App::Property::aboutToSetValue(), and App::Property::hasSetValue().

void PropertyPartShape::setValue ( const TopoShape & sh )

set the part shape

Definition at line 79 of file PropertyTopoShape.cpp.

References App::Property::aboutToSetValue(), and App::Property::hasSetValue().

Referenced by Part::Wedge::execute(), Part::Helix::execute(), Part::Torus::execute(), Part::Cone::execute(), Part::Cylinder::execute(), Part::Ellipsoid::execute(), Part::Sphere::execute(), Part::Plane::execute(), Part::Vertex::execute(), Part::Loft::execute(), Part::RuledSurface::execute(), Part::Revolution::execute(), Part::Polygon::execute(), Part::ImportStep::execute(), Part::ImportIges::execute(), Part::ImportBrep::execute(), Part::MultiFuse::execute(), Part::CurveNet::execute(), Part::MultiCommon::execute(), Part::Circle::execute(), Part::Box::execute(), Part::Boolean::execute(), PartDesign::Pad::execute(), Part::Mirroring::execute(), Part::FeatureGeometrySet::execute(), Part::Fillet::execute(), Part::Extrusion::execute(), Part::Chamfer::execute(), Part::ImportIgesParts(), Part::ImportStepParts(), RestoreDocFile(), setPyObject(), and show().

void PropertyPartShape::transformGeometry ( const Base::Matrix4D & rclMat ) [virtual]

Transform the real shape data.

Implements App::PropertyComplexGeoData.

Definition at line 141 of file PropertyTopoShape.cpp.

References App::Property::aboutToSetValue(), App::Property::hasSetValue(), and Part::TopoShape::transformGeometry().

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

Part::PropertyPartShape Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation