Gui::AlignmentGroup Class Reference
The AlignemntGroup class is the base for fixed and movable groups. More...
#include <ManualAlignment.h>
Public Member Functions | |
| void | addPoint (const PickedPoint &) |
| Add a point to an array of picked points. More... | |
| void | addToViewer (Gui::View3DInventorViewer *) const |
| Add the group and therefore all its added view providers to the Inventor tree. More... | |
| void | addView (App::DocumentObject *) |
| Add a mesh to the group. More... | |
| void | clear () |
| Clear the list of added views. More... | |
| void | clearPoints () |
| Clear all picked points. More... | |
| int | count () const |
| Return the number of added views. More... | |
| int | countPoints () const |
| Count the number of picked points. More... | |
| Base::BoundBox3d | getBoundingBox () const |
| Get the overall bounding box of all views. More... | |
| Gui::Document * | getDocument () const |
| Returns the document of the added views. More... | |
| const std::vector< PickedPoint > & | getPoints () const |
| Return an array of picked points. More... | |
| std::vector< App::DocumentObject * > | getViews () const |
| bool | hasView (Gui::ViewProviderDocumentObject *) const |
| Checks for the view provider of one of the added views. More... | |
| bool | isEmpty () const |
| Checks whether the list of added views is empty or not. More... | |
| void | moveTo (AlignmentGroup &) |
| void | removeFromViewer (Gui::View3DInventorViewer *) const |
| Remove all the view providers from the Inventor tree. More... | |
| void | removeLastPoint () |
| Remove last point from array of picked points. More... | |
| void | removeView (Gui::ViewProviderDocumentObject *) |
| Remove a previously added view by its view provider. More... | |
| void | setAlignable (bool) |
| Set or unset the alignable mode for the added views. More... | |
| void | setRandomColor () |
Protected Member Functions | |
| AlignmentGroup () | |
| ~AlignmentGroup () | |
Detailed Description
The AlignemntGroup class is the base for fixed and movable groups.
Constructor & Destructor Documentation
◆ AlignmentGroup()
|
protected |
◆ ~AlignmentGroup()
|
protected |
Member Function Documentation
◆ addPoint()
| void AlignmentGroup::addPoint | ( | const PickedPoint & | pnt | ) |
Add a point to an array of picked points.
Referenced by draftguitools.gui_stretch.Stretch::action(), Gui::ManualAlignment::applyPickedProbe(), and draftguitools.gui_stretch.Stretch::numericInput().
◆ addToViewer()
| void AlignmentGroup::addToViewer | ( | Gui::View3DInventorViewer * | viewer | ) | const |
Add the group and therefore all its added view providers to the Inventor tree.
References OfflineRenderingUtils::viewer().
Referenced by Gui::ManualAlignment::align(), and Gui::ManualAlignment::startAlignment().
◆ addView()
| void AlignmentGroup::addView | ( | App::DocumentObject * | pView | ) |
Add a mesh to the group.
References Gui::Application::getDocument(), Gui::Document::getViewProvider(), and Gui::Application::Instance.
Referenced by StdCmdAlignment::activated().
◆ clear()
| void AlignmentGroup::clear | ( | ) |
Clear the list of added views.
Referenced by Gui::ManualAlignment::clearAll(), moveTo(), Gui::ManualAlignment::onClear(), and Gui::ManualAlignment::reset().
◆ clearPoints()
| void AlignmentGroup::clearPoints | ( | ) |
Clear all picked points.
Referenced by Gui::ManualAlignment::continueAlignment().
◆ count()
| int AlignmentGroup::count | ( | ) | const |
Return the number of added views.
Referenced by importDXF.dxfcounter::incr(), importSVG.svgHandler::startElement(), Mod.Test.BaseTests.ConsoleTestCase::testAsynchronPrintFromThread(), and Mod.Test.BaseTests.ConsoleTestCase::testSynchronPrintFromThread().
◆ countPoints()
| int AlignmentGroup::countPoints | ( | ) | const |
Count the number of picked points.
Referenced by Gui::ManualAlignment::align(), Gui::ManualAlignment::applyPickedProbe(), Gui::ManualAlignment::canAlign(), Gui::ManualAlignment::onRemoveLastPointFixed(), Gui::ManualAlignment::onRemoveLastPointMoveable(), Gui::ManualAlignment::probePickedCallback(), and Gui::ManualAlignment::showInstructions().
◆ getBoundingBox()
| Base::BoundBox3d AlignmentGroup::getBoundingBox | ( | ) | const |
Get the overall bounding box of all views.
References App::PropertyComplexGeoData::getBoundingBox(), Base::Persistence::getClassTypeId(), and App::GeoFeature::getPropertyOfGeometry().
◆ getDocument()
| Gui::Document * AlignmentGroup::getDocument | ( | void | ) | const |
Returns the document of the added views.
References Gui::Application::getDocument(), and Gui::Application::Instance.
Referenced by Gui::ManualAlignment::setFixedGroup().
◆ getPoints()
| const std::vector< PickedPoint > & AlignmentGroup::getPoints | ( | ) | const |
Return an array of picked points.
Referenced by Gui::ManualAlignment::align().
◆ getViews()
| std::vector< App::DocumentObject * > AlignmentGroup::getViews | ( | ) | const |
Referenced by Gui::ManualAlignment::align().
◆ hasView()
| bool AlignmentGroup::hasView | ( | Gui::ViewProviderDocumentObject * | pView | ) | const |
Checks for the view provider of one of the added views.
Referenced by Gui::ManualAlignment::applyPickedProbe(), and Gui::ManualAlignment::slotDeletedObject().
◆ isEmpty()
| bool AlignmentGroup::isEmpty | ( | void | ) | const |
Checks whether the list of added views is empty or not.
Referenced by Gui::ManualAlignment::probePickedCallback(), and Gui::ManualAlignment::startAlignment().
◆ moveTo()
| void AlignmentGroup::moveTo | ( | AlignmentGroup & | that | ) |
References clear().
Referenced by Gui::ManualAlignment::align(), PathScripts.PathDressupDogbone.Chord::moveBy(), and PathScripts.PathDressupDogbone.Chord::moveToParameters().
◆ removeFromViewer()
| void AlignmentGroup::removeFromViewer | ( | Gui::View3DInventorViewer * | viewer | ) | const |
Remove all the view providers from the Inventor tree.
References OfflineRenderingUtils::viewer().
Referenced by Gui::ManualAlignment::align().
◆ removeLastPoint()
| void AlignmentGroup::removeLastPoint | ( | ) |
Remove last point from array of picked points.
Referenced by Gui::ManualAlignment::onRemoveLastPointFixed(), and Gui::ManualAlignment::onRemoveLastPointMoveable().
◆ removeView()
| void AlignmentGroup::removeView | ( | Gui::ViewProviderDocumentObject * | pView | ) |
Remove a previously added view by its view provider.
◆ setAlignable()
| void AlignmentGroup::setAlignable | ( | bool | align | ) |
Set or unset the alignable mode for the added views.
If a view is not alignable it also not pickable.
References App::PropertyBool::setValue(), and App::Property::touch().
Referenced by Gui::ManualAlignment::align(), Gui::ManualAlignment::reset(), and Gui::ManualAlignment::startAlignment().
◆ setRandomColor()
| void AlignmentGroup::setRandomColor | ( | ) |
References Base::Persistence::getClassTypeId().
The documentation for this class was generated from the following files:
- FreeCAD/src/Gui/ManualAlignment.h
- FreeCAD/src/Gui/ManualAlignment.cpp
