Files
create/src/Mod/Sketcher/App/PropertyConstraintList.cpp

527 lines
18 KiB
C++

/***************************************************************************
* Copyright (c) Jürgen Riegel (juergen.riegel@web.de) 2010 *
* *
* 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 *
* *
***************************************************************************/
#include "PreCompiled.h"
#ifndef _PreComp_
# include <assert.h>
#endif
/// Here the FreeCAD includes sorted by Base,App,Gui......
#include <Base/Exception.h>
#include <Base/Reader.h>
#include <Base/Writer.h>
#include <Base/Tools.h>
#include <App/ObjectIdentifier.h>
#include <App/DocumentObject.h>
#include "PropertyConstraintList.h"
#include "ConstraintPy.h"
using namespace App;
using namespace Base;
using namespace std;
using namespace Sketcher;
//**************************************************************************
// PropertyConstraintList
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
TYPESYSTEM_SOURCE(Sketcher::PropertyConstraintList, App::PropertyLists);
//**************************************************************************
// Construction/Destruction
PropertyConstraintList::PropertyConstraintList() : validGeometryKeys(0), invalidGeometry(true)
{
}
PropertyConstraintList::~PropertyConstraintList()
{
for (std::vector<Constraint*>::iterator it = _lValueList.begin(); it != _lValueList.end(); ++it)
if (*it) delete *it;
}
App::ObjectIdentifier PropertyConstraintList::makeArrayPath(int idx)
{
return App::ObjectIdentifier(getContainer()) << App::ObjectIdentifier::Component::ArrayComponent(ObjectIdentifier::String(getName()), idx);
}
App::ObjectIdentifier PropertyConstraintList::makeSimplePath(const Constraint * c)
{
return App::ObjectIdentifier(getContainer()) << App::ObjectIdentifier::Component::SimpleComponent(getName())
<< App::ObjectIdentifier::Component::SimpleComponent(App::ObjectIdentifier::String(c->Name, !ExpressionParser::isTokenAnIndentifier(c->Name)));
}
App::ObjectIdentifier PropertyConstraintList::makePath(int idx, const Constraint * c)
{
return c->Name.size() == 0 ? makeArrayPath(idx) : makeSimplePath(c);
}
void PropertyConstraintList::setSize(int newSize)
{
std::set<App::ObjectIdentifier> removed;
/* Collect information about erased elements */
for (unsigned int i = newSize; i < _lValueList.size(); i++) {
valueMap.erase(_lValueList[i]->tag);
removed.insert(makePath(i, _lValueList[i]));
}
/* Signal removed elements */
if (removed.size() > 0)
signalConstraintsRemoved(removed);
/* Actually delete them */
for (unsigned int i = newSize; i < _lValueList.size(); i++)
delete _lValueList[i];
/* Resize array to new size */
_lValueList.resize(newSize);
}
int PropertyConstraintList::getSize(void) const
{
return static_cast<int>(_lValueList.size());
}
void PropertyConstraintList::set1Value(const int idx, const Constraint* lValue)
{
if (lValue) {
aboutToSetValue();
Constraint* oldVal = _lValueList[idx];
Constraint* newVal = lValue->clone();
if (oldVal->Name != newVal->Name) {
std::map<App::ObjectIdentifier, App::ObjectIdentifier> renamed;
renamed[makePath(idx, _lValueList[idx])] = makePath(idx, lValue);
if (renamed.size() > 0)
signalConstraintsRenamed(renamed);
}
_lValueList[idx] = newVal;
valueMap.erase(oldVal->tag);
valueMap[newVal->tag] = idx;
delete oldVal;
hasSetValue();
}
}
void PropertyConstraintList::setValue(const Constraint* lValue)
{
if (lValue) {
aboutToSetValue();
Constraint* newVal = lValue->clone();
std::set<App::ObjectIdentifier> removed;
std::map<App::ObjectIdentifier, App::ObjectIdentifier> renamed;
int start = 0;
/* Determine if it is a rename or not * */
if (_lValueList.size() > 0 && lValue->tag == _lValueList[0]->tag) {
renamed[makePath(0, _lValueList[0])] = makePath(0, lValue);
start = 1;
}
/* Signal rename changes */
if (renamed.size() > 0)
signalConstraintsRenamed(renamed);
/* Collect infor about removals */
for (unsigned int i = start; i < _lValueList.size(); i++) {
valueMap.erase(_lValueList[i]->tag);
removed.insert(makePath(i, _lValueList[i]));
}
/* Signal removes */
if (removed.size() > 0)
signalConstraintsRemoved(removed);
// Cleanup
for (unsigned int i = 0; i < _lValueList.size(); i++)
delete _lValueList[i];
/* Set new data */
_lValueList.resize(1);
_lValueList[0] = newVal;
valueMap[_lValueList[0]->tag] = 0;
hasSetValue();
}
}
void PropertyConstraintList::setValues(const std::vector<Constraint*>& lValue)
{
aboutToSetValue();
applyValues(lValue);
hasSetValue();
}
void PropertyConstraintList::applyValues(const std::vector<Constraint*>& lValue)
{
std::vector<Constraint*> oldVals(_lValueList);
std::map<App::ObjectIdentifier, App::ObjectIdentifier> renamed;
std::set<App::ObjectIdentifier> removed;
/* Check for renames */
for (unsigned int i = 0; i < lValue.size(); i++) {
boost::unordered_map<boost::uuids::uuid, std::size_t>::const_iterator j = valueMap.find(lValue[i]->tag);
if (j != valueMap.end() && (i != j->second || _lValueList[j->second]->Name != lValue[i]->Name) )
renamed[makePath(j->second, _lValueList[j->second] )] = makePath(i, lValue[i]);
}
/* Update value map with new tags from new array */
valueMap.clear();
for (std::size_t i = 0; i < lValue.size(); i++)
valueMap[lValue[i]->tag] = i;
/* Signal renames */
if (renamed.size() > 0)
signalConstraintsRenamed(renamed);
/* Collect info about removed elements */
for (std::size_t i = 0; i < oldVals.size(); i++) {
boost::unordered_map<boost::uuids::uuid, std::size_t>::const_iterator j = valueMap.find(oldVals[i]->tag);
if (j == valueMap.end())
removed.insert(makePath(i, oldVals[i]));
}
/* Signal removes */
if (removed.size() > 0)
signalConstraintsRemoved(removed);
/* Resize array to new size */
_lValueList.resize(lValue.size());
/* copy all objects */
for (unsigned int i = 0; i < lValue.size(); i++)
_lValueList[i] = lValue[i]->clone();
/* Clean-up; remove old values */
for (unsigned int i = 0; i < oldVals.size(); i++)
delete oldVals[i];
}
PyObject *PropertyConstraintList::getPyObject(void)
{
PyObject* list = PyList_New(getSize());
for (int i = 0; i < getSize(); i++)
PyList_SetItem( list, i, _lValueList[i]->getPyObject());
return list;
}
void PropertyConstraintList::setPyObject(PyObject *value)
{
if (PyList_Check(value)) {
Py_ssize_t nSize = PyList_Size(value);
std::vector<Constraint*> values;
values.resize(nSize);
for (Py_ssize_t i=0; i < nSize; ++i) {
PyObject* item = PyList_GetItem(value, i);
if (!PyObject_TypeCheck(item, &(ConstraintPy::Type))) {
std::string error = std::string("types in list must be 'Constraint', not ");
error += item->ob_type->tp_name;
throw Base::TypeError(error);
}
values[i] = static_cast<ConstraintPy*>(item)->getConstraintPtr();
}
setValues(values);
}
else if (PyObject_TypeCheck(value, &(ConstraintPy::Type))) {
ConstraintPy *pcObject = static_cast<ConstraintPy*>(value);
setValue(pcObject->getConstraintPtr());
}
else {
std::string error = std::string("type must be 'Constraint' or list of 'Constraint', not ");
error += value->ob_type->tp_name;
throw Base::TypeError(error);
}
}
void PropertyConstraintList::Save(Writer &writer) const
{
writer.Stream() << writer.ind() << "<ConstraintList count=\"" << getSize() <<"\">" << endl;
writer.incInd();
for (int i = 0; i < getSize(); i++)
_lValueList[i]->Save(writer);
writer.decInd();
writer.Stream() << writer.ind() << "</ConstraintList>" << endl ;
}
void PropertyConstraintList::Restore(Base::XMLReader &reader)
{
// read my element
reader.readElement("ConstraintList");
// get the value of my attribute
int count = reader.getAttributeAsInteger("count");
std::vector<Constraint*> values;
values.reserve(count);
for (int i = 0; i < count; i++) {
Constraint *newC = new Constraint();
newC->Restore(reader);
// To keep upward compatibility ignore unknown constraint types
if (newC->Type < Sketcher::NumConstraintTypes) {
values.push_back(newC);
}
else {
// reading a new constraint type which this version cannot handle
delete newC;
}
}
reader.readEndElement("ConstraintList");
// assignment
setValues(values);
}
Property *PropertyConstraintList::Copy(void) const
{
PropertyConstraintList *p = new PropertyConstraintList();
p->applyValidGeometryKeys(validGeometryKeys);
p->applyValues(_lValueList);
return p;
}
void PropertyConstraintList::Paste(const Property &from)
{
const PropertyConstraintList& FromList = dynamic_cast<const PropertyConstraintList&>(from);
aboutToSetValue();
applyValues(FromList._lValueList);
applyValidGeometryKeys(FromList.validGeometryKeys);
hasSetValue();
}
unsigned int PropertyConstraintList::getMemSize(void) const
{
int size = sizeof(PropertyConstraintList);
for (int i = 0; i < getSize(); i++)
size += _lValueList[i]->getMemSize();
return size;
}
void PropertyConstraintList::acceptGeometry(const std::vector<Part::Geometry *> &GeoList)
{
aboutToSetValue();
validGeometryKeys.clear();
validGeometryKeys.reserve(GeoList.size());
for (std::vector< Part::Geometry * >::const_iterator it=GeoList.begin();
it != GeoList.end(); ++it)
validGeometryKeys.push_back((*it)->getTypeId().getKey());
invalidGeometry = false;
hasSetValue();
}
void PropertyConstraintList::applyValidGeometryKeys(const std::vector<unsigned int> &keys)
{
validGeometryKeys = keys;
}
void PropertyConstraintList::checkGeometry(const std::vector<Part::Geometry *> &GeoList)
{
if (!scanGeometry(GeoList)) {
invalidGeometry = true;
return;
}
//if we made it here, geometry is OK
if (invalidGeometry) {
//geometry was bad, but now it became OK.
invalidGeometry = false;
touch();
}
}
/*!
* \brief PropertyConstraintList::scanGeometry tests if the supplied geometry
* is the same (all elements are of the same type as they used to be).
* \param GeoList - new geometry list to be checked
* \return false, if the types have changed.
*/
bool PropertyConstraintList::scanGeometry(const std::vector<Part::Geometry *> &GeoList) const
{
if (validGeometryKeys.size() != GeoList.size()) {
return false;
}
unsigned int i=0;
for (std::vector< Part::Geometry * >::const_iterator it=GeoList.begin();
it != GeoList.end(); ++it, i++) {
if (validGeometryKeys[i] != (*it)->getTypeId().getKey()) {
return false;
}
}
return true;
}
string PropertyConstraintList::getConstraintName(const std::string & name, int i)
{
if (!name.empty())
return name;
else
return getConstraintName(i);
}
string PropertyConstraintList::getConstraintName(int i)
{
std::stringstream str;
str << "Constraint" << (i + 1);
return str.str();
}
bool PropertyConstraintList::validConstraintName(const std::string & name)
{
return name.size() > 0;
}
ObjectIdentifier PropertyConstraintList::createPath(int ConstrNbr) const
{
return App::ObjectIdentifier(getContainer())
<< App::ObjectIdentifier::Component::ArrayComponent(App::ObjectIdentifier::String(getName()), ConstrNbr);
}
int PropertyConstraintList::getIndexFromConstraintName(const string &name)
{
return std::atoi(name.substr(10,4000).c_str()) - 1;
}
void PropertyConstraintList::setPathValue(const ObjectIdentifier &path, const boost::any &value)
{
const ObjectIdentifier::Component & c0 = path.getPropertyComponent(0);
double dvalue;
if (value.type() == typeid(double))
dvalue = boost::any_cast<double>(value);
else if (value.type() == typeid(Quantity))
dvalue = (boost::any_cast<Quantity>(value)).getValue();
else
throw std::bad_cast();
if (c0.isArray() && path.numSubComponents() == 1) {
int index = c0.getIndex();
if (c0.getIndex() >= _lValueList.size())
throw Base::Exception("Array out of bounds");
switch (_lValueList[index]->Type) {
case Angle:
dvalue = Base::toRadians<double>(dvalue);
break;
default:
break;
}
aboutToSetValue();
_lValueList[index]->setValue(dvalue);
hasSetValue();
return;
}
else if (c0.isSimple() && path.numSubComponents() == 2) {
ObjectIdentifier::Component c1 = path.getPropertyComponent(1);
for (std::vector<Constraint *>::const_iterator it = _lValueList.begin(); it != _lValueList.end(); ++it) {
int index = it - _lValueList.begin();
if ((*it)->Name == c1.getName()) {
switch (_lValueList[index]->Type) {
case Angle:
dvalue = Base::toRadians<double>(dvalue);
break;
default:
break;
}
aboutToSetValue();
_lValueList[index]->setValue(dvalue);
hasSetValue();
return;
}
}
}
throw Base::Exception("Invalid constraint");
}
const Constraint * PropertyConstraintList::getConstraint(const ObjectIdentifier &path) const
{
const ObjectIdentifier::Component & c0 = path.getPropertyComponent(0);
if (c0.isArray() && path.numSubComponents() == 1) {
if (c0.getIndex() >= _lValueList.size())
throw Base::Exception("Array out of bounds");
return _lValueList[c0.getIndex()];
}
else if (c0.isSimple() && path.numSubComponents() == 2) {
ObjectIdentifier::Component c1 = path.getPropertyComponent(1);
for (std::vector<Constraint *>::const_iterator it = _lValueList.begin(); it != _lValueList.end(); ++it) {
if ((*it)->Name == c1.getName())
return *it;
}
}
throw Base::Exception("Invalid constraint");
}
const boost::any PropertyConstraintList::getPathValue(const ObjectIdentifier &path) const
{
return boost::any(getConstraint(path)->getPresentationValue());
}
const ObjectIdentifier PropertyConstraintList::canonicalPath(const ObjectIdentifier &p) const
{
const ObjectIdentifier::Component & c0 = p.getPropertyComponent(0);
if (c0.isArray() && p.numSubComponents() == 1) {
if (c0.getIndex() < _lValueList.size() && _lValueList[c0.getIndex()]->Name.size() > 0)
return ObjectIdentifier(getContainer()) << ObjectIdentifier::Component::SimpleComponent(getName())
<< ObjectIdentifier::Component::SimpleComponent(_lValueList[c0.getIndex()]->Name);
return p;
}
else if (c0.isSimple() && p.numSubComponents() == 2) {
ObjectIdentifier::Component c1 = p.getPropertyComponent(1);
if (c1.isSimple())
return p;
}
throw Base::Exception("Invalid constraint");
}
void PropertyConstraintList::getPaths(std::vector<ObjectIdentifier> &paths) const
{
for (std::vector<Constraint *>::const_iterator it = _lValueList.begin(); it != _lValueList.end(); ++it) {
if ((*it)->Name.size() > 0)
paths.push_back(ObjectIdentifier(getContainer()) << ObjectIdentifier::Component::SimpleComponent(getName())
<< ObjectIdentifier::Component::SimpleComponent((*it)->Name));
}
}
std::vector<Constraint *> PropertyConstraintList::_emptyValueList(0);