d0d4d6bc07
AttachableObjects are desired in multiple occasions, and the current AttachableObject is not flexible enough to handle all cases. Hence the code is portet to an extension, which gives the needed flexibility.
124 lines
4.9 KiB
C++
124 lines
4.9 KiB
C++
/***************************************************************************
|
|
* Copyright (c) Victor Titov (DeepSOIC) *
|
|
* (vv.titov@gmail.com) 2015 *
|
|
* *
|
|
* 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 *
|
|
* *
|
|
***************************************************************************/
|
|
/**
|
|
* AttachExtensionh, .cpp contain a extension class to derive other features from, to make
|
|
* them attachable.
|
|
*/
|
|
|
|
#ifndef PARTATTACHABLEOBJECT_H
|
|
#define PARTATTACHABLEOBJECT_H
|
|
|
|
#include <App/PropertyStandard.h>
|
|
#include <App/PropertyLinks.h>
|
|
#include <App/GeoFeature.h>
|
|
#include <App/DocumentObjectExtension.h>
|
|
#include <Base/Vector3D.h>
|
|
#include <Base/Placement.h>
|
|
#include <Base/Exception.h>
|
|
|
|
#include "PartFeature.h"
|
|
#include "Attacher.h"
|
|
|
|
#include <QString>
|
|
|
|
#include <gp_Vec.hxx>
|
|
|
|
namespace Part
|
|
{
|
|
|
|
/**
|
|
* @brief The AttachableObject class is the thing to extend an object with
|
|
* that should be attachable. It includes the required properties, and
|
|
* shortcuts for accessing the attachment math class.
|
|
*/
|
|
class PartExport AttachExtension : public App::DocumentObjectExtension
|
|
{
|
|
EXTENSION_PROPERTY_HEADER(Part::AttachableObject);
|
|
public:
|
|
AttachExtension();
|
|
virtual ~AttachExtension();
|
|
|
|
/**
|
|
* @brief setAttacher sets the AttachEngine object. The class takes the
|
|
* ownership of the pointer, it will be deleted when the class is
|
|
* destroyed, or when a new attacher is set. The default attacher is AttachEngine3D.
|
|
* @param attacher. AttachableObject takes ownership and will delete it eventually.
|
|
*/
|
|
virtual void setAttacher(Attacher::AttachEngine* attacher);
|
|
|
|
/**
|
|
* @brief changeAttacherType
|
|
* @param typeName is the typename of new attacher class. Must be derived
|
|
* from Attacher::AttachEngine.
|
|
* @return true if attacher was changed. false if attacher is already of the
|
|
* type requested. Throws if invalid type is supplied.
|
|
*/
|
|
bool changeAttacherType(const char* typeName);
|
|
|
|
Attacher::AttachEngine &attacher(void) const {if(!_attacher) throw Base::Exception("AttachableObject: no attacher is set."); return *_attacher;}
|
|
|
|
|
|
App::PropertyString AttacherType;
|
|
App::PropertyLinkSubList Support;
|
|
App::PropertyEnumeration MapMode; //see AttachEngine::eMapMode
|
|
App::PropertyBool MapReversed; //inverts Z and X internal axes
|
|
App::PropertyPlacement superPlacement;
|
|
|
|
/**
|
|
* @brief MapPathParameter is a parameter value for mmNormalToPath (the
|
|
* sketch will be mapped normal to a curve at point specified by parameter
|
|
* (from 0.0 to 1.0, from start to end) )
|
|
*/
|
|
App::PropertyFloat MapPathParameter;
|
|
|
|
/** calculate and update the Placement property based on the Support, and
|
|
* mode. Can throw FreeCAD and OCC exceptions. Returns true if attached,
|
|
* false if not, throws if attachment failed.
|
|
*/
|
|
virtual bool positionBySupport(void);
|
|
|
|
virtual bool isTouched_Mapping()
|
|
{return true; /*support.isTouched isn't true when linked objects are changed... why?..*/};
|
|
|
|
virtual short int extensionMustExecute(void);
|
|
virtual App::DocumentObjectExecReturn *extensionExecute(void);
|
|
virtual PyObject* getExtensionPyObject(void);
|
|
protected:
|
|
virtual void extensionOnChanged(const App::Property* /*prop*/);
|
|
|
|
App::PropertyPlacement& getPlacement();
|
|
|
|
public:
|
|
void updateAttacherVals();
|
|
|
|
private:
|
|
Attacher::AttachEngine* _attacher;
|
|
};
|
|
|
|
|
|
typedef App::ExtensionPythonT<AttachExtension> AttachExtensionPython;
|
|
|
|
} // namespace Part
|
|
|
|
#endif // PARTATTACHABLEOBJECT_H
|