#include <TaskHelixParameters.h>

Public Member Functions
virtual void	apply () override
	apply changes made in the parameters input to the model via commands More...

	TaskHelixParameters (ViewProviderHelix HelixView, QWidget parent=nullptr)

	~TaskHelixParameters ()

Public Member Functions inherited from PartDesignGui::TaskSketchBasedParameters
	TaskSketchBasedParameters (PartDesignGui::ViewProvider vp, QWidget parent, const std::string &pixmapname, const QString &parname)

	~TaskSketchBasedParameters ()

Public Member Functions inherited from PartDesignGui::TaskFeatureParameters
virtual void	apply ()
	apply changes made in the parameters input to the model via commands More...

void	recomputeFeature ()

virtual void	saveHistory (void)
	save field history More...

	TaskFeatureParameters (PartDesignGui::ViewProvider vp, QWidget parent, const std::string &pixmapname, const QString &parname)

virtual	~TaskFeatureParameters ()

Public Member Functions inherited from Gui::TaskView::TaskBox
void	hideGroupBox ()

bool	isGroupVisible () const

virtual QSize	minimumSizeHint () const

	TaskBox (const QPixmap &icon, const QString &title, bool expandable=true, QWidget *parent=nullptr)
	Constructor. More...

	TaskBox (const QString &title, bool expandable=true, QWidget *parent=nullptr)
	Constructor. More...

	TaskBox (QWidget *parent=nullptr)
	Constructor. More...

	~TaskBox ()

Public Member Functions inherited from QSint::ActionGroup
	ActionGroup (const QPixmap &icon, const QString &title, bool expandable=true, QWidget *parent=nullptr)
	Constructor. More...

	ActionGroup (const QString &title, bool expandable=true, QWidget *parent=nullptr)
	Constructor. More...

	ActionGroup (QWidget *parent=nullptr)
	Constructor. More...

ActionLabel *	addAction (QAction *action, bool addToLayout=true, bool addStretch=true)
	Creates action item from the action and returns it. More...

ActionLabel *	addActionLabel (ActionLabel *label, bool addToLayout=true, bool addStretch=true)
	Adds label to the group. More...

bool	addWidget (QWidget *widget, bool addToLayout=true, bool addStretch=true)
	Adds widget to the group. More...

QBoxLayout *	groupLayout ()
	Returns group's layout (QVBoxLayout by default). More...

bool	hasHeader () const
	Returns true if the group has header. More...

QString	headerText () const
	Returns text of the header. More...

bool	isExpandable () const
	Returns true if the group is expandable. More...

QSize	minimumSizeHint () const

void	setScheme (ActionPanelScheme *pointer)
	Sets the scheme of the panel and all the child groups to scheme. More...

Public Member Functions inherited from Gui::DocumentObserver
void	attachDocument (Document *)
	Attaches to another document, the old document is not longer observed then. More...

void	detachDocument ()
	Detaches from the current document, the document is not longer observed then. More...

	DocumentObserver ()
	Constructor. More...

	DocumentObserver (Document *)

virtual	~DocumentObserver ()

Public Member Functions inherited from Gui::SelectionObserver
void	attachSelection ()
	Attaches to the selection. More...

bool	blockSelection (bool block)

void	detachSelection ()
	Detaches from the selection. More...

bool	isSelectionAttached () const

bool	isSelectionBlocked () const

	SelectionObserver (bool attach=true, ResolveMode resolve=ResolveMode::OldStyleElement)
	Constructor. More...

	SelectionObserver (const Gui::ViewProviderDocumentObject *vp, bool attach=true, ResolveMode resolve=ResolveMode::OldStyleElement)
	Constructor. More...

virtual	~SelectionObserver ()

Static Public Member Functions
static bool	showPreview (PartDesign::Helix *)

Protected Member Functions
void	changeEvent (QEvent *e) override

void	finishReferenceSelection (App::DocumentObject profile, App::DocumentObject base) override

void	getReferenceAxis (App::DocumentObject *&obj, std::vector< std::string > &sub) const

void	onSelectionChanged (const Gui::SelectionChanges &msg) override

void	startReferenceSelection (App::DocumentObject profile, App::DocumentObject base) override

bool	updateView () const

Protected Member Functions inherited from PartDesignGui::TaskSketchBasedParameters
void	exitSelectionMode ()

virtual void	finishReferenceSelection (App::DocumentObject profile, App::DocumentObject base)

QString	getFaceReference (const QString &obj, const QString &sub) const

QString	make2DLabel (const App::DocumentObject *section, const std::vector< std::string > &subValues)
	Create a label for the 2D feature: the objects name if it's already 2D, or the subelement's name if the object is a solid. More...

QVariant	objectNameByLabel (const QString &label, const QVariant &suggest) const
	Try to find the name of a feature with the given label. More...

const QString	onAddSelection (const Gui::SelectionChanges &msg)

void	onSelectionChanged (const Gui::SelectionChanges &msg)=0

void	onSelectReference (AllowSelectionFlags)
	onSelectReference Start reference selection mode to allow to select objects of the type defined with AllowSelectionFlags. If AllowSelection::NONE is passed the selection mode is finished. More...

QVariant	setUpToFace (const QString &text)

virtual void	startReferenceSelection (App::DocumentObject profile, App::DocumentObject base)

Protected Member Functions inherited from Gui::TaskView::TaskBox
void	actionEvent (QActionEvent *)

void	showEvent (QShowEvent *)

Protected Member Functions inherited from QSint::ActionGroup
void	init (bool header)

virtual void	paintEvent (QPaintEvent *event)

Protected Attributes
App::PropertyAngle *	propAngle

App::PropertyDistance *	propGrowth

App::PropertyLength *	propHeight

App::PropertyBool *	propLeftHanded

App::PropertyEnumeration *	propMode

App::PropertyBool *	propOutside

App::PropertyLength *	propPitch

App::PropertyLinkSub *	propReferenceAxis

App::PropertyBool *	propReversed

App::PropertyFloatConstraint *	propTurns

Protected Attributes inherited from PartDesignGui::TaskFeatureParameters
bool	blockUpdate
	Lock updateUI(), applying changes to the underlying feature and calling recomputeFeature() More...

PartDesignGui::ViewProvider *	vp

Protected Attributes inherited from QSint::ActionGroup
double	m_foldDelta

int	m_foldDirection

QPixmap	m_foldPixmap

double	m_foldStep

double	m_fullHeight

double	m_tempHeight

QWidget *	myDummy

class TaskGroup *	myGroup

class TaskHeader *	myHeader

ActionPanelScheme *	myScheme

Additional Inherited Members
Public Slots inherited from QSint::ActionGroup
void	setExpandable (bool expandable=true)
	Makes the group expandable if expandable is set to true. More...

void	setHeader (bool enable=true)
	Enables/disables group's header according to enable. More...

void	setHeaderText (const QString &title)
	Sets text of the header to title. More...

void	showHide ()
	Expands/collapses the group. More...

Protected Slots inherited from PartDesignGui::TaskFeatureParameters
void	onUpdateView (bool on)

Protected Slots inherited from QSint::ActionGroup
void	processHide ()

void	processShow ()

Properties inherited from QSint::ActionGroup
bool	expandable

bool	header

QString	headerText

Constructor & Destructor Documentation

◆ TaskHelixParameters()

TaskHelixParameters::TaskHelixParameters	(	PartDesignGui::ViewProviderHelix *	HelixView,
		QWidget *	parent = `nullptr`
	)

References QSint::ActionGroup::groupLayout().

◆ ~TaskHelixParameters()

TaskHelixParameters::~TaskHelixParameters ( )

References PartDesign::Body::findBodyOf(), Gui::ViewProviderDocumentObject::getObject(), App::OriginGroupExtension::getOrigin(), Gui::Application::getViewProvider(), Gui::Application::Instance, Base::Exception::ReportException(), Gui::ViewProviderOrigin::resetTemporaryVisibility(), and PartDesignGui::TaskFeatureParameters::vp.

Member Function Documentation

◆ apply()

void TaskHelixParameters::apply ( void )

overridevirtual

apply changes made in the parameters input to the model via commands

Reimplemented from PartDesignGui::TaskFeatureParameters.

References PartDesignGui::buildLinkSingleSubPythonStr(), Gui::ViewProviderDocumentObject::getObject(), getReferenceAxis(), App::PropertyEnumeration::getValue(), App::PropertyFloat::getValue(), App::PropertyBool::getValue(), App::PropertyQuantity::getValue(), propAngle, propGrowth, propHeight, propLeftHanded, propMode, propPitch, propReversed, propTurns, and PartDesignGui::TaskFeatureParameters::vp.

◆ changeEvent()

void TaskHelixParameters::changeEvent ( QEvent * e )

overrideprotected

◆ finishReferenceSelection()

void TaskHelixParameters::finishReferenceSelection	(	App::DocumentObject *	profile,
		App::DocumentObject *	base
	)

overrideprotectedvirtual

Reimplemented from PartDesignGui::TaskSketchBasedParameters.

References PartDesignGui::TaskSketchBasedParameters::finishReferenceSelection(), Gui::ViewProviderDocumentObject::getDocument(), App::DocumentObject::getNameInDocument(), Gui::ViewProviderDocumentObject::getObject(), showPreview(), and PartDesignGui::TaskFeatureParameters::vp.

◆ getReferenceAxis()

void TaskHelixParameters::getReferenceAxis	(	App::DocumentObject *&	obj,
		std::vector< std::string > &	sub
	)		const

protected

References App::DocumentObject::getDocument(), Gui::ViewProviderDocumentObject::getObject(), App::PropertyLinkSub::getSubValues(), App::PropertyLinkSub::getValue(), App::Document::isIn(), and PartDesignGui::TaskFeatureParameters::vp.

Referenced by apply().

◆ onSelectionChanged()

void TaskHelixParameters::onSelectionChanged ( const Gui::SelectionChanges & msg )

overrideprotectedvirtual

Implements PartDesignGui::TaskSketchBasedParameters.

References Gui::SelectionChanges::AddSelection, PartDesignGui::TaskSketchBasedParameters::exitSelectionMode(), Gui::ViewProviderDocumentObject::getObject(), PartDesignGui::getReferencedSelection(), propReferenceAxis, PartDesignGui::TaskFeatureParameters::recomputeFeature(), App::PropertyLinkSub::setValue(), and PartDesignGui::TaskFeatureParameters::vp.

◆ showPreview()

bool TaskHelixParameters::showPreview ( PartDesign::Helix * helix )

static

References PartDesign::FeatureAddSub::Additive, PartDesign::FeatureAddSub::getAddSubType(), App::GetApplication(), ParameterGrp::GetBool(), App::Application::GetParameterGroupByPath(), and PartDesign::FeatureAddSub::Subtractive.

Referenced by finishReferenceSelection(), PartDesignGui::ViewProviderHelix::setEdit(), and startReferenceSelection().

◆ startReferenceSelection()

void TaskHelixParameters::startReferenceSelection	(	App::DocumentObject *	profile,
		App::DocumentObject *	base
	)

overrideprotectedvirtual

Reimplemented from PartDesignGui::TaskSketchBasedParameters.

References Gui::ViewProviderDocumentObject::getDocument(), App::DocumentObject::getNameInDocument(), Gui::ViewProviderDocumentObject::getObject(), showPreview(), PartDesignGui::TaskSketchBasedParameters::startReferenceSelection(), and PartDesignGui::TaskFeatureParameters::vp.

◆ updateView()

bool PartDesignGui::TaskHelixParameters::updateView ( ) const

protected

Member Data Documentation

◆ propAngle

App::PropertyAngle* PartDesignGui::TaskHelixParameters::propAngle

protected

Referenced by apply().

◆ propGrowth

App::PropertyDistance* PartDesignGui::TaskHelixParameters::propGrowth

protected

Referenced by apply().

◆ propHeight

App::PropertyLength* PartDesignGui::TaskHelixParameters::propHeight

protected

Referenced by apply().

◆ propLeftHanded

App::PropertyBool* PartDesignGui::TaskHelixParameters::propLeftHanded

protected

Referenced by apply().

◆ propMode

App::PropertyEnumeration* PartDesignGui::TaskHelixParameters::propMode

protected

Referenced by apply().

◆ propOutside

App::PropertyBool* PartDesignGui::TaskHelixParameters::propOutside

protected

◆ propPitch

App::PropertyLength* PartDesignGui::TaskHelixParameters::propPitch

protected

Referenced by apply().

◆ propReferenceAxis

App::PropertyLinkSub* PartDesignGui::TaskHelixParameters::propReferenceAxis

protected

Referenced by onSelectionChanged().

◆ propReversed

App::PropertyBool* PartDesignGui::TaskHelixParameters::propReversed

protected

Referenced by apply().

◆ propTurns

App::PropertyFloatConstraint* PartDesignGui::TaskHelixParameters::propTurns

protected

Referenced by apply().

The documentation for this class was generated from the following files:

FreeCAD/src/Mod/PartDesign/Gui/TaskHelixParameters.h
FreeCAD/src/Mod/PartDesign/Gui/TaskHelixParameters.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TaskHelixParameters()

◆ ~TaskHelixParameters()

Member Function Documentation

◆ apply()

◆ changeEvent()

◆ finishReferenceSelection()

◆ getReferenceAxis()

◆ onSelectionChanged()

◆ showPreview()

◆ startReferenceSelection()

◆ updateView()

Member Data Documentation

◆ propAngle

◆ propGrowth

◆ propHeight

◆ propLeftHanded

◆ propMode

◆ propOutside

◆ propPitch

◆ propReferenceAxis

◆ propReversed

◆ propTurns