08cdd323b6
To compare if two property contains the same content. The default implementation in Property uses the persistense interface to save both properties to string and compares the content. This may not work at the moment if the property saves content in separate file or in binary. Various properties have cheaper implementation to direct compare their internal values.
543 lines
15 KiB
C++
543 lines
15 KiB
C++
/***************************************************************************
|
|
* Copyright (c) 2002 Jürgen Riegel <juergen.riegel@web.de> *
|
|
* *
|
|
* This file is part of the FreeCAD CAx development system. *
|
|
* *
|
|
* This library is free software; you can redistribute it and/or *
|
|
* modify it under the terms of the GNU Library General Public *
|
|
* License as published by the Free Software Foundation; either *
|
|
* version 2 of the License, or (at your option) any later version. *
|
|
* *
|
|
* This library is distributed in the hope that it will be useful, *
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
|
|
* GNU Library General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU Library General Public *
|
|
* License along with this library; see the file COPYING.LIB. If not, *
|
|
* write to the Free Software Foundation, Inc., 59 Temple Place, *
|
|
* Suite 330, Boston, MA 02111-1307, USA *
|
|
* *
|
|
***************************************************************************/
|
|
|
|
|
|
#ifndef APP_PROPERTYGEO_H
|
|
#define APP_PROPERTYGEO_H
|
|
|
|
// Std. configurations
|
|
|
|
#include <Base/Vector3D.h>
|
|
#include <Base/Matrix.h>
|
|
#include <Base/BoundBox.h>
|
|
#include <Base/Placement.h>
|
|
#include <Base/Unit.h>
|
|
|
|
#include "Property.h"
|
|
#include "PropertyLinks.h"
|
|
#include "ComplexGeoData.h"
|
|
#include <FCGlobal.h>
|
|
|
|
namespace Base {
|
|
class Writer;
|
|
}
|
|
|
|
namespace Data {
|
|
class ComplexGeoData;
|
|
}
|
|
|
|
namespace App
|
|
{
|
|
class Feature;
|
|
class Placement;
|
|
|
|
|
|
|
|
/** Vector properties
|
|
* This is the father of all properties handling Integers.
|
|
*/
|
|
class AppExport PropertyVector: public Property
|
|
{
|
|
TYPESYSTEM_HEADER_WITH_OVERRIDE();
|
|
|
|
public:
|
|
/**
|
|
* A constructor.
|
|
* A more elaborate description of the constructor.
|
|
*/
|
|
PropertyVector();
|
|
|
|
/**
|
|
* A destructor.
|
|
* A more elaborate description of the destructor.
|
|
*/
|
|
virtual ~PropertyVector();
|
|
|
|
/** Sets the property
|
|
*/
|
|
void setValue(const Base::Vector3d &vec);
|
|
void setValue(double x, double y, double z);
|
|
|
|
/// Get valid paths for this property; used by auto completer
|
|
void getPaths(std::vector<ObjectIdentifier> &paths) const override;
|
|
|
|
/** This method returns a string representation of the property
|
|
*/
|
|
const Base::Vector3d &getValue(void) const;
|
|
const char* getEditorName(void) const override {
|
|
return "Gui::PropertyEditor::PropertyVectorItem";
|
|
}
|
|
|
|
virtual PyObject *getPyObject(void) override;
|
|
virtual void setPyObject(PyObject *) override;
|
|
|
|
virtual void Save (Base::Writer &writer) const override;
|
|
virtual void Restore(Base::XMLReader &reader) override;
|
|
|
|
virtual Property *Copy(void) const override;
|
|
virtual void Paste(const Property &from) override;
|
|
|
|
virtual unsigned int getMemSize (void) const override {
|
|
return sizeof(Base::Vector3d);
|
|
}
|
|
|
|
virtual const boost::any getPathValue(const ObjectIdentifier &path) const override;
|
|
|
|
virtual bool getPyPathValue(const ObjectIdentifier &path, Py::Object &res) const override;
|
|
|
|
virtual Base::Unit getUnit() const {
|
|
return Base::Unit();
|
|
}
|
|
|
|
virtual bool isSame(const Property &other) const override {
|
|
return getTypeId() == other.getTypeId()
|
|
&& getValue() == static_cast<decltype(this)>(&other)->getValue();
|
|
}
|
|
|
|
private:
|
|
Base::Vector3d _cVec;
|
|
};
|
|
|
|
|
|
class AppExport PropertyVectorDistance: public PropertyVector
|
|
{
|
|
TYPESYSTEM_HEADER();
|
|
|
|
public:
|
|
/**
|
|
* A constructor.
|
|
* A more elaborate description of the constructor.
|
|
*/
|
|
PropertyVectorDistance();
|
|
|
|
/**
|
|
* A destructor.
|
|
* A more elaborate description of the destructor.
|
|
*/
|
|
virtual ~PropertyVectorDistance();
|
|
|
|
virtual Base::Unit getUnit() const {
|
|
return Base::Unit::Length;
|
|
}
|
|
|
|
const char* getEditorName(void) const {
|
|
return "Gui::PropertyEditor::PropertyVectorDistanceItem";
|
|
}
|
|
};
|
|
|
|
class AppExport PropertyPosition: public PropertyVector
|
|
{
|
|
TYPESYSTEM_HEADER();
|
|
|
|
public:
|
|
/**
|
|
* A constructor.
|
|
* A more elaborate description of the constructor.
|
|
*/
|
|
PropertyPosition();
|
|
|
|
/**
|
|
* A destructor.
|
|
* A more elaborate description of the destructor.
|
|
*/
|
|
virtual ~PropertyPosition();
|
|
|
|
virtual Base::Unit getUnit() const {
|
|
return Base::Unit::Length;
|
|
}
|
|
|
|
const char* getEditorName(void) const {
|
|
return "Gui::PropertyEditor::PropertyPositionItem";
|
|
}
|
|
};
|
|
|
|
class AppExport PropertyDirection: public PropertyVector
|
|
{
|
|
TYPESYSTEM_HEADER();
|
|
|
|
public:
|
|
/**
|
|
* A constructor.
|
|
* A more elaborate description of the constructor.
|
|
*/
|
|
PropertyDirection();
|
|
|
|
/**
|
|
* A destructor.
|
|
* A more elaborate description of the destructor.
|
|
*/
|
|
virtual ~PropertyDirection();
|
|
|
|
virtual Base::Unit getUnit() const {
|
|
return Base::Unit::Length;
|
|
}
|
|
|
|
const char* getEditorName(void) const {
|
|
return "Gui::PropertyEditor::PropertyDirectionItem";
|
|
}
|
|
};
|
|
|
|
class AppExport PropertyVectorList: public PropertyListsT<Base::Vector3d>
|
|
{
|
|
TYPESYSTEM_HEADER_WITH_OVERRIDE();
|
|
|
|
typedef PropertyListsT<Base::Vector3d> inherited;
|
|
|
|
public:
|
|
/**
|
|
* A constructor.
|
|
* A more elaborate description of the constructor.
|
|
*/
|
|
PropertyVectorList();
|
|
|
|
/**
|
|
* A destructor.
|
|
* A more elaborate description of the destructor.
|
|
*/
|
|
virtual ~PropertyVectorList();
|
|
|
|
void setValue(double x, double y, double z);
|
|
using inherited::setValue;
|
|
|
|
virtual PyObject *getPyObject(void) override;
|
|
|
|
virtual void Save (Base::Writer &writer) const override;
|
|
virtual void Restore(Base::XMLReader &reader) override;
|
|
|
|
virtual void SaveDocFile (Base::Writer &writer) const override;
|
|
virtual void RestoreDocFile(Base::Reader &reader) override;
|
|
|
|
virtual Property *Copy(void) const override;
|
|
virtual void Paste(const Property &from) override;
|
|
|
|
virtual unsigned int getMemSize (void) const override;
|
|
const char* getEditorName(void) const override {
|
|
return "Gui::PropertyEditor::PropertyVectorListItem";
|
|
}
|
|
|
|
protected:
|
|
Base::Vector3d getPyValue(PyObject *) const override;
|
|
};
|
|
|
|
/// Property representing a 4x4 matrix
|
|
/*!
|
|
* Encapsulates a Base::Matrix4D in a Property
|
|
*/
|
|
class AppExport PropertyMatrix: public Property
|
|
{
|
|
TYPESYSTEM_HEADER();
|
|
|
|
public:
|
|
/**
|
|
* A constructor.
|
|
* Intitialises to an identity matrix
|
|
*/
|
|
PropertyMatrix();
|
|
|
|
/**
|
|
* A destructor.
|
|
* A more elaborate description of the destructor.
|
|
*/
|
|
virtual ~PropertyMatrix();
|
|
|
|
/** Sets the property
|
|
*/
|
|
void setValue(const Base::Matrix4D &mat);
|
|
|
|
/** This method returns a string representation of the property
|
|
*/
|
|
const Base::Matrix4D &getValue(void) const;
|
|
const char* getEditorName(void) const {
|
|
return "Gui::PropertyEditor::PropertyMatrixItem";
|
|
}
|
|
|
|
virtual PyObject *getPyObject(void);
|
|
virtual void setPyObject(PyObject *);
|
|
|
|
virtual void Save (Base::Writer &writer) const;
|
|
virtual void Restore(Base::XMLReader &reader);
|
|
|
|
virtual Property *Copy(void) const;
|
|
virtual void Paste(const Property &from);
|
|
|
|
virtual unsigned int getMemSize (void) const {
|
|
return sizeof(Base::Matrix4D);
|
|
}
|
|
|
|
virtual bool isSame(const Property &other) const {
|
|
return getTypeId() == other.getTypeId()
|
|
&& getValue() == static_cast<decltype(this)>(&other)->getValue();
|
|
}
|
|
|
|
private:
|
|
Base::Matrix4D _cMat;
|
|
};
|
|
|
|
/// Property representing a placement
|
|
/*!
|
|
* Encapsulates a Base::Placement in a Property
|
|
*/
|
|
class AppExport PropertyPlacement: public Property
|
|
{
|
|
TYPESYSTEM_HEADER_WITH_OVERRIDE();
|
|
|
|
public:
|
|
/**
|
|
* A constructor.
|
|
* A more elaborate description of the constructor.
|
|
*/
|
|
PropertyPlacement();
|
|
|
|
/**
|
|
* A destructor.
|
|
* A more elaborate description of the destructor.
|
|
*/
|
|
virtual ~PropertyPlacement();
|
|
|
|
/** Sets the property
|
|
*/
|
|
void setValue(const Base::Placement &pos);
|
|
|
|
/** Sets property only if changed
|
|
* @param pos: input placement
|
|
* @param tol: position tolerance
|
|
* @param atol: angular tolerance
|
|
*/
|
|
bool setValueIfChanged(const Base::Placement &pos,
|
|
double tol=1e-7, double atol=1e-12);
|
|
|
|
/** This method returns a string representation of the property
|
|
*/
|
|
const Base::Placement &getValue(void) const;
|
|
|
|
/// Get valid paths for this property; used by auto completer
|
|
void getPaths(std::vector<ObjectIdentifier> &paths) const override;
|
|
|
|
void setPathValue(const ObjectIdentifier &path, const boost::any &value) override;
|
|
|
|
virtual const boost::any getPathValue(const ObjectIdentifier &path) const override;
|
|
|
|
virtual bool getPyPathValue(const ObjectIdentifier &path, Py::Object &res) const override;
|
|
|
|
const char* getEditorName(void) const override {
|
|
return "Gui::PropertyEditor::PropertyPlacementItem";
|
|
}
|
|
|
|
virtual PyObject *getPyObject(void) override;
|
|
virtual void setPyObject(PyObject *) override;
|
|
|
|
virtual void Save (Base::Writer &writer) const override;
|
|
virtual void Restore(Base::XMLReader &reader) override;
|
|
|
|
virtual Property *Copy(void) const override;
|
|
virtual void Paste(const Property &from) override;
|
|
|
|
virtual unsigned int getMemSize (void) const override {
|
|
return sizeof(Base::Placement);
|
|
}
|
|
|
|
virtual bool isSame(const Property &other) const override {
|
|
return getTypeId() == other.getTypeId()
|
|
&& getValue() == static_cast<decltype(this)>(&other)->getValue();
|
|
}
|
|
|
|
static const Placement Null;
|
|
|
|
private:
|
|
Base::Placement _cPos;
|
|
};
|
|
|
|
/** the general Link Property
|
|
* Main Purpose of this property is to Link Objects and Features in a document.
|
|
*/
|
|
class AppExport PropertyPlacementLink : public PropertyLink
|
|
{
|
|
TYPESYSTEM_HEADER();
|
|
|
|
public:
|
|
/**
|
|
* A constructor.
|
|
* A more elaborate description of the constructor.
|
|
*/
|
|
PropertyPlacementLink();
|
|
|
|
/**
|
|
* A destructor.
|
|
* A more elaborate description of the destructor.
|
|
*/
|
|
virtual ~PropertyPlacementLink();
|
|
|
|
/** This method returns the linked DocumentObject
|
|
*/
|
|
App::Placement * getPlacementObject(void) const;
|
|
|
|
virtual Property *Copy(void) const;
|
|
virtual void Paste(const Property &from);
|
|
};
|
|
|
|
|
|
class AppExport PropertyPlacementList: public PropertyListsT<Base::Placement>
|
|
{
|
|
TYPESYSTEM_HEADER_WITH_OVERRIDE();
|
|
|
|
public:
|
|
/**
|
|
* A property that stores a list of placements
|
|
*/
|
|
PropertyPlacementList();
|
|
|
|
virtual ~PropertyPlacementList();
|
|
|
|
virtual PyObject *getPyObject(void) override;
|
|
|
|
virtual void Save (Base::Writer &writer) const override;
|
|
virtual void Restore(Base::XMLReader &reader) override;
|
|
|
|
virtual void SaveDocFile (Base::Writer &writer) const override;
|
|
virtual void RestoreDocFile(Base::Reader &reader) override;
|
|
|
|
virtual Property *Copy(void) const override;
|
|
virtual void Paste(const Property &from) override;
|
|
|
|
virtual unsigned int getMemSize (void) const override;
|
|
|
|
protected:
|
|
Base::Placement getPyValue(PyObject *) const override;
|
|
};
|
|
|
|
|
|
/// Property representing a rotation
|
|
/*!
|
|
* Encapsulates a Base::Rotation in a Property
|
|
*/
|
|
class AppExport PropertyRotation : public Property
|
|
{
|
|
TYPESYSTEM_HEADER_WITH_OVERRIDE();
|
|
|
|
public:
|
|
/**
|
|
* A constructor.
|
|
* A more elaborate description of the constructor.
|
|
*/
|
|
PropertyRotation();
|
|
|
|
/**
|
|
* A destructor.
|
|
* A more elaborate description of the destructor.
|
|
*/
|
|
virtual ~PropertyRotation();
|
|
|
|
/** Sets the property
|
|
*/
|
|
void setValue(const Base::Rotation &rot);
|
|
|
|
/** Sets property only if changed
|
|
* @param pos: input placement
|
|
* @param tol: position tolerance
|
|
* @param atol: angular tolerance
|
|
*/
|
|
bool setValueIfChanged(const Base::Rotation &rot, double atol=1e-12);
|
|
|
|
/** This method returns a string representation of the property
|
|
*/
|
|
const Base::Rotation &getValue() const;
|
|
|
|
/// Get valid paths for this property; used by auto completer
|
|
void getPaths(std::vector<ObjectIdentifier> &paths) const override;
|
|
|
|
void setPathValue(const ObjectIdentifier &path, const boost::any &value) override;
|
|
|
|
virtual const boost::any getPathValue(const ObjectIdentifier &path) const override;
|
|
|
|
virtual bool getPyPathValue(const ObjectIdentifier &path, Py::Object &res) const override;
|
|
|
|
const char* getEditorName() const override {
|
|
return "Gui::PropertyEditor::PropertyRotationItem";
|
|
}
|
|
|
|
virtual PyObject *getPyObject() override;
|
|
virtual void setPyObject(PyObject *) override;
|
|
|
|
virtual void Save (Base::Writer &writer) const override;
|
|
virtual void Restore(Base::XMLReader &reader) override;
|
|
|
|
virtual Property *Copy() const override;
|
|
virtual void Paste(const Property &from) override;
|
|
|
|
virtual unsigned int getMemSize () const override {
|
|
return sizeof(Base::Placement);
|
|
}
|
|
|
|
private:
|
|
Base::Rotation _rot;
|
|
};
|
|
|
|
|
|
/** The base class for all basic geometry properties.
|
|
* @author Werner Mayer
|
|
*/
|
|
class AppExport PropertyGeometry : public App::Property
|
|
{
|
|
TYPESYSTEM_HEADER();
|
|
|
|
public:
|
|
PropertyGeometry();
|
|
virtual ~PropertyGeometry();
|
|
|
|
/** @name Modification */
|
|
//@{
|
|
/// Applies a transformation on the real geometric data type
|
|
virtual void transformGeometry(const Base::Matrix4D &rclMat) = 0;
|
|
/// Retrieve bounding box information
|
|
virtual Base::BoundBox3d getBoundingBox() const = 0;
|
|
//@}
|
|
};
|
|
|
|
/** The base class for all complex data properties.
|
|
* @author Werner Mayer
|
|
*/
|
|
class AppExport PropertyComplexGeoData : public App::PropertyGeometry
|
|
{
|
|
TYPESYSTEM_HEADER();
|
|
|
|
public:
|
|
PropertyComplexGeoData();
|
|
virtual ~PropertyComplexGeoData();
|
|
|
|
/** @name Modification */
|
|
//@{
|
|
/// Applies a transformation on the real geometric data type
|
|
virtual void transformGeometry(const Base::Matrix4D &rclMat) = 0;
|
|
//@}
|
|
|
|
/** @name Getting basic geometric entities */
|
|
//@{
|
|
virtual const Data::ComplexGeoData* getComplexData() const = 0;
|
|
virtual Base::BoundBox3d getBoundingBox() const = 0;
|
|
//@}
|
|
};
|
|
|
|
} // namespace App
|
|
|
|
|
|
#endif // APP_PROPERTYGEO_H
|