FreeCAD: Gui::SelectionChanges Class Reference

Transport the changes of the Selection This class transports closer information what was changed in the selection. More...

#include <Selection.h>

Public Types
enum class	MsgSource { Any = 0 , Internal = 1 , TreeView = 2 }

enum	MsgType { AddSelection , RmvSelection , SetSelection , ClrSelection , SetPreselect , RmvPreselect , SetPreselectSignal , PickedListChanged , ShowSelection , HideSelection , RmvPreselectSignal , MovePreselect }

Public Member Functions
SelectionChanges &	operator= (const SelectionChanges &other)

SelectionChanges &	operator= (SelectionChanges &&other)

	SelectionChanges (const SelectionChanges &other)

	SelectionChanges (MsgType type, const std::string &docName, const std::string &objName, const std::string &subName, const std::string &typeName=std::string(), float x=0, float y=0, float z=0, MsgSource subtype=MsgSource::Any)

	SelectionChanges (MsgType type=ClrSelection, const char docName=nullptr, const char objName=nullptr, const char subName=nullptr, const char typeName=nullptr, float x=0, float y=0, float z=0, MsgSource subtype=MsgSource::Any)

	SelectionChanges (SelectionChanges &&other)

Public Attributes
App::SubObjectT	Object

const char *	pDocName

const char *	pObjectName

const SelectionChanges *	pOriginalMsg = nullptr

const char *	pSubName

const char *	pTypeName

MsgSource	SubType

MsgType	Type

std::string	TypeName

float	x

float	y

float	z

Detailed Description

Transport the changes of the Selection This class transports closer information what was changed in the selection.

It's an optional information and not all commands set this information. If not set all observer of the selection assume a full change and update everything (e.g 3D view). This is not a very good idea if, e.g. only a small parameter has changed. Therefore one can use this class and make the update of the document much faster!

See also: Base::Observer

Member Enumeration Documentation

◆ MsgSource

enum class Gui::SelectionChanges::MsgSource

strong

Enumerator
Any
Internal
TreeView

◆ MsgType

enum Gui::SelectionChanges::MsgType

Enumerator
AddSelection
RmvSelection
SetSelection
ClrSelection
SetPreselect
RmvPreselect
SetPreselectSignal
PickedListChanged
ShowSelection
HideSelection
RmvPreselectSignal
MovePreselect

Constructor & Destructor Documentation

◆ SelectionChanges() [1/4]

Gui::SelectionChanges::SelectionChanges	(	MsgType	type = `ClrSelection`,
		const char *	docName = `nullptr`,
		const char *	objName = `nullptr`,
		const char *	subName = `nullptr`,
		const char *	typeName = `nullptr`,
		float	x = `0`,
		float	y = `0`,
		float	z = `0`,
		MsgSource	subtype = `MsgSource::Any`
	)

◆ SelectionChanges() [2/4]

Gui::SelectionChanges::SelectionChanges	(	MsgType	type,
		const std::string &	docName,
		const std::string &	objName,
		const std::string &	subName,
		const std::string &	typeName = `std::string()`,
		float	x = `0`,
		float	y = `0`,
		float	z = `0`,
		MsgSource	subtype = `MsgSource::Any`
	)

◆ SelectionChanges() [3/4]

Gui::SelectionChanges::SelectionChanges ( const SelectionChanges & other )

◆ SelectionChanges() [4/4]

Gui::SelectionChanges::SelectionChanges ( SelectionChanges && other )

References draftfunctions.move::move().

Member Function Documentation

◆ operator=() [1/2]

SelectionChanges & Gui::SelectionChanges::operator= ( const SelectionChanges & other )

References Object, pOriginalMsg, SubType, Type, TypeName, x, y, and z.

◆ operator=() [2/2]

SelectionChanges & Gui::SelectionChanges::operator= ( SelectionChanges && other )

References draftfunctions.move::move(), and Type.

Member Data Documentation

◆ Object

App::SubObjectT Gui::SelectionChanges::Object

Referenced by draftviewproviders.view_layer.ViewProviderLayer::activate(), ArchPanel.CommandPanelSheet::Activated(), ArchStructure.CommandStructuralSystem::Activated(), OpenSCADFeatures.ViewProviderTree::attach(), ArchComponent.ViewProviderComponent::attach(), draftviewproviders.view_base.ViewProviderDraft::attach(), draftviewproviders.view_dimension.ViewProviderLinearDimension::attach(), draftviewproviders.view_dimension.ViewProviderAngularDimension::attach(), draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation::attach(), draftviewproviders.view_layer.ViewProviderLayer::attach(), draftviewproviders.view_layer.ViewProviderLayerContainer::attach(), PathScripts.PathArray.ViewProviderArray::attach(), PathScripts.PathCopy.ViewProviderPathCopy::attach(), PathScripts.PathDressupDragknife.ViewProviderDressup::attach(), PathScripts.PathHop.ViewProviderPathHop::attach(), PathScripts.PathOpGui.ViewProvider::attach(), ArchSite.Compass::buildCoordinates(), ArchReference.ViewProviderArchReference::checkChanges(), ArchComponent.ViewProviderComponent::claimChildren(), draftviewproviders.view_base.ViewProviderDraft::claimChildren(), draftviewproviders.view_draft_annotation.ViewProviderDraftAnnotation::claimChildren(), draftviewproviders.view_draftlink.ViewProviderDraftLink::claimChildren(), draftviewproviders.view_layer.ViewProviderLayer::claimChildren(), draftviewproviders.view_wire.ViewProviderWire::claimChildren(), femviewprovider.view_mesh_gmsh.VPMeshGmsh::claimChildren(), femviewprovider.view_result_mechanical.VPResultMechanical::claimChildren(), OpenSCADFeatures.ViewProviderTree::claimChildren(), BOPTools.JoinFeatures.ViewProviderConnect::claimChildren(), BOPTools.JoinFeatures.ViewProviderEmbed::claimChildren(), BOPTools.JoinFeatures.ViewProviderCutout::claimChildren(), BOPTools.SplitFeatures.ViewProviderBooleanFragments::claimChildren(), BOPTools.SplitFeatures.ViewProviderSlice::claimChildren(), BOPTools.SplitFeatures.ViewProviderXOR::claimChildren(), PathScripts.PathArray.ViewProviderArray::claimChildren(), PathScripts.PathDressupDragknife.ViewProviderDressup::claimChildren(), Spreadsheet_legacy.ViewProviderSpreadsheet::claimChildren(), PathScripts.PathOpGui.ViewProvider::clearTaskPanel(), ArchBuildingPart.ViewProviderBuildingPart::cloneUp(), ArchStructure.StructureTaskPanel::connectNodes(), ArchBuildingPart.ViewProviderBuildingPart::createGroup(), draftviewproviders.view_text.ViewProviderText::createObject(), femviewprovider.view_mesh_gmsh.VPMeshGmsh::doubleClicked(), femviewprovider.view_mesh_gmsh.VPMeshGmsh::dragObject(), BOPTools.JoinFeatures.ViewProviderConnect::dragObject(), BOPTools.SplitFeatures.ViewProviderBooleanFragments::dragObject(), BOPTools.SplitFeatures.ViewProviderXOR::dragObject(), femviewprovider.view_mesh_gmsh.VPMeshGmsh::dropObject(), BOPTools.JoinFeatures.ViewProviderConnect::dropObject(), BOPTools.SplitFeatures.ViewProviderBooleanFragments::dropObject(), BOPTools.SplitFeatures.ViewProviderXOR::dropObject(), ArchStructure.StructureTaskPanel::extendNodes(), draftviewproviders.view_wire.ViewProviderWire::flatten(), Mod.Show.Containers.Container::getCSChildren(), Mod.Show.Containers.Container::getDynamicChildren(), ArchBuildingPart.ViewProviderBuildingPart::getIcon(), ArchComponent.ViewProviderComponent::getIcon(), draftviewproviders.view_array.ViewProviderDraftArray::getIcon(), draftviewproviders.view_base.ViewProviderDraft::getIcon(), draftviewproviders.view_dimension.ViewProviderDimensionBase::getIcon(), draftviewproviders.view_draftlink.ViewProviderDraftLink::getIcon(), femviewprovider.view_base_femobject.VPBaseFemObject::getIcon(), femviewprovider.view_material_common.VPMaterialCommon::getIcon(), OpenSCADFeatures.ViewProviderTree::getIcon(), PathScripts.PathOpGui.ViewProvider::getIcon(), Mod.Show.Containers.Container::getStaticChildren(), Mod.Show.Containers.Container::getVisGroupChildren(), Mod.Show.Containers.Container::hasObjectRecursive(), Gui::SelectionSingleton::hasPreselection(), draftviewproviders.view_dimension.ViewProviderLinearDimension::is_linked_to_circle(), Mod.Show.Containers.Container::isACS(), ArchSchedule.CommandArchSchedule::IsActive(), Mod.Show.Containers.Container::isAVisGroup(), Mod.Show.Containers.Container::isChildVisible(), draftviewproviders.view_layer.ViewProviderLayerContainer::merge_by_name(), Gui::SelectionSingleton::notify(), draftviewproviders.view_base.ViewProviderDraft::onChanged(), BOPTools.JoinFeatures.ViewProviderEmbed::onDelete(), BOPTools.JoinFeatures.ViewProviderCutout::onDelete(), ArchReference.ViewProviderArchReference::onOpen(), ArchReference.ViewProviderArchReference::onReload(), operator=(), ArchBuildingPart.ViewProviderBuildingPart::reorder(), ArchStructure.StructureTaskPanel::resetNodes(), draftviewproviders.view_layer.ViewProviderLayer::select_contents(), Mod.Show.Containers.Container::self_check(), ArchComponent.ViewProviderComponent::setDisplayMode(), ArchComponent.ViewProviderComponent::setEdit(), Mod.PartDesign.SprocketFeature.ViewProviderSprocket::setEdit(), Gui::SelectionSingleton::setPreselectCoord(), ArchStructure.StructureTaskPanel::setSelectionFromTool(), ArchStructure.StructureTaskPanel::setToolFromSelection(), PathScripts.PathOpGui.ViewProvider::setupTaskPanel(), ArchBuildingPart.ViewProviderBuildingPart::setWorkingPlane(), Gui::SelectionSingleton::slotSelectionChanged(), femviewprovider.view_result_mechanical.VPResultMechanical::unsetEdit(), ArchBuildingPart.ViewProviderBuildingPart::writeCamera(), draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy::writeCamera(), ArchBuildingPart.ViewProviderBuildingPart::writeInventor(), and draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy::writeState().

◆ pDocName

const char* Gui::SelectionChanges::pDocName

Referenced by Gui::SelectionSingleton::addSelection(), Gui::SelectionSingleton::addSelections(), Gui::View3DInventorViewer::checkGroupOnTop(), Gui::SoFCSelection::doAction(), Gui::SoFCUnifiedSelection::doAction(), Gui::SelectionSingleton::setPreselectCoord(), and Gui::SelectionSingleton::updateSelection().

◆ pObjectName

const char* Gui::SelectionChanges::pObjectName

Referenced by Gui::SelectionSingleton::addSelection(), Gui::SelectionSingleton::addSelections(), Gui::View3DInventorViewer::checkGroupOnTop(), Gui::SoFCSelection::doAction(), Gui::SoFCUnifiedSelection::doAction(), Gui::SelectionSingleton::setPreselectCoord(), and Gui::SelectionSingleton::updateSelection().

◆ pOriginalMsg

const SelectionChanges* Gui::SelectionChanges::pOriginalMsg = nullptr

Referenced by operator=(), and Gui::SelectionSingleton::slotSelectionChanged().

◆ pSubName

const char* Gui::SelectionChanges::pSubName

Referenced by Gui::SelectionSingleton::addSelection(), Gui::SelectionSingleton::addSelections(), Gui::View3DInventorViewer::checkGroupOnTop(), Gui::SoFCSelection::doAction(), Gui::SoFCUnifiedSelection::doAction(), Gui::SelectionSingleton::setPreselectCoord(), Gui::SelectionSingleton::slotSelectionChanged(), and Gui::SelectionSingleton::updateSelection().

◆ pTypeName

const char* Gui::SelectionChanges::pTypeName

◆ SubType

MsgSource Gui::SelectionChanges::SubType

Referenced by operator=().

◆ Type

MsgType Gui::SelectionChanges::Type

Referenced by ArchPanel.CommandPanelSheet::Activated(), ArchStructure.CommandStructuralSystem::Activated(), draftobjects.draft_annotation.DraftAnnotation::add_missing_properties_0v19(), ArchStructure.StructSelectionObserver::addSelection(), ArchSite.Compass::buildCoordinates(), Gui::View3DInventorViewer::checkGroupOnTop(), Gui::Dialog::DefaultTransformStrategy::DefaultTransformStrategy(), Gui::SoFCSelection::doAction(), Gui::SoFCUnifiedSelection::doAction(), ArchComponent.Component::execute(), draftobjects.layer.LayerContainer::execute(), ArchSchedule.CommandArchSchedule::IsActive(), Gui::SelectionSingleton::notify(), SketcherGui::ViewProviderSketch::onSelectionChanged(), operator=(), draftobjects.layer.Layer::set_properties(), Gui::SelectionSingleton::setPreselect(), and ArchReference.ArchReference::setProperties().

◆ TypeName

std::string Gui::SelectionChanges::TypeName

Referenced by operator=().

◆ x

float Gui::SelectionChanges::x

Referenced by Mod.PartDesign.Scripts.FilletArc.Vector::add(), DraftGui.DraftToolBar::changeXValue(), importSVG.svgHandler::characters(), PathScripts.PathInspect.GCodeEditorDialog::cleanup(), Mod.PartDesign.Scripts.FilletArc.Vector::cross(), Gui::SoFCUnifiedSelection::doAction(), PathScripts.PostUtils.GCodeEditorDialog::done(), Mod.PartDesign.Scripts.FilletArc.Vector::dot(), Mod.PartDesign.Scripts.FilletArc.Vector::length(), Mod.PartDesign.Scripts.FilletArc.Vector::mult(), Mod.PartDesign.Scripts.FilletArc.Vector::norm(), operator=(), PathScripts.PathDressupHoldingTags.Tag::originAt(), DraftGui.DraftToolBar::pointUi(), DraftGui.DraftToolBar::reset_ui_values(), Gui::SelectionSingleton::setPreselectCoord(), Mod.PartDesign.Scripts.FilletArc.Vector::sub(), DraftGui.DraftToolBar::update_cartesian_coords(), DraftGui.DraftToolBar::update_spherical_coords(), DraftGui.DraftToolBar::updateSnapper(), DraftGui.DraftToolBar::validatePoint(), and automotive_design.right_angular_wedge::wr1().

◆ y

float Gui::SelectionChanges::y

Referenced by Mod.PartDesign.Scripts.FilletArc.Vector::add(), DraftGui.DraftToolBar::changeYValue(), importSVG.svgHandler::characters(), PathScripts.PathInspect.GCodeEditorDialog::cleanup(), Mod.PartDesign.Scripts.FilletArc.Vector::cross(), Gui::SoFCUnifiedSelection::doAction(), PathScripts.PostUtils.GCodeEditorDialog::done(), Mod.PartDesign.Scripts.FilletArc.Vector::dot(), Mod.PartDesign.Scripts.FilletArc.Vector::length(), Mod.PartDesign.Scripts.FilletArc.Vector::mult(), Mod.PartDesign.Scripts.FilletArc.Vector::norm(), operator=(), PathScripts.PathDressupHoldingTags.Tag::originAt(), DraftGui.DraftToolBar::pointUi(), DraftGui.DraftToolBar::reset_ui_values(), Gui::SelectionSingleton::setPreselectCoord(), Mod.PartDesign.Scripts.FilletArc.Vector::sub(), DraftGui.DraftToolBar::update_cartesian_coords(), DraftGui.DraftToolBar::update_spherical_coords(), DraftGui.DraftToolBar::updateSnapper(), and DraftGui.DraftToolBar::validatePoint().

◆ z

float Gui::SelectionChanges::z

Referenced by Mod.PartDesign.Scripts.FilletArc.Vector::add(), automotive_design.revolved_area_solid::axis_line(), automotive_design.surface_of_revolution::axis_line(), automotive_design.revolved_face_solid::axis_line(), ifc4.ifcrevolvedareasolid::axisdirectioninxy(), ifc2x3.ifcsurfaceofrevolution::axisline(), ifc2x3.ifcrevolvedareasolid::axisline(), ifc4.ifcsurfaceofrevolution::axisline(), ifc4.ifcrevolvedareasolid::axisline(), PathScripts.PathDressupHoldingTags.Tag::bottom(), DraftGui.DraftToolBar::changeZValue(), PathScripts.PathDressupTag.TagSolid::cloneAt(), PathScripts.PathDressupHoldingTags.Tag::createSolidsAt(), Mod.PartDesign.Scripts.FilletArc.Vector::cross(), Gui::SoFCUnifiedSelection::doAction(), Mod.PartDesign.Scripts.FilletArc.Vector::dot(), Mod.PartDesign.Scripts.FilletArc.Vector::length(), Mod.PartDesign.Scripts.FilletArc.Vector::mult(), Mod.PartDesign.Scripts.FilletArc.Vector::norm(), operator=(), DraftGui.DraftToolBar::pointUi(), DraftGui.DraftToolBar::reset_ui_values(), Gui::SelectionSingleton::setPreselectCoord(), importSH3D.SH3DHandler::startElement(), Mod.PartDesign.Scripts.FilletArc.Vector::sub(), PathScripts.PathDressupHoldingTags.Tag::top(), DraftGui.DraftToolBar::update_cartesian_coords(), DraftGui.DraftToolBar::update_spherical_coords(), DraftGui.DraftToolBar::updateSnapper(), DraftGui.DraftToolBar::validatePoint(), and ifc2x3.ifcrevolvedareasolid::wr32().

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

FreeCAD/src/Gui/Selection.h