Gui::SoFCSelection Class Reference

Selection node This node does the complete highlighting and selection together with the viewer. More...

#include <SoFCSelection.h>

Public Types
enum	HighlightModes { AUTO , ON , OFF }
enum	Selected { NOTSELECTED , SELECTED }
enum	SelectionModes { SEL_ON , SEL_OFF }
enum	Styles { EMISSIVE , EMISSIVE_DIFFUSE , BOX }

Public Member Functions
void	applySettings ()
	Load highlight settings from the configuration. More...
virtual void	doAction (SoAction *action)
virtual void	GLRender (SoGLRenderAction *action)
virtual void	GLRenderBelowPath (SoGLRenderAction *action)
virtual void	GLRenderInPath (SoGLRenderAction *action)
virtual void	handleEvent (SoHandleEventAction *action)
SbBool	isHighlighted (void) const
	SoFCSelection (void)

Static Public Member Functions
static void	finish (void)
static void	initClass (void)
static void	turnOffCurrentHighlight (SoGLRenderAction *action)

Public Attributes
SoSFColor	colorHighlight
SoSFColor	colorSelection
SoSFString	documentName
SoSFEnum	highlightMode
SoSFString	objectName
SoSFEnum	selected
SoSFEnum	selectionMode
SoSFEnum	style
SoSFString	subElementName
SoSFBool	useNewSelection

Protected Types
typedef SoFCSelectionContext	SelContext
typedef std::shared_ptr< SelContext >	SelContextPtr

Protected Member Functions
virtual SbBool	readInstance (SoInput *in, unsigned short flags)
virtual void	redrawHighlighted (SoAction *act, SbBool flag)
virtual	~SoFCSelection ()

Protected Attributes
SelContextPtr	selContext
SelContextPtr	selContext2

Detailed Description

Selection node This node does the complete highlighting and selection together with the viewer.

Author

Jürgen Riegel

Member Typedef Documentation

SelContext

typedef SoFCSelectionContext Gui::SoFCSelection::SelContext

protected

SelContextPtr

typedef std::shared_ptr<SelContext> Gui::SoFCSelection::SelContextPtr

protected

Member Enumeration Documentation

HighlightModes

enum Gui::SoFCSelection::HighlightModes

Enumerator
AUTO
ON
OFF

Selected

enum Gui::SoFCSelection::Selected

Enumerator
NOTSELECTED
SELECTED

SelectionModes

enum Gui::SoFCSelection::SelectionModes

Enumerator
SEL_ON
SEL_OFF

Styles

enum Gui::SoFCSelection::Styles

Enumerator
EMISSIVE
EMISSIVE_DIFFUSE
BOX

Constructor & Destructor Documentation

SoFCSelection()

SoFCSelection::SoFCSelection

(

void

)

Constructor.

~SoFCSelection()

SoFCSelection::~SoFCSelection ( )

protectedvirtual

Destructor.

Member Function Documentation

applySettings()

void SoFCSelection::applySettings

(

)

Load highlight settings from the configuration.

References colorHighlight, colorSelection, ParameterGrp::GetBool(), Gui::WindowParameter::getDefaultParameter(), ParameterGrp::GetGroup(), ParameterGrp::GetUnsigned(), highlightMode, OFF, SEL_OFF, and selectionMode.

doAction()

void SoFCSelection::doAction ( SoAction *  action )

virtual

References Gui::SelectionChanges::AddSelection, Gui::SoSelectionElementAction::All, Gui::SoSelectionElementAction::Append, AUTO, Gui::SelectionChanges::ClrSelection, colorHighlight, colorSelection, Gui::SoFCDocumentObjectAction::componentName, documentName, Gui::SoFCDocumentAction::documentName, Gui::SoFCDocumentObjectAction::documentName, Gui::SoFCSelectionRoot::getActionContext(), Gui::SoHighlightElementAction::getColor(), Gui::SoSelectionElementAction::getColor(), Gui::SoSelectionElementAction::getType(), Gui::SoFCEnableHighlightAction::highlight, Gui::SoFCHighlightColorAction::highlightColor, highlightMode, Gui::SoHighlightElementAction::isHighlighted(), Gui::SelectionSingleton::isSelected(), NOTSELECTED, objectName, Gui::SoFCDocumentObjectAction::objectName, OFF, Gui::SelectionChanges::pDocName, Gui::SelectionChanges::pObjectName, Gui::SelectionChanges::pSubName, Gui::SoSelectionElementAction::Remove, Gui::SelectionChanges::RmvSelection, SEL_OFF, SEL_ON, Gui::SoFCSelectionAction::SelChange, selContext, SELECTED, selected, Gui::Selection(), Gui::SoFCEnableSelectionAction::selection, Gui::SoFCSelectionColorAction::selectionColor, selectionMode, Gui::SoFCDocumentObjectAction::setHandled(), Gui::SelectionChanges::SetSelection, subElementName, Gui::SelectionChanges::Type, and useNewSelection.

finish()

void SoFCSelection::finish ( void  )

static

Referenced by drafttaskpanels.task_circulararray.TaskPanelCircularArray::accept(), drafttaskpanels.task_orthoarray.TaskPanelOrthoArray::accept(), drafttaskpanels.task_polararray.TaskPanelPolarArray::accept(), draftguitools.gui_arcs.Arc::action(), draftguitools.gui_beziers.BezCurve::action(), draftguitools.gui_beziers.CubicBezCurve::action(), draftguitools.gui_dimensions.Dimension::action(), draftguitools.gui_ellipses.Ellipse::action(), draftguitools.gui_fillets.Fillet::action(), draftguitools.gui_labels.Label::action(), draftguitools.gui_lines.Line::action(), draftguitools.gui_mirror.Mirror::action(), draftguitools.gui_move.Move::action(), draftguitools.gui_offset.Offset::action(), draftguitools.gui_polygons.Polygon::action(), draftguitools.gui_rectangles.Rectangle::action(), draftguitools.gui_rotate.Rotate::action(), draftguitools.gui_scale.Scale::action(), draftguitools.gui_selectplane.Draft_SelectPlane::action(), draftguitools.gui_shapestrings.ShapeString::action(), draftguitools.gui_splines.BSpline::action(), draftguitools.gui_split.Split::action(), draftguitools.gui_stretch.Stretch::action(), draftguitools.gui_texts.Text::action(), draftguitools.gui_trimex.Trimex::action(), draftguitools.gui_subelements.SubelementHighlight::action(), draftguitools.gui_clone.Clone::Activated(), draftguitools.gui_dimensions.Dimension::Activated(), draftguitools.gui_downgrade.Downgrade::Activated(), draftguitools.gui_draft2sketch.Draft2Sketch::Activated(), draftguitools.gui_edit.Edit::Activated(), draftguitools.gui_facebinders.Facebinder::Activated(), draftguitools.gui_join.Join::Activated(), draftguitools.gui_shape2dview.Shape2DView::Activated(), draftguitools.gui_subelements.SubelementHighlight::Activated(), draftguitools.gui_upgrade.Upgrade::Activated(), draftguitools.gui_wire2spline.WireToBSpline::Activated(), draftguitools.gui_selectplane.Draft_SelectPlane::checkSelection(), DraftGui.DraftToolBar::checkSpecialChars(), draftguitools.gui_points.Point::click(), draftguitools.gui_labels.Label::create(), draftguitools.gui_ellipses.Ellipse::createObject(), draftguitools.gui_rectangles.Rectangle::createObject(), draftguitools.gui_shapestrings.ShapeString::createObject(), draftguitools.gui_texts.Text::createObject(), draftviewproviders.view_text.ViewProviderText::createObject(), draftguitools.gui_stretch.Stretch::doStretch(), draftguitools.gui_arcs.Arc::drawArc(), draftguitools.gui_polygons.Polygon::drawPolygon(), DraftGui.DraftToolBar::escape(), Gui::SoFCDB::finish(), draftguitools.gui_move.Move::get_object_selection(), draftguitools.gui_rotate.Rotate::get_object_selection(), draftguitools.gui_scale.Scale::get_object_selection(), draftguitools.gui_arcs.Arc_3Points::getPoint(), draftguitools.gui_edit.Edit::keyPressed(), draftguitools.gui_dimensions.Dimension::numericInput(), draftguitools.gui_trimex.Trimex::numericRadius(), draftguitools.gui_fillets.Fillet::numericRadius(), draftguitools.gui_offset.Offset::numericRadius(), draftguitools.gui_rotate.Rotate::numericRadius(), draftguitools.gui_selectplane.Draft_SelectPlane::onClickAlign(), draftguitools.gui_selectplane.Draft_SelectPlane::onClickAuto(), draftguitools.gui_selectplane.Draft_SelectPlane::onClickCenter(), draftguitools.gui_selectplane.Draft_SelectPlane::onClickFront(), draftguitools.gui_selectplane.Draft_SelectPlane::onClickMove(), draftguitools.gui_selectplane.Draft_SelectPlane::onClickPrevious(), draftguitools.gui_selectplane.Draft_SelectPlane::onClickSide(), draftguitools.gui_selectplane.Draft_SelectPlane::onClickTop(), draftguitools.gui_array_simple.Array::proceed(), draftguitools.gui_clone.Clone::proceed(), draftguitools.gui_downgrade.Downgrade::proceed(), draftguitools.gui_draft2sketch.Draft2Sketch::proceed(), draftguitools.gui_edit.Edit::proceed(), draftguitools.gui_facebinders.Facebinder::proceed(), draftguitools.gui_join.Join::proceed(), draftguitools.gui_patharray.PathArray::proceed(), draftguitools.gui_pathtwistedarray.PathTwistedArray::proceed(), draftguitools.gui_pointarray.PointArray::proceed(), draftguitools.gui_shape2dview.Shape2DView::proceed(), draftguitools.gui_subelements.SubelementHighlight::proceed(), draftguitools.gui_trimex.Trimex::proceed(), draftguitools.gui_upgrade.Upgrade::proceed(), draftguitools.gui_split.Split::proceed(), draftguitools.gui_selectplane.Draft_SelectPlane::reject(), drafttaskpanels.task_circulararray.TaskPanelCircularArray::reject(), drafttaskpanels.task_orthoarray.TaskPanelOrthoArray::reject(), drafttaskpanels.task_polararray.TaskPanelPolarArray::reject(), and draftguitools.gui_edit.Edit::setTrackers().

GLRender()

void SoFCSelection::GLRender ( SoGLRenderAction *  action )

virtual

References colorHighlight, colorSelection, selContext, selContext2, SELECTED, selected, and useNewSelection.

GLRenderBelowPath()

void SoFCSelection::GLRenderBelowPath ( SoGLRenderAction *  action )

virtual

References colorHighlight, colorSelection, selContext, selContext2, SELECTED, selected, and useNewSelection.

GLRenderInPath()

void SoFCSelection::GLRenderInPath ( SoGLRenderAction *  action )

virtual

References colorHighlight, colorSelection, selContext, selContext2, SELECTED, selected, and useNewSelection.

handleEvent()

void SoFCSelection::handleEvent ( SoHandleEventAction *  action )

virtual

References Gui::SelectionSingleton::addSelection(), AUTO, Gui::SelectionSingleton::clearSelection(), documentName, Gui::getMainWindow(), highlightMode, isHighlighted(), objectName, OFF, ON, redrawHighlighted(), Gui::SelectionSingleton::rmvPreselect(), Gui::SelectionSingleton::rmvSelection(), Gui::schemaTranslatePoint(), SEL_ON, Gui::Selection(), selectionMode, Gui::SelectionSingleton::setPreselect(), Gui::SelectionSingleton::setPreselectCoord(), Gui::MainWindow::showMessage(), subElementName, and useNewSelection.

initClass()

void SoFCSelection::initClass ( void  )

static

Referenced by Gui::SoFCDB::init().

isHighlighted()

SbBool Gui::SoFCSelection::isHighlighted

(

void

)

const

Referenced by handleEvent().

readInstance()

SbBool SoFCSelection::readInstance ( SoInput *  in, unsigned short  flags  )

protectedvirtual

redrawHighlighted()

void SoFCSelection::redrawHighlighted ( SoAction *  action, SbBool  doHighlight  )

protectedvirtual

Empty method in Coin. Can be used by subclasses to be told when status change.

References AUTO, Gui::SoGLWidgetElement::get(), Gui::SoGLRenderActionElement::get(), and highlightMode.

Referenced by handleEvent().

turnOffCurrentHighlight()

void SoFCSelection::turnOffCurrentHighlight ( SoGLRenderAction *  action )

static

Static method that can be used to turn off the current highlight.

Member Data Documentation

colorHighlight

SoSFColor Gui::SoFCSelection::colorHighlight

Referenced by applySettings(), Gui::ViewProviderAnnotation::attach(), Gui::ViewProviderBuilder::createSelection(), doAction(), GLRender(), GLRenderBelowPath(), and GLRenderInPath().

colorSelection

SoSFColor Gui::SoFCSelection::colorSelection

Referenced by applySettings(), Gui::ViewProviderAnnotation::attach(), Gui::ViewProviderBuilder::createSelection(), doAction(), GLRender(), GLRenderBelowPath(), and GLRenderInPath().

documentName

SoSFString Gui::SoFCSelection::documentName

Referenced by Gui::ViewProviderAnnotation::attach(), MeshGui::ViewProviderMesh::attach(), PointsGui::ViewProviderScattered::attach(), PointsGui::ViewProviderStructured::attach(), Gui::ViewProviderVRMLObject::attach(), RobotGui::ViewProviderRobotObject::attach(), RobotGui::ViewProviderTrajectory::attach(), doAction(), and handleEvent().

highlightMode

SoSFEnum Gui::SoFCSelection::highlightMode

Referenced by applySettings(), Gui::ViewProviderBuilder::createSelection(), doAction(), handleEvent(), redrawHighlighted(), and Gui::ViewProviderGeometryObject::setSelectable().

objectName

SoSFString Gui::SoFCSelection::objectName

Referenced by Gui::ViewProviderAnnotation::attach(), MeshGui::ViewProviderMesh::attach(), PointsGui::ViewProviderScattered::attach(), PointsGui::ViewProviderStructured::attach(), Gui::ViewProviderVRMLObject::attach(), RobotGui::ViewProviderRobotObject::attach(), RobotGui::ViewProviderTrajectory::attach(), doAction(), and handleEvent().

selContext

SelContextPtr Gui::SoFCSelection::selContext

protected

Referenced by doAction(), GLRender(), GLRenderBelowPath(), and GLRenderInPath().

selContext2

SelContextPtr Gui::SoFCSelection::selContext2

protected

Referenced by GLRender(), GLRenderBelowPath(), and GLRenderInPath().

selected

SoSFEnum Gui::SoFCSelection::selected

Referenced by doAction(), GLRender(), GLRenderBelowPath(), GLRenderInPath(), PathScripts.PathDressupTagGui.HoldingTagMarker::setEnabled(), Gui::ViewProviderGeometryObject::setSelectable(), and PathScripts.PathDressupTagGui.HoldingTagMarker::setSelected().

selectionMode

SoSFEnum Gui::SoFCSelection::selectionMode

Referenced by applySettings(), Mod.PartDesign.FeatureHole.TaskHole.TaskHole::buttonRef1(), Mod.PartDesign.FeatureHole.TaskHole.TaskHole::buttonRef2(), Mod.PartDesign.FeatureHole.TaskHole.TaskHole::buttonSupport(), Gui::ViewProviderBuilder::createSelection(), doAction(), handleEvent(), Gui::ViewProviderGeometryObject::setSelectable(), and PointsGui::ViewProviderPoints::ViewProviderPoints().

style

SoSFEnum Gui::SoFCSelection::style

Referenced by MeshGui::ViewProviderMesh::onChanged(), and PointsGui::ViewProviderPoints::onChanged().

subElementName

SoSFString Gui::SoFCSelection::subElementName

Referenced by Gui::ViewProviderAnnotation::attach(), MeshGui::ViewProviderMesh::attach(), PointsGui::ViewProviderScattered::attach(), PointsGui::ViewProviderStructured::attach(), Gui::ViewProviderVRMLObject::attach(), RobotGui::ViewProviderRobotObject::attach(), RobotGui::ViewProviderTrajectory::attach(), doAction(), and handleEvent().

useNewSelection

SoSFBool Gui::SoFCSelection::useNewSelection

Referenced by doAction(), GLRender(), GLRenderBelowPath(), GLRenderInPath(), and handleEvent().

---

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

• FreeCAD/src/Gui/SoFCSelection.h
• FreeCAD/src/Gui/SoFCSelection.cpp