File size: 6,614 Bytes
985c397 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 | // SPDX-License-Identifier: LGPL-2.1-or-later
/***************************************************************************
* Copyright (c) 2015 Victor Titov (DeepSOIC) <vv.titov@gmail.com> *
* *
* 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/DocumentObjectExtension.h>
#include <App/ExtensionPython.h>
#include <App/PropertyLinks.h>
#include <App/PropertyStandard.h>
#include <Base/Exception.h>
#include <Base/Placement.h>
#include <Mod/Part/PartGlobal.h>
#include "Attacher.h"
namespace Part
{
class PartExport AttachEngineException: public Base::Exception
{
public:
/// Construction
AttachEngineException();
explicit AttachEngineException(const char* sMessage);
explicit AttachEngineException(const std::string& sMessage);
/// Destruction
~AttachEngineException() throw() override
{}
};
/**
* @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_WITH_OVERRIDE(Part::AttachableObject);
public:
AttachExtension();
~AttachExtension() override;
/**
* @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, bool base = false);
/**
* @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, bool base = false);
Attacher::AttachEngine& attacher(bool base = false) const;
App::PropertyString AttacherType;
App::PropertyEnumeration AttacherEngine;
App::PropertyLinkSubList AttachmentSupport;
App::PropertyEnumeration MapMode; // see AttachEngine::eMapMode
App::PropertyBool MapReversed; // inverts Z and X internal axes
App::PropertyPlacement AttachmentOffset;
/**
* @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();
/** Return whether this attacher is active
*/
bool isAttacherActive() const;
virtual bool isTouched_Mapping()
{
return true; /*support.isTouched isn't true when linked objects are changed... why?..*/
}
short int extensionMustExecute() override;
App::DocumentObjectExecReturn* extensionExecute() override;
PyObject* getExtensionPyObject() override;
void onExtendedDocumentRestored() override;
struct Properties
{
App::PropertyString* attacherType = nullptr;
App::PropertyLinkSubList* attachment = nullptr;
App::PropertyEnumeration* mapMode = nullptr;
App::PropertyBool* mapReversed = nullptr;
App::PropertyFloat* mapPathParameter = nullptr;
bool matchProperty(const App::Property* prop) const
{
return prop == attachment || prop == mapMode || prop == mapReversed
|| prop == mapPathParameter;
}
};
Properties getProperties(bool base) const;
Properties getInitedProperties(bool base);
protected:
void extensionOnChanged(const App::Property* /*prop*/) override;
virtual bool extensionHandleChangedPropertyName(
Base::XMLReader& reader,
const char* TypeName,
const char* PropName
) override;
App::PropertyPlacement& getPlacement() const;
void initBase(bool force);
void handleLegacyTangentPlaneOrientation();
public:
void updateAttacherVals(bool base = false) const;
// This update both _props and _baseProps if base = false
void updatePropertyStatus(bool attached, bool base = false);
// This update only _props if base = false
void updateSinglePropertyStatus(bool attached, bool base = false);
private:
struct _Properties: Properties
{
mutable std::unique_ptr<Attacher::AttachEngine> attacher;
};
_Properties _props;
_Properties _baseProps;
mutable int _active = -1;
};
using AttachExtensionPython = App::ExtensionPythonT<AttachExtension>;
} // namespace Part
#endif // PARTATTACHABLEOBJECT_H
|