Points::PropertyCurvatureList Class Reference

The Curvature property class. More...

#include <Properties.h>

Inheritance diagram for Points::PropertyCurvatureList:

Public Types
enum	{ MeanCurvature = 0, GaussCurvature = 1, MaxCurvature = 2, MinCurvature = 3, AbsCurvature = 4 }
Public Member Functions
std::vector< float >	getCurvature (int tMode) const
int	getSize (void) const
virtual Base::Type	getTypeId (void) const
const std::vector < CurvatureInfo > &	getValues (void) const
const CurvatureInfo &	operator[] (const int idx) const
	index operator
	PropertyCurvatureList ()
void	set1Value (const int idx, const CurvatureInfo &value)
void	setSize (int newSize)
void	setValue (const CurvatureInfo &)
void	setValues (const std::vector< CurvatureInfo > &)
	~PropertyCurvatureList ()
Undo/Redo

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)
	paste the value from the property (mainly for Undo/Redo and transactions)
Modify

void	removeIndices (const std::vector< unsigned long > &)
void	transform (const Base::Matrix4D &rclMat)
Save/restore

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.
Static Public Member Functions
static void *	create (void)
static Base::Type	getClassTypeId (void)
static void	init (void)

Detailed Description

The Curvature property class.

Definition at line 110 of file Properties.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

MeanCurvature	Mean curvature.
GaussCurvature	Gaussian curvature.
MaxCurvature	Maximum curvature.
MinCurvature	Minimum curvature.
AbsCurvature	Absolute curvature.

Definition at line 115 of file Properties.h.

Constructor & Destructor Documentation

PropertyCurvatureList::PropertyCurvatureList ( )

Definition at line 135 of file Properties.cpp.

Referenced by Copy().

PropertyCurvatureList::~PropertyCurvatureList ( )

Definition at line 140 of file Properties.cpp.

Member Function Documentation

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

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

Implements App::Property.

Definition at line 307 of file Properties.cpp.

References PropertyCurvatureList().

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

Reimplemented from App::PropertyLists.

Definition at line 47 of file Properties.cpp.

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

Reimplemented from App::PropertyLists.

Definition at line 47 of file Properties.cpp.

std::vector< float > PropertyCurvatureList::getCurvature ( int tMode ) const

Definition at line 160 of file Properties.cpp.

References AbsCurvature, SketcherExample::f, GaussCurvature, getValues(), MaxCurvature, MeanCurvature, and MinCurvature.

unsigned int PropertyCurvatureList::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 322 of file Properties.cpp.

int Points::PropertyCurvatureList::getSize ( void ) const [inline, virtual]

Implements App::PropertyLists.

Definition at line 128 of file Properties.h.

Referenced by SaveDocFile(), and transform().

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

Reimplemented from App::PropertyLists.

Definition at line 47 of file Properties.cpp.

const std::vector<CurvatureInfo>& Points::PropertyCurvatureList::getValues ( void ) const [inline]

Definition at line 136 of file Properties.h.

Referenced by getCurvature().

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

Reimplemented from App::PropertyLists.

Definition at line 47 of file Properties.cpp.

Referenced by initPoints().

const CurvatureInfo& Points::PropertyCurvatureList::operator[] ( const int idx ) const [inline]

index operator

Definition at line 134 of file Properties.h.

Referenced by transform().

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

paste the value from the property (mainly for Undo/Redo and transactions)

Definition at line 314 of file Properties.cpp.

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

void PropertyCurvatureList::removeIndices ( const std::vector< unsigned long > & uIndices )

Definition at line 234 of file Properties.cpp.

References RobotExample::pos, and setValues().

void PropertyCurvatureList::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 268 of file Properties.cpp.

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

void PropertyCurvatureList::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 292 of file Properties.cpp.

References setValues().

void PropertyCurvatureList::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 261 of file Properties.cpp.

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

void PropertyCurvatureList::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 279 of file Properties.cpp.

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

void Points::PropertyCurvatureList::set1Value	(	const int	idx,
		const CurvatureInfo &	value
	)			`[inline]`

Definition at line 135 of file Properties.h.

Referenced by transform().

void Points::PropertyCurvatureList::setSize ( int newSize ) [inline, virtual]

Implements App::PropertyLists.

Definition at line 127 of file Properties.h.

void PropertyCurvatureList::setValue ( const CurvatureInfo & lValue )

Definition at line 145 of file Properties.cpp.

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

void PropertyCurvatureList::setValues ( const std::vector< CurvatureInfo > & lValues )

Definition at line 153 of file Properties.cpp.

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

Referenced by removeIndices(), and RestoreDocFile().

void PropertyCurvatureList::transform ( const Base::Matrix4D & rclMat )

Definition at line 203 of file Properties.cpp.

References ci, Points::CurvatureInfo::cMaxCurvDir, Points::CurvatureInfo::cMinCurvDir, getSize(), operator[](), set1Value(), Base::Matrix4D::setToUnity(), and KDL::sqrt().

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

Points::PropertyCurvatureList Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation