PartDesignGui::TaskTransformedParameters Class Referenceabstract

The transformed subclasses will be used in two different modes: More...

#include <TaskTransformedParameters.h>

Public Member Functions

virtual void apply ()=0
 
void exitSelectionMode ()
 
App::DocumentObjectgetBaseObject () const
 Get the TransformedFeature object associated with this task. More...
 
const std::vector< App::DocumentObject * > & getOriginals (void) const
 Returns the originals property of associated top feeature object. More...
 
App::DocumentObjectgetSketchObject () const
 Get the sketch object of the first original either of the object associated with this feature or with the parent feature (MultiTransform mode) More...
 
int getTransactionID () const
 
bool isEnabledTransaction () const
 
void setEnabledTransaction (bool)
 setEnabledTransaction The transaction handling of this panel can be disabled if there is another instance that does it already, e.g. TaskDlgMultiTransformParameters. By default, transactions are enabled. More...
 
void setupTransaction ()
 
 TaskTransformedParameters (TaskMultiTransformParameters *parentTask)
 Constructor for task with parent task (MultiTransform mode) More...
 
 TaskTransformedParameters (ViewProviderTransformed *TransformedView, QWidget *parent=nullptr)
 Constructor for task with ViewProvider. More...
 
virtual ~TaskTransformedParameters ()
 
- 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...
 
ActionLabeladdAction (QAction *action, bool addToLayout=true, bool addStretch=true)
 Creates action item from the action and returns it. More...
 
ActionLabeladdActionLabel (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::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 ()
 
- 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 ()
 

Protected Types

enum  selectionModes { none , addFeature , removeFeature , reference }
 

Protected Slots

PartDesign::TransformedgetTopTransformedObject () const
 Returns the base transformed object For stand alone features it will be objects associated with this object For features inside multitransform it will be the base multitransform object. More...
 
PartDesignGui::ViewProviderTransformedgetTopTransformedView () const
 Returns the base transformation view provider For stand alone features it will be view provider associated with this object For features inside multitransform it will be the view provider of the multitransform object. More...
 
void indexesMoved ()
 
void onButtonAddFeature (const bool checked)
 
void onButtonRemoveFeature (const bool checked)
 
virtual void onFeatureDeleted (void)=0
 
virtual void onSubTaskButtonOK ()
 Connect the subTask OK button to the MultiTransform task. More...
 
- Protected Slots inherited from QSint::ActionGroup
void processHide ()
 
void processShow ()
 

Protected Member Functions

virtual void addObject (App::DocumentObject *)
 
void addReferenceSelectionGate (AllowSelectionFlags)
 
virtual void changeEvent (QEvent *e)=0
 
void checkVisibility ()
 
virtual void clearButtons ()=0
 
void fillAxisCombo (ComboLinks &combolinks, Part::Part2DObject *sketch)
 
void fillPlanesCombo (ComboLinks &combolinks, Part::Part2DObject *sketch)
 
PartDesign::TransformedgetObject () const
 Returns the base transformation For stand alone features it will be objects associated with the view provider For features inside multitransform it will be the parent's multitransform object. More...
 
int getUpdateViewTimeout () const
 
void hideBase ()
 
void hideObject ()
 
bool isViewUpdated () const
 
virtual void onSelectionChanged (const Gui::SelectionChanges &msg)=0
 
bool originalSelected (const Gui::SelectionChanges &msg)
 
void recomputeFeature ()
 Recompute either this feature or the parent feature (MultiTransform mode) More...
 
virtual void removeObject (App::DocumentObject *)
 
void showBase ()
 
void showObject ()
 
virtual void slotDeletedObject (const Gui::ViewProviderDocumentObject &Obj)
 Notifies when the object is about to be removed. More...
 
- 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)
 

Static Protected Member Functions

static void removeItemFromListWidget (QListWidget *widget, const QString &itemstr)
 

Protected Attributes

bool blockUpdate
 Lock updateUI(), applying changes to the underlying feature and calling recomputeFeature() More...
 
bool enableTransaction = true
 
bool insideMultiTransform
 Flag indicating whether this object is a container for MultiTransform. More...
 
TaskMultiTransformParametersparentTask
 The MultiTransform parent task of this task. More...
 
QWidgetproxy
 
selectionModes selectionMode
 
int transactionID = 0
 
ViewProviderTransformedTransformedView
 
- Protected Attributes inherited from QSint::ActionGroup
double m_foldDelta
 
int m_foldDirection
 
QPixmap m_foldPixmap
 
double m_foldStep
 
double m_fullHeight
 
double m_tempHeight
 
QWidgetmyDummy
 
class TaskGroupmyGroup
 
class TaskHeadermyHeader
 
ActionPanelSchememyScheme
 

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...
 
- Properties inherited from QSint::ActionGroup
bool expandable
 
bool header
 
QString headerText
 

Detailed Description

The transformed subclasses will be used in two different modes:

  1. As a stand-alone feature
  2. As a container that stores transformation info for a MultiTransform feature. In this case the flag insideMultiTransform is set to true. Because in the second case there is no ViewProvider, some special methods are required to access the underlying FeatureTransformed object in two different ways.

Member Enumeration Documentation

◆ selectionModes

Enumerator
none 
addFeature 
removeFeature 
reference 

Constructor & Destructor Documentation

◆ TaskTransformedParameters() [1/2]

TaskTransformedParameters::TaskTransformedParameters ( ViewProviderTransformed TransformedView,
QWidget parent = nullptr 
)

◆ TaskTransformedParameters() [2/2]

TaskTransformedParameters::TaskTransformedParameters ( TaskMultiTransformParameters parentTask)

Constructor for task with parent task (MultiTransform mode)

References none, and selectionMode.

◆ ~TaskTransformedParameters()

TaskTransformedParameters::~TaskTransformedParameters ( )
virtual

Member Function Documentation

◆ addObject()

◆ addReferenceSelectionGate()

void TaskTransformedParameters::addReferenceSelectionGate ( AllowSelectionFlags  allow)
protected

◆ apply()

◆ changeEvent()

◆ checkVisibility()

void TaskTransformedParameters::checkVisibility ( )
protected

◆ clearButtons()

◆ exitSelectionMode()

◆ fillAxisCombo()

◆ fillPlanesCombo()

◆ getBaseObject()

App::DocumentObject * TaskTransformedParameters::getBaseObject ( ) const

Get the TransformedFeature object associated with this task.

References PartDesign::Feature::getBaseObject(), PartDesign::Feature::getFeatureBody(), and getTopTransformedObject().

Referenced by addReferenceSelectionGate(), checkVisibility(), hideBase(), and showBase().

◆ getObject()

◆ getOriginals()

const std::vector< App::DocumentObject * > & PartDesignGui::TaskTransformedParameters::getOriginals ( void  ) const

Returns the originals property of associated top feeature object.

◆ getSketchObject()

App::DocumentObject * TaskTransformedParameters::getSketchObject ( ) const

Get the sketch object of the first original either of the object associated with this feature or with the parent feature (MultiTransform mode)

References PartDesign::Transformed::getSketchObject(), and getTopTransformedObject().

◆ getTopTransformedObject

PartDesign::Transformed * TaskTransformedParameters::getTopTransformedObject ( ) const
protectedslot

Returns the base transformed object For stand alone features it will be objects associated with this object For features inside multitransform it will be the base multitransform object.

References Base::Persistence::getClassTypeId(), Gui::ViewProviderDocumentObject::getObject(), and getTopTransformedView().

Referenced by addReferenceSelectionGate(), getBaseObject(), getSketchObject(), hideObject(), and showObject().

◆ getTopTransformedView

PartDesignGui::ViewProviderTransformed * TaskTransformedParameters::getTopTransformedView ( ) const
protectedslot

Returns the base transformation view provider For stand alone features it will be view provider associated with this object For features inside multitransform it will be the view provider of the multitransform object.

References insideMultiTransform, parentTask, and TransformedView.

Referenced by getTopTransformedObject(), and recomputeFeature().

◆ getTransactionID()

int PartDesignGui::TaskTransformedParameters::getTransactionID ( ) const

References transactionID.

◆ getUpdateViewTimeout()

int TaskTransformedParameters::getUpdateViewTimeout ( ) const
protected

◆ hideBase()

void TaskTransformedParameters::hideBase ( )
protected

References getBaseObject().

◆ hideObject()

void TaskTransformedParameters::hideObject ( )
protected

References getTopTransformedObject().

Referenced by onButtonAddFeature().

◆ indexesMoved

◆ isEnabledTransaction()

bool TaskTransformedParameters::isEnabledTransaction ( ) const

References enableTransaction.

Referenced by setupTransaction().

◆ isViewUpdated()

bool TaskTransformedParameters::isViewUpdated ( ) const
protected

References blockUpdate.

◆ onButtonAddFeature

◆ onButtonRemoveFeature

void TaskTransformedParameters::onButtonRemoveFeature ( const bool  checked)
protectedslot

◆ onFeatureDeleted

virtual void PartDesignGui::TaskTransformedParameters::onFeatureDeleted ( void  )
protectedpure virtualslot

◆ onSelectionChanged()

◆ onSubTaskButtonOK

virtual void PartDesignGui::TaskTransformedParameters::onSubTaskButtonOK ( )
protectedvirtualslot

◆ originalSelected()

◆ recomputeFeature()

◆ removeItemFromListWidget()

◆ removeObject()

◆ setEnabledTransaction()

void TaskTransformedParameters::setEnabledTransaction ( bool  on)

setEnabledTransaction The transaction handling of this panel can be disabled if there is another instance that does it already, e.g. TaskDlgMultiTransformParameters. By default, transactions are enabled.

References enableTransaction.

Referenced by PartDesignGui::TaskDlgMultiTransformParameters::TaskDlgMultiTransformParameters().

◆ setupTransaction()

◆ showBase()

void TaskTransformedParameters::showBase ( )
protected

References getBaseObject().

Referenced by onButtonAddFeature().

◆ showObject()

void TaskTransformedParameters::showObject ( )
protected

References getTopTransformedObject().

Referenced by exitSelectionMode().

◆ slotDeletedObject()

void TaskTransformedParameters::slotDeletedObject ( const Gui::ViewProviderDocumentObject Obj)
protectedvirtual

Notifies when the object is about to be removed.

Reimplemented from Gui::DocumentObserver.

References TransformedView.

Member Data Documentation

◆ blockUpdate

◆ enableTransaction

bool PartDesignGui::TaskTransformedParameters::enableTransaction = true
protected

◆ insideMultiTransform

bool PartDesignGui::TaskTransformedParameters::insideMultiTransform
protected

Flag indicating whether this object is a container for MultiTransform.

Referenced by getObject(), and getTopTransformedView().

◆ parentTask

◆ proxy

◆ selectionMode

◆ transactionID

int PartDesignGui::TaskTransformedParameters::transactionID = 0
protected

◆ TransformedView


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