Mesh::PropertyMeshKernel Class Reference

The mesh kernel property class. More...

#include <MeshProperties.h>

Inheritance diagram for Mesh::PropertyMeshKernel:

Public Member Functions
const char *	getEditorName (void) const
	Get the class name of the associated property editor item.
virtual Base::Type	getTypeId (void) const
	PropertyMeshKernel ()
	~PropertyMeshKernel ()
Modification

void	append (const std::vector< MeshCore::MeshFacet > &rFaces, const std::vector< Base::Vector3f > &rPoints)
void	clear ()
void	createSegment (const std::vector< unsigned long > &segm)
void	deleteFacetIndices (const std::vector< unsigned long > &)
void	deletePointIndices (const std::vector< unsigned long > &)
void	finishEditing ()
void	setPointIndices (const std::vector< std::pair< unsigned long, Base::Vector3f > > &)
void	smooth (int iter, float d_max)
MeshObject *	startEditing ()
void	transformGeometry (const Base::Matrix4D &rclMat)
	Transform the real mesh data.
Save/restore

App::Property *	Copy (void) const
	Returns a new copy of the property (mainly for Undo/Redo and transactions).
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.
const Data::ComplexGeoData *	getComplexData () const
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

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? This method is defined in Base::Persistence.
const MeshObject &	getValue (void) const
	Returns a the attached mesh object by reference.
const MeshObject *	getValuePtr (void) const
void	setValue (const MeshCore::MeshKernel &m)
	This method sets the mesh by copying the data.
void	setValue (const MeshObject &m)
	This method sets the mesh by copying the data.
void	setValuePtr (MeshObject *m)
	This method references the passed mesh object and takes possession of it, it does NOT create a copy.
void	swapMesh (MeshCore::MeshKernel &)
	Swaps the mesh data structure.
void	swapMesh (MeshObject &)
	Swaps the mesh data structure.
Python interface

PyObject *	getPyObject (void)
	Returns a Python wrapper for the referenced mesh object.
void	setPyObject (PyObject *value)
	This method copies the content, hence creates an new mesh object to copy the data.
Mesh validation

void	harmonizeNormals ()
void	removeDuplicatedFacets ()
void	removeDuplicatedPoints ()
void	removeFoldsOnSurface ()
void	removeNonManifolds ()
void	removeSelfIntersections ()
void	validateDeformations (float fMaxAngle)
void	validateDegenerations ()
void	validateIndices ()
Static Public Member Functions
static void *	create (void)
static Base::Type	getClassTypeId (void)
static void	init (void)

Detailed Description

The mesh kernel property class.

Author:: Werner Mayer

Definition at line 130 of file MeshProperties.h.

Constructor & Destructor Documentation

PropertyMeshKernel::PropertyMeshKernel ( )

Definition at line 283 of file MeshProperties.cpp.

Referenced by Copy().

PropertyMeshKernel::~PropertyMeshKernel ( )

Definition at line 292 of file MeshProperties.cpp.

Member Function Documentation

void PropertyMeshKernel::append	(	const std::vector< MeshCore::MeshFacet > &	rFaces,
		const std::vector< Base::Vector3f > &	rPoints
	)

Definition at line 416 of file MeshProperties.cpp.

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

void PropertyMeshKernel::clear ( void )

Definition at line 438 of file MeshProperties.cpp.

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

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

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

Implements App::Property.

Definition at line 595 of file MeshProperties.cpp.

References PropertyMeshKernel().

void * Mesh::PropertyMeshKernel::create ( void ) [static]

Reimplemented from App::PropertyComplexGeoData.

Definition at line 47 of file MeshProperties.cpp.

void PropertyMeshKernel::createSegment ( const std::vector< unsigned long > & segm )

Definition at line 424 of file MeshProperties.cpp.

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

Referenced by MeshGui::ViewProviderMesh::segmentMesh().

void PropertyMeshKernel::deleteFacetIndices ( const std::vector< unsigned long > & inds )

Definition at line 400 of file MeshProperties.cpp.

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

Referenced by MeshGui::ViewProviderMesh::cutMesh(), MeshGui::ViewProviderMeshNode::handleEvent(), and MeshGui::ViewProviderMesh::splitMesh().

void PropertyMeshKernel::deletePointIndices ( const std::vector< unsigned long > & inds )

Definition at line 393 of file MeshProperties.cpp.

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

void PropertyMeshKernel::finishEditing ( )

Definition at line 381 of file MeshProperties.cpp.

References App::Property::hasSetValue().

Referenced by CmdMeshSmoothing::activated(), MeshGui::ViewProviderMesh::deleteSelection(), Mesh::MeshFeaturePy::harmonizeNormals(), MeshGui::DlgEvaluateMeshImp::on_repairSelfIntersectionButton_clicked(), and MeshPropertyLock::~MeshPropertyLock().

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

Returns the bounding box around the underlying mesh kernel.

Implements App::PropertyComplexGeoData.

Definition at line 355 of file MeshProperties.cpp.

Base::Type Mesh::PropertyMeshKernel::getClassTypeId ( void ) [static]

Reimplemented from App::PropertyComplexGeoData.

Definition at line 47 of file MeshProperties.cpp.

Referenced by initMeshGui().

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

Implements App::PropertyComplexGeoData.

Definition at line 350 of file MeshProperties.cpp.

const char* Mesh::PropertyMeshKernel::getEditorName ( void ) const [inline, virtual]

Get the class name of the associated property editor item.

Reimplemented from App::Property.

Definition at line 220 of file MeshProperties.h.

void PropertyMeshKernel::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 360 of file MeshProperties.cpp.

unsigned int PropertyMeshKernel::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 367 of file MeshProperties.cpp.

PyObject * PropertyMeshKernel::getPyObject ( void ) [virtual]

Returns a Python wrapper for the referenced mesh object.

It does NOT create a copy. However, the Python wrapper is marked as immutable so that the mesh object cannot be modified from outside.

Reimplemented from Base::BaseClass.

Definition at line 509 of file MeshProperties.cpp.

References Base::PyObjectBase::setConst().

Base::Type Mesh::PropertyMeshKernel::getTypeId ( void ) const [virtual]

Reimplemented from App::PropertyComplexGeoData.

Definition at line 47 of file MeshProperties.cpp.

const MeshObject & PropertyMeshKernel::getValue ( void ) const

Returns a the attached mesh object by reference.

It cannot be modified from outside.

Definition at line 340 of file MeshProperties.cpp.

const MeshObject * PropertyMeshKernel::getValuePtr ( void ) const

Definition at line 345 of file MeshProperties.cpp.

Referenced by MeshGui::ViewProviderMeshObject::updateData().

void PropertyMeshKernel::harmonizeNormals ( )

Definition at line 446 of file MeshProperties.cpp.

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

void Mesh::PropertyMeshKernel::init ( void ) [static]

Reimplemented from App::PropertyComplexGeoData.

Definition at line 47 of file MeshProperties.cpp.

Referenced by initMesh().

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

Definition at line 603 of file MeshProperties.cpp.

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

void PropertyMeshKernel::removeDuplicatedFacets ( )

Definition at line 481 of file MeshProperties.cpp.

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

Referenced by Mesh::MeshFeaturePy::removeDuplicatedFacets().

void PropertyMeshKernel::removeDuplicatedPoints ( )

Definition at line 488 of file MeshProperties.cpp.

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

Referenced by Mesh::MeshFeaturePy::removeDuplicatedPoints().

void PropertyMeshKernel::removeFoldsOnSurface ( )

Definition at line 502 of file MeshProperties.cpp.

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

Referenced by Mesh::MeshFeaturePy::removeFoldsOnSurface().

void PropertyMeshKernel::removeNonManifolds ( )

Definition at line 453 of file MeshProperties.cpp.

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

Referenced by Mesh::MeshFeaturePy::removeNonManifolds().

void PropertyMeshKernel::removeSelfIntersections ( )

Definition at line 495 of file MeshProperties.cpp.

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

Referenced by Mesh::MeshFeaturePy::fixSelfIntersections().

void PropertyMeshKernel::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 557 of file MeshProperties.cpp.

References App::Property::aboutToSetValue(), Base::XMLReader::addFile(), MeshCore::MeshKernel::Adopt(), DrawingExample::file, Base::XMLReader::getAttribute(), App::Property::hasSetValue(), MeshCore::MeshInput::LoadXML(), and Base::XMLReader::readElement().

void PropertyMeshKernel::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 588 of file MeshProperties.cpp.

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

void PropertyMeshKernel::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 544 of file MeshProperties.cpp.

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

void PropertyMeshKernel::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 583 of file MeshProperties.cpp.

References Base::Writer::Stream().

void PropertyMeshKernel::setPointIndices ( const std::vector< std::pair< unsigned long, Base::Vector3f > > & inds )

Definition at line 407 of file MeshProperties.cpp.

References App::Property::aboutToSetValue(), App::Property::hasSetValue(), and MeshCore::MeshKernel::SetPoint().

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

This method copies the content, hence creates an new mesh object to copy the data.

The passed argument can be an instance of the Python wrapper for the mesh object or simply a list of triangles, i.e. a list of lists of three floats.

Reimplemented from Base::BaseClass.

Definition at line 521 of file MeshProperties.cpp.

References Mesh::MeshObject::createMeshFromList(), draftlibs::dxfReader::error(), Mesh::MeshPy::getMeshObjectPtr(), Mesh2Shape::mesh, setValue(), setValuePtr(), and Mesh::MeshPy::Type.

void PropertyMeshKernel::setValue ( const MeshCore::MeshKernel & m )

This method sets the mesh by copying the data.

Definition at line 319 of file MeshProperties.cpp.

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

void PropertyMeshKernel::setValue ( const MeshObject & m )

This method sets the mesh by copying the data.

Definition at line 312 of file MeshProperties.cpp.

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

Referenced by CmdMeshFromGeometry::activated(), Mesh::Cube::execute(), Mesh::Torus::execute(), Mesh::Cone::execute(), Mesh::Cylinder::execute(), Mesh::Ellipsoid::execute(), Mesh::Sphere::execute(), setPyObject(), and show().

void PropertyMeshKernel::setValuePtr ( MeshObject * m )

This method references the passed mesh object and takes possession of it, it does NOT create a copy.

The currently referenced mesh object gets de-referenced and possibly deleted if its reference counter becomes zero. However, the mesh gets saved before if a transaction is open at this time.