Points::PointKernel Class Reference

Point kernel. More...

#include <Points.h>

Inheritance diagram for Points::PointKernel:

Classes
class	const_point_iterator
Public Types
typedef const_point_iterator	const_iterator
typedef std::reverse_iterator < const_iterator >	const_reverse_iterator
typedef std::vector < Base::Vector3f > ::difference_type	difference_type
typedef std::vector < Base::Vector3f >::size_type	size_type
Public Member Functions
void	clear (void)
void	erase (unsigned long first, unsigned long last)
const std::vector < Base::Vector3f > &	getBasicPoints () const
std::vector< Base::Vector3f > &	getBasicPoints ()
virtual Base::BoundBox3d	getBoundBox (void) const
	Get the bound box.
void	getFaces (std::vector< Base::Vector3d > &Points, std::vector< Facet > &Topo, float Accuracy, uint16_t flags=0) const
	Get faces from object with given accuracy.
const Base::Vector3d	getPoint (const int idx) const
	get the points
Base::Matrix4D	getTransform (void) const
	Return the current matrix This method has to be handled by the child classes.
virtual Base::Type	getTypeId (void) const
void	operator= (const PointKernel &)
	PointKernel (unsigned long size)
	PointKernel (void)
void	push_back (const Base::Vector3d &point)
	insert the points
void	reserve (unsigned int n)
void	resize (unsigned int n)
void	setPoint (const int idx, const Base::Vector3d &point)
	set the points
void	setTransform (const Base::Matrix4D &rclTrf)
	Override the current transformation with the new one.
size_type	size (void) const
	number of points stored
virtual void	transformGeometry (const Base::Matrix4D &rclMat)
	Applies a transformation on the real geometric data type.
virtual	~PointKernel ()
Iterator

const_point_iterator	begin () const
const_point_iterator	end () const
const_reverse_iterator	rbegin () const
const_reverse_iterator	rend () const
Subelement management

virtual unsigned long	countSubElements (const char *Type) const
virtual std::vector< const char * >	getElementTypes (void) const
	Sub type list List of different subelement types its NOT a list of the subelements itself.
virtual Data::Segment *	getSubElement (const char *Type, unsigned long) const
	get the subelement by type and number
I/O

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?
void	load (std::istream &)
void	load (const char *file)
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 (std::ostream &) const
void	save (const char *file) const
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.
Static Public Member Functions
static void *	create (void)
static Base::Type	getClassTypeId (void)
static void	init (void)

Detailed Description

Point kernel.

Definition at line 44 of file Points.h.

Member Typedef Documentation

typedef const_point_iterator Points::PointKernel::const_iterator

Definition at line 167 of file Points.h.

typedef std::reverse_iterator<const_iterator> Points::PointKernel::const_reverse_iterator

Definition at line 168 of file Points.h.

typedef std::vector<Base::Vector3f>::difference_type Points::PointKernel::difference_type

Definition at line 105 of file Points.h.

typedef std::vector<Base::Vector3f>::size_type Points::PointKernel::size_type

Definition at line 106 of file Points.h.

Constructor & Destructor Documentation

Points::PointKernel::PointKernel ( void ) [inline]

Definition at line 49 of file Points.h.

Points::PointKernel::PointKernel ( unsigned long size ) [inline]

Definition at line 52 of file Points.h.

virtual Points::PointKernel::~PointKernel ( ) [inline, virtual]

Definition at line 56 of file Points.h.

Member Function Documentation

const_point_iterator Points::PointKernel::begin ( ) const [inline]

Definition at line 172 of file Points.h.

Referenced by Points::PointsGrid::CalculateGridLength(), PointsGui::ViewProviderPoints::cut(), Points::Export::execute(), getBoundBox(), Points::PointsPy::getPoints(), Points::PointsGrid::InitGrid(), Points::PointsGrid::PointsGrid(), Points::PointsGrid::RebuildGrid(), and Points::PointsPy::writeInventor().

void Points::PointKernel::clear ( void ) [inline]

Definition at line 116 of file Points.h.

Referenced by Points::PointsAlgos::LoadAscii(), and Restore().

unsigned long PointKernel::countSubElements ( const char * Type ) const [virtual]

Implements Data::ComplexGeoData.

Definition at line 53 of file Points.cpp.

void * Points::PointKernel::create ( void ) [static]

Reimplemented from Data::ComplexGeoData.

Definition at line 43 of file Points.cpp.

const_point_iterator Points::PointKernel::end ( ) const [inline]

Definition at line 174 of file Points.h.

Referenced by Points::PointsGrid::CalculateGridLength(), PointsGui::ViewProviderPoints::cut(), Points::Export::execute(), getBoundBox(), Points::PointsPy::getPoints(), Points::PointsGrid::InitGrid(), Points::PointsGrid::PointsGrid(), Points::PointsGrid::RebuildGrid(), and Points::PointsPy::writeInventor().

void Points::PointKernel::erase	(	unsigned long	first,
		unsigned long	last
	)			`[inline]`

Definition at line 112 of file Points.h.

Referenced by Points::PointsAlgos::LoadAscii().

const std::vector<Base::Vector3f>& Points::PointKernel::getBasicPoints ( ) const [inline]

Definition at line 78 of file Points.h.

std::vector<Base::Vector3f>& Points::PointKernel::getBasicPoints ( ) [inline]

Definition at line 76 of file Points.h.

Referenced by PointsGui::ViewProviderPointsBuilder::createPoints(), and transformGeometry().

Base::BoundBox3d PointKernel::getBoundBox ( void ) const [virtual]

Get the bound box.

Implements Data::ComplexGeoData.

Definition at line 78 of file Points.cpp.

References Base::BoundBox3< _Precision >::Add(), begin(), and end().

Base::Type Points::PointKernel::getClassTypeId ( void ) [static]

Reimplemented from Data::ComplexGeoData.

Definition at line 43 of file Points.cpp.

std::vector< const char * > PointKernel::getElementTypes ( void ) const [virtual]

Sub type list List of different subelement types its NOT a list of the subelements itself.

Implements Data::ComplexGeoData.

Definition at line 45 of file Points.cpp.

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

Get faces from object with given accuracy.

Reimplemented from Data::ComplexGeoData.

Definition at line 166 of file Points.cpp.

References getPoint().

unsigned int PointKernel::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?

Implements Base::Persistence.

Definition at line 95 of file Points.cpp.

const Base::Vector3d Points::PointKernel::getPoint ( const int idx ) const [inline]

get the points

Definition at line 120 of file Points.h.

Referenced by Inspection::InspectNominalPoints::getDistance(), getFaces(), Inspection::InspectActualPoints::getPoint(), and Points::PointsGrid::Verify().

Data::Segment * PointKernel::getSubElement	(	const char *	Type,
		unsigned long	n
	)			const `[virtual]`

get the subelement by type and number

Implements Data::ComplexGeoData.

Definition at line 58 of file Points.cpp.

Base::Matrix4D Points::PointKernel::getTransform ( void ) const [inline, virtual]

Return the current matrix This method has to be handled by the child classes.

the actual placement and matrix is not part of this class.

Implements Data::ComplexGeoData.

Definition at line 75 of file Points.h.

Referenced by Points::Feature::onChanged().

Base::Type Points::PointKernel::getTypeId ( void ) const [virtual]

Reimplemented from Data::ComplexGeoData.

Definition at line 43 of file Points.cpp.

void Points::PointKernel::init ( void ) [static]

Reimplemented from Data::ComplexGeoData.

Definition at line 43 of file Points.cpp.

void Points::PointKernel::load ( std::istream & )

void PointKernel::load ( const char * file )

Definition at line 156 of file Points.cpp.

References Points::PointsAlgos::Load().

Referenced by insert(), open(), Points::PointsPy::PyInit(), and Points::PointsPy::read().

void PointKernel::operator= ( const PointKernel & Kernel )

Reimplemented from Base::Handled.

Definition at line 86 of file Points.cpp.

References setTransform().

void Points::PointKernel::push_back ( const Base::Vector3d & point ) [inline]

insert the points

Definition at line 128 of file Points.h.

Referenced by Points::PointsPy::addPoints(), PointsGui::ViewProviderPoints::cut(), and Points::PropertyPointKernel::removeIndices().

const_reverse_iterator Points::PointKernel::rbegin ( ) const [inline]

Definition at line 176 of file Points.h.

References Sketcher::end.

const_reverse_iterator Points::PointKernel::rend ( ) const [inline]

Definition at line 178 of file Points.h.

void Points::PointKernel::reserve ( unsigned int n ) [inline]

Definition at line 111 of file Points.h.

Referenced by Points::PropertyPointKernel::removeIndices().

void Points::PointKernel::resize ( unsigned int n ) [inline]

Definition at line 110 of file Points.h.

Referenced by Points::PointsAlgos::LoadAscii().

void PointKernel::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 120 of file Points.cpp.

References Base::XMLReader::addFile(), clear(), Base::XMLReader::DocumentSchema, DrawingExample::file, Base::Matrix4D::fromString(), Base::XMLReader::getAttribute(), and Base::XMLReader::readElement().

void PointKernel::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 137 of file Points.cpp.

References MovieTool::x, and MovieTool::y.

void PointKernel::save ( std::ostream & out ) const

Definition at line 161 of file Points.cpp.

void PointKernel::save ( const char * file ) const

Definition at line 150 of file Points.cpp.

Referenced by Points::PointsPy::write().

void PointKernel::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 100 of file Points.cpp.

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

void PointKernel::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 109 of file Points.cpp.

References size(), and Base::Writer::Stream().

void Points::PointKernel::setPoint	(	const int	idx,
		const Base::Vector3d &	point
	)			`[inline]`

set the points

Definition at line 124 of file Points.h.

Referenced by Points::PointsAlgos::LoadAscii().

void Points::PointKernel::setTransform ( const Base::Matrix4D & rclTrf ) [inline, virtual]

Override the current transformation with the new one.

This method has to be handled by the child classes. the actual placement and matrix is not part of this class.

Implements Data::ComplexGeoData.

Definition at line 74 of file Points.h.

Referenced by Points::Feature::onChanged(), operator=(), and Points::PropertyPointKernel::removeIndices().

size_type Points::PointKernel::size ( void ) const [inline]

number of points stored

Definition at line 109 of file Points.h.

Referenced by Inspection::InspectActualPoints::countPoints(), PointsGui::ViewProviderPointsBuilder::createPoints(), PointsGui::ViewProviderPoints::cut(), Points::Export::execute(), Points::PointsAlgos::LoadAscii(), Points::PointsGrid::RebuildGrid(), SaveDocFile(), Points::PointsGrid::Validate(), and Points::PointsGrid::Verify().

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

Applies a transformation on the real geometric data type.

Implements Data::ComplexGeoData.

Definition at line 71 of file Points.cpp.

References getBasicPoints().

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

Points::PointKernel Class Reference

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation