FreeCAD / src /Mod /PartDesign /App /FeatureLinearPattern.h

Upload folder using huggingface_hub

985c397 verified 9 months ago

5.1 kB

/******************************************************************************
 *   Copyright (c) 2012 Jan Rheinländer <jrheinlaender@users.sourceforge.net> *
 *                                                                            *
 *   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 PARTDESIGN_FeatureLinearPattern_H
#define PARTDESIGN_FeatureLinearPattern_H

#include <App/PropertyUnits.h>
#include "FeatureTransformed.h"

class gp_Vec;

namespace PartDesign
{
enum class LinearPatternMode
{
    Extent,
    Spacing
};

enum class LinearPatternDirection : std::uint8_t
{
    First,
    Second
};

class PartDesignExport LinearPattern: public PartDesign::Transformed
{
    PROPERTY_HEADER_WITH_OVERRIDE(PartDesign::LinearPattern);

public:
    LinearPattern();

    App::PropertyLinkSub Direction;
    App::PropertyBool Reversed;
    App::PropertyEnumeration Mode;
    App::PropertyLength Length;
    App::PropertyLength Offset;
    App::PropertyIntegerConstraint Occurrences;
    App::PropertyFloatList Spacings;
    App::PropertyFloatList SpacingPattern;

    App::PropertyLinkSub Direction2;
    App::PropertyBool Reversed2;
    App::PropertyEnumeration Mode2;
    App::PropertyLength Length2;
    App::PropertyLength Offset2;
    App::PropertyIntegerConstraint Occurrences2;
    App::PropertyFloatList Spacings2;
    App::PropertyFloatList SpacingPattern2;


    /** @name methods override feature */
    //@{
    short mustExecute() const override;

    /// returns the type name of the view provider
    const char* getViewProviderName() const override
    {
        return "PartDesignGui::ViewProviderLinearPattern";
    }
    //@}

    /** Create transformations
     * Returns a list of (Occurrences - 1) transformations since the first, untransformed instance
     * is not counted.
     *
     * Depending on Mode selection list will be constructed differently:
     * 1. For "Overall Length" each transformation will move the shape it is applied to by the
     * distance (Length / (Occurrences - 1)) so that the transformations will cover the total
     * Length.
     * 2. For "Spacing" each transformation will move the shape by the distance explicitly given in
     *    the Offset parameter.
     *
     * If Direction contains a feature and a face name, then the transformation direction will be
     *   the normal of the given face, which must be planar. If it contains an edge name, then the
     *   transformation direction will be parallel to the given edge, which must be linear
     *
     * If Reversed is true, the direction of transformation will be opposite
     */
    const std::list<gp_Trsf> getTransformations(const std::vector<App::DocumentObject*>) override;

protected:
    void handleChangedPropertyType(
        Base::XMLReader& reader,
        const char* TypeName,
        App::Property* prop
    ) override;
    void onChanged(const App::Property* prop) override;

    static const App::PropertyIntegerConstraint::Constraints intOccurrences;

private:
    static const char* ModeEnums[];

    gp_Dir getDirectionFromProperty(const App::PropertyLinkSub& dirProp) const;

    void setReadWriteStatusForMode(LinearPatternDirection dir);
    void syncLengthAndOffset(LinearPatternDirection dir);

    void updateSpacings();
    void updateSpacings(LinearPatternDirection dir);

    gp_Vec calculateOffsetVector(LinearPatternDirection dir) const;
    std::vector<gp_Vec> calculateSteps(LinearPatternDirection dir, const gp_Vec& offsetVector) const;
};

}  // namespace PartDesign


#endif  // PARTDESIGN_FeatureLinearPattern_H

	/******************************************************************************
	* Copyright (c) 2012 Jan Rheinländer <jrheinlaender@users.sourceforge.net> *
	* *
	* 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 PARTDESIGN_FeatureLinearPattern_H
	#define PARTDESIGN_FeatureLinearPattern_H

	#include <App/PropertyUnits.h>
	#include "FeatureTransformed.h"

	class gp_Vec;

	namespace PartDesign
	{
	enum class LinearPatternMode
	{
	Extent,
	Spacing
	};

	enum class LinearPatternDirection : std::uint8_t
	{
	First,
	Second
	};

	class PartDesignExport LinearPattern: public PartDesign::Transformed
	{
	PROPERTY_HEADER_WITH_OVERRIDE(PartDesign::LinearPattern);

	public:
	LinearPattern();

	App::PropertyLinkSub Direction;
	App::PropertyBool Reversed;
	App::PropertyEnumeration Mode;
	App::PropertyLength Length;
	App::PropertyLength Offset;
	App::PropertyIntegerConstraint Occurrences;
	App::PropertyFloatList Spacings;
	App::PropertyFloatList SpacingPattern;

	App::PropertyLinkSub Direction2;
	App::PropertyBool Reversed2;
	App::PropertyEnumeration Mode2;
	App::PropertyLength Length2;
	App::PropertyLength Offset2;
	App::PropertyIntegerConstraint Occurrences2;
	App::PropertyFloatList Spacings2;
	App::PropertyFloatList SpacingPattern2;


	/** @name methods override feature */
	//@{
	short mustExecute() const override;

	/// returns the type name of the view provider
	const char* getViewProviderName() const override
	{
	return "PartDesignGui::ViewProviderLinearPattern";
	}
	//@}

	/** Create transformations
	* Returns a list of (Occurrences - 1) transformations since the first, untransformed instance
	* is not counted.
	*
	* Depending on Mode selection list will be constructed differently:
	* 1. For "Overall Length" each transformation will move the shape it is applied to by the
	* distance (Length / (Occurrences - 1)) so that the transformations will cover the total
	* Length.
	* 2. For "Spacing" each transformation will move the shape by the distance explicitly given in
	* the Offset parameter.
	*
	* If Direction contains a feature and a face name, then the transformation direction will be
	* the normal of the given face, which must be planar. If it contains an edge name, then the
	* transformation direction will be parallel to the given edge, which must be linear
	*
	* If Reversed is true, the direction of transformation will be opposite
	*/
	const std::list<gp_Trsf> getTransformations(const std::vector<App::DocumentObject*>) override;

	protected:
	void handleChangedPropertyType(
	Base::XMLReader& reader,
	const char* TypeName,
	App::Property* prop
	) override;
	void onChanged(const App::Property* prop) override;

	static const App::PropertyIntegerConstraint::Constraints intOccurrences;

	private:
	static const char* ModeEnums[];

	gp_Dir getDirectionFromProperty(const App::PropertyLinkSub& dirProp) const;

	void setReadWriteStatusForMode(LinearPatternDirection dir);
	void syncLengthAndOffset(LinearPatternDirection dir);

	void updateSpacings();
	void updateSpacings(LinearPatternDirection dir);

	gp_Vec calculateOffsetVector(LinearPatternDirection dir) const;
	std::vector<gp_Vec> calculateSteps(LinearPatternDirection dir, const gp_Vec& offsetVector) const;
	};

	} // namespace PartDesign


	#endif // PARTDESIGN_FeatureLinearPattern_H