App::PropertyVector Class Reference

Vector properties This is the father of all properties handling Integers. More...

#include <PropertyGeo.h>

Inheritance diagram for App::PropertyVector:

Public Member Functions
virtual Property *	Copy (void) const
	Returns a new copy of the property (mainly for Undo/Redo and transactions).
const char *	getEditorName (void) const
	Get the class name of the associated property editor item.
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.
virtual PyObject *	getPyObject (void)
	This method returns the Python wrapper for a C++ object.
virtual Base::Type	getTypeId (void) const
const Base::Vector3f &	getValue (void) const
	This method returns a string representation of the property.
virtual void	Paste (const Property &from)
	PropertyVector ()
	A constructor.
virtual void	Restore (Base::XMLReader &reader)
	This method is used to restore properties from an XML document.
virtual void	Save (Base::Writer &writer) const
	This method is used to save properties to an XML document.
virtual void	setPyObject (PyObject *)
void	setValue (float x, float y, float z)
void	setValue (const Base::Vector3f &vec)
	Sets the property.
	~PropertyVector ()
	A destructor.
Static Public Member Functions
static void *	create (void)
static Base::Type	getClassTypeId (void)
static void	init (void)

Detailed Description

Vector properties This is the father of all properties handling Integers.

Definition at line 56 of file PropertyGeo.h.

Constructor & Destructor Documentation

PropertyVector::PropertyVector ( )

A constructor.

A more elaborate description of the constructor.

Definition at line 63 of file PropertyGeo.cpp.

Referenced by Copy().

PropertyVector::~PropertyVector ( )

A destructor.

A more elaborate description of the destructor.

Definition at line 69 of file PropertyGeo.cpp.

Member Function Documentation

Property * PropertyVector::Copy ( void ) const [virtual]

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

Implements App::Property.

Definition at line 164 of file PropertyGeo.cpp.

References draftTools::p, and PropertyVector().

void * App::PropertyVector::create ( void ) [static]

Reimplemented from App::Property.

Definition at line 57 of file PropertyGeo.cpp.

Base::Type App::PropertyVector::getClassTypeId ( void ) [static]

Reimplemented from App::Property.

Definition at line 57 of file PropertyGeo.cpp.

Referenced by Gui::PropertyEditor::PropertyVectorItem::value().

const char* App::PropertyVector::getEditorName ( void ) const [inline, virtual]

Get the class name of the associated property editor item.

Reimplemented from App::Property.

Definition at line 81 of file PropertyGeo.h.

virtual unsigned int App::PropertyVector::getMemSize ( void ) const [inline, 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 94 of file PropertyGeo.h.

PyObject * PropertyVector::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 97 of file PropertyGeo.cpp.

Base::Type App::PropertyVector::getTypeId ( void ) const [virtual]

Reimplemented from App::Property.

Definition at line 57 of file PropertyGeo.cpp.

const Base::Vector3f & PropertyVector::getValue ( void ) const

This method returns a string representation of the property.

Definition at line 92 of file PropertyGeo.cpp.

Referenced by App::MeasureDistance::execute(), Drawing::FeatureViewPart::execute(), PartDesign::Revolution::execute(), Part::Revolution::execute(), Drawing::FeatureProjection::execute(), Part::Mirroring::execute(), Mesh::SegmentByMesh::execute(), Part::Extrusion::execute(), Part::Box::Restore(), PartGui::ViewProviderMirror::setEdit(), App::PropertyVectorList::setPyObject(), and PartDesignGui::TaskRevolutionParameters::TaskRevolutionParameters().

void App::PropertyVector::init ( void ) [static]

Reimplemented from App::Property.

Definition at line 57 of file PropertyGeo.cpp.

void PropertyVector::Paste ( const Property & from ) [virtual]

Definition at line 171 of file PropertyGeo.cpp.

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

void PropertyVector::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 151 of file PropertyGeo.cpp.

References App::Property::aboutToSetValue(), Base::XMLReader::getAttributeAsFloat(), App::Property::hasSetValue(), Base::XMLReader::readElement(), Base::Vector3< _Precision >::x, Base::Vector3< _Precision >::y, and Base::Vector3< _Precision >::z.

void PropertyVector::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.