Mesh::PropertyNormalList Class Reference

The normals property class. More...

#include <MeshProperties.h>

Public Member Functions

virtual App::PropertyCopy (void) const
 Returns a new copy of the property (mainly for Undo/Redo and transactions) More...
 
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. More...
 
virtual PyObjectgetPyObject (void)
 This method returns the Python wrapper for a C++ object. More...
 
virtual int getSize (void) const
 
const std::vector< Base::Vector3f > & getValues (void) const
 
const Base::Vector3foperator[] (const int idx) const
 
virtual void Paste (const App::Property &from)
 Paste the value from the property (mainly for Undo/Redo and transactions) More...
 
 PropertyNormalList ()
 
virtual void Restore (Base::XMLReader &reader)
 This method is used to restore properties from an XML document. More...
 
virtual 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. More...
 
virtual void Save (Base::Writer &writer) const
 This method is used to save properties to an XML document. More...
 
virtual void SaveDocFile (Base::Writer &writer) const
 This method is used to save large amounts of data to a binary file. More...
 
void set1Value (const int idx, const Base::Vector3f &value)
 
virtual void setPyObject (PyObject *)
 
virtual void setSize (int newSize)
 
void setValue (const Base::Vector3f &)
 
void setValue (float x, float y, float z)
 
void setValues (const std::vector< Base::Vector3f > &values)
 
void transformGeometry (const Base::Matrix4D &rclMat)
 
 ~PropertyNormalList ()
 
- Public Member Functions inherited from App::Property
virtual const App::ObjectIdentifier canonicalPath (const App::ObjectIdentifier &p) const
 Convert p to a canonical representation of it. More...
 
PropertyContainergetContainer (void) const
 Get a pointer to the PropertyContainer derived class the property belongs to. More...
 
const char * getDocumentation (void) const
 Get the documentation of this property. More...
 
virtual const char * getEditorName (void) const
 Get the class name of the associated property editor item. More...
 
const char * getGroup (void) const
 Get the group of this property. More...
 
const char * getName (void) const
 get the name of this property in the belonging container More...
 
virtual void getPaths (std::vector< App::ObjectIdentifier > &paths) const
 Get valid paths for this property; used by auto completer. More...
 
virtual const boost::any getPathValue (const App::ObjectIdentifier &path) const
 Get value of property. More...
 
short getType (void) const
 Get the type of the property in the container. More...
 
 Property ()
 
void setContainer (PropertyContainer *Father)
 Is called by the framework to set the father (container) More...
 
virtual void setPathValue (const App::ObjectIdentifier &path, const boost::any &value)
 Set value of property. More...
 
virtual ~Property ()
 
void touch ()
 Property status handling. More...
 
bool isTouched (void) const
 Test if this property is touched. More...
 
void purgeTouched (void)
 Reset this property touched. More...
 
unsigned long getStatus () const
 return the status bits More...
 
bool testStatus (Status pos) const
 
void setStatus (Status pos, bool on)
 
void setReadOnly (bool readOnly)
 Sets property editable/grayed out in property editor. More...
 
bool isReadOnly () const
 
- Public Member Functions inherited from Base::Persistence
virtual Base::Type getTypeId (void) const
 
- Public Member Functions inherited from Base::BaseClass
 BaseClass ()
 Construction. More...
 
bool isDerivedFrom (const Type type) const
 
virtual ~BaseClass ()
 Destruction. More...
 

Additional Inherited Members

- Public Types inherited from App::Property
- Static Public Member Functions inherited from App::Property
static std::string encodeAttribute (const std::string &)
 Encodes an attribute upon saving. More...
 
- Static Public Member Functions inherited from Base::Persistence
static void * create (void)
 
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)
 
- Protected Member Functions inherited from App::Property
void aboutToSetValue (void)
 Gets called by all setValue() methods before the value has changed. More...
 
void hasSetValue (void)
 Gets called by all setValue() methods after the value has changed. More...
 
virtual void verifyPath (const App::ObjectIdentifier &p) const
 Verify a path for the current property. More...
 
- Static Protected Member Functions inherited from Base::BaseClass
static void initSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Type::instantiationMethod method=0)
 
- Protected Attributes inherited from App::Property
std::bitset< 32 > StatusBits
 Status bits of the property The first 8 bits are used for the base system the rest can be used in descendent classes to to mark special stati on the objects. More...
 

Detailed Description

The normals property class.

Note: We need an own class for that to distinguish from the base vector list.

Author
Werner Mayer

Constructor & Destructor Documentation

PropertyNormalList::PropertyNormalList ( )

Referenced by Copy().

PropertyNormalList::~PropertyNormalList ( )

Member Function Documentation

App::Property * PropertyNormalList::Copy ( void  ) const
virtual

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

Implements App::Property.

References PropertyNormalList().

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

PyObject * PropertyNormalList::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 getSize().

const std::vector<Base::Vector3f>& Mesh::PropertyNormalList::getValues ( void  ) const
inline
const Base::Vector3f& Mesh::PropertyNormalList::operator[] ( const int  idx) const
inline
void PropertyNormalList::Paste ( const App::Property from)
virtual

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

Implements App::Property.

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

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

Implements Base::Persistence.

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

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

{
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:

{
_pcMesh->Read( reader );
}
See also
Base::Reader,Base::XMLReader

Reimplemented from Base::Persistence.

References setValues().

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

Implements Base::Persistence.

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

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

{
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:

{
_pcMesh->Write( writer );
}

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

Reimplemented from Base::Persistence.

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

void Mesh::PropertyNormalList::set1Value ( const int  idx,
const Base::Vector3f value 
)
inline

Referenced by transformGeometry().

void PropertyNormalList::setPyObject ( PyObject value)
virtual
void PropertyNormalList::setSize ( int  newSize)
virtual

Implements App::PropertyLists.

void PropertyNormalList::setValue ( const Base::Vector3f lValue)
void PropertyNormalList::setValue ( float  x,
float  y,
float  z 
)
void PropertyNormalList::setValues ( const std::vector< Base::Vector3f > &  values)
void PropertyNormalList::transformGeometry ( const Base::Matrix4D rclMat)

The documentation for this class was generated from the following files:
  • src/src/Mod/Mesh/App/MeshProperties.h
  • src/src/Mod/Mesh/App/MeshProperties.cpp