Public Member Functions
const char *	getDefaultDisplayMode () const
	get the default display mode More...

std::vector< std::string >	getDisplayModes (void) const
	returns a list of all possible display modes More...

void	setCoords (const std::vector< Base::Vector3f > &v)

void	updateData (const App::Property *)

	ViewProviderCrossSections ()

	~ViewProviderCrossSections ()

Public Member Functions inherited from Gui::ViewProvider
virtual bool	canAddToSceneGraph () const
	Indicate whether to be added to scene graph or not. More...

virtual std::vector< App::DocumentObject * >	claimChildren3D (void) const
	deliver the children belonging to this object this method is used to deliver the objects to the 3DView which should be grouped under its scene graph. More...

SoSeparator *	getAnnotation (void)

virtual SoSeparator *	getBackRoot (void) const

virtual SoGroup *	getChildRoot (void) const

virtual SoSeparator *	getFrontRoot (void) const

SoSwitch *	getModeSwitch (void) const

virtual SoSeparator *	getRoot (void) const

SoTransform *	getTransformNode () const

	ViewProvider ()
	constructor. More...

virtual	~ViewProvider ()
	destructor. More...

virtual bool	useNewSelectionModel (void) const
	indicates if the ViewProvider use the new Selection model More...

virtual bool	isSelectable (void) const

virtual bool	getElementPicked (const SoPickedPoint *, std::string &subname) const
	return a hit element given the picked point which contains the full node path More...

virtual std::string	getElement (const SoDetail *) const
	return a hit element to the selection path or 0 More...

virtual SoDetail *	getDetail (const char *) const
	return the coin node detail of the subelement More...

virtual bool	getDetailPath (const char subname, SoFullPath pPath, bool append, SoDetail *&det) const
	return the coin node detail and path to the node of the subelement More...

int	partialRender (const std::vector< std::string > &subelements, bool clear)
	partial rendering setup More...

virtual std::vector< Base::Vector3d >	getModelPoints (const SoPickedPoint *) const

virtual std::vector< Base::Vector3d >	getSelectionShape (const char *Element) const
	return the highlight lines for a given element or the whole shape More...

Base::BoundBox3d	getBoundingBox (const char subname=nullptr, bool transform=true, MDIView view=nullptr) const
	Return the bound box of this view object. More...

virtual bool	onDelete (const std::vector< std::string > &subNames)
	Get called if the object is about to get deleted. More...

virtual void	beforeDelete ()
	Called before deletion. More...

virtual bool	canDelete (App::DocumentObject *obj) const
	Asks the view provider if the given object that is part of its outlist can be removed from there without breaking it. More...

virtual bool	canDragObjects () const
	Check whether children can be removed from the view provider by drag and drop. More...

virtual bool	canDragObject (App::DocumentObject *) const
	Check whether the object can be removed from the view provider by drag and drop. More...

virtual void	dragObject (App::DocumentObject *)
	Remove a child from the view provider by drag and drop. More...

virtual bool	canDropObjects () const
	Check whether objects can be added to the view provider by drag and drop or drop only. More...

virtual bool	canDropObject (App::DocumentObject *) const
	Check whether the object can be dropped to the view provider by drag and drop or drop only. More...

virtual bool	canDragAndDropObject (App::DocumentObject *) const
	Return false to force drop only operation for a given object. More...

virtual void	dropObject (App::DocumentObject *)
	Add an object to the view provider by drag and drop. More...

virtual bool	canDropObjectEx (App::DocumentObject obj, App::DocumentObject owner, const char *subname, const std::vector< std::string > &elements) const
	Query object dropping with full qualified name. More...

virtual std::string	getDropPrefix () const
	return a subname referencing the sub-object holding the dropped objects More...

virtual std::string	dropObjectEx (App::DocumentObject obj, App::DocumentObject owner, const char *subname, const std::vector< std::string > &elements)
	Add an object with full qualified name to the view provider by drag and drop. More...

virtual int	replaceObject (App::DocumentObject oldObj, App::DocumentObject newObj)
	Replace an object to the view provider by drag and drop. More...

virtual bool	showInTree () const
	Tell the tree view if this object should appear there. More...

virtual bool	canRemoveChildrenFromRoot () const
	Tell the tree view to remove children items from the tree root. More...

std::string	getActiveDisplayMode (void) const

virtual void	setDisplayMode (const char *ModeName)
	set the display mode More...

virtual void	hide (void)
	Hides the view provider. More...

virtual void	show (void)
	Shows the view provider. More...

virtual bool	isShow (void) const
	checks whether the view provider is visible or not More...

void	setVisible (bool)

bool	isVisible () const

void	setLinkVisible (bool)

bool	isLinkVisible () const

virtual void	setOverrideMode (const std::string &mode)
	Overrides the display mode with mode. More...

const std::string	getOverrideMode ()

virtual void	getTaskViewContent (std::vector< Gui::TaskView::TaskContent * > &) const
	get a list of TaskBoxes associated with this object More...

virtual bool	keyPressed (bool pressed, int key)
	is called when the provider is in edit and a key event occurs. Only ESC ends edit. More...

virtual const char *	getTransactionText () const
	Is called by the tree if the user double clicks on the object. More...

virtual bool	doubleClicked (void)
	is called by the tree if the user double clicks on the object More...

virtual bool	mouseMove (const SbVec2s &cursorPos, View3DInventorViewer *viewer)
	is called when the provider is in edit and the mouse is moved More...

virtual bool	mouseButtonPressed (int button, bool pressed, const SbVec2s &cursorPos, const View3DInventorViewer *viewer)
	is called when the Provider is in edit and the mouse is clicked More...

virtual bool	mouseWheelEvent (int delta, const SbVec2s &cursorPos, const View3DInventorViewer *viewer)

virtual void	setupContextMenu (QMenu , QObject , const char *)
	set up the context-menu with the supported edit modes More...

virtual ViewProvider *	startEditing (int ModNum=0)

bool	isEditing () const

void	finishEditing ()

virtual void	setEditViewer (View3DInventorViewer *, int ModNum)
	adjust viewer settings when editing a view provider More...

virtual void	unsetEditViewer (View3DInventorViewer *)
	restores viewer settings when leaving editing mode More...

virtual void	update (const App::Property *)
	update the content of the ViewProvider this method have to implement the recalculation of the ViewProvider. More...

bool	isUpdatesEnabled () const

void	setUpdatesEnabled (bool enable)

unsigned long	getStatus () const
	return the status bits More...

bool	testStatus (ViewStatus pos) const

void	setStatus (ViewStatus pos, bool on)

std::string	toString () const

PyObject *	getPyObject ()
	This method returns the Python wrapper for a C++ object. More...

virtual QIcon	getIcon (void) const
	deliver the icon shown in the tree view More...

virtual QIcon	mergeColorfulOverlayIcons (const QIcon &orig) const

virtual std::vector< App::DocumentObject * >	claimChildren (void) const
	deliver the children belonging to this object this method is used to deliver the objects to the tree framework which should be grouped under its label. More...

virtual std::map< std::string, App::Color >	getElementColors (const char *element=nullptr) const

virtual void	setElementColors (const std::map< std::string, App::Color > &colors)

virtual void	setTransformation (const Base::Matrix4D &rcMatrix)
	set the viewing transformation of the provider More...

virtual void	setTransformation (const SbMatrix &rcMatrix)

virtual MDIView *	getMDIView () const

virtual void	Restore (Base::XMLReader &reader)
	This method is used to restore properties from an XML document. More...

bool	isRestoring ()

void	addDisplayMaskMode (SoNode node, const char type)
	Adds a new display mask mode. More...

void	setDisplayMaskMode (const char *type)
	Activates the display mask mode type. More...

SoNode *	getDisplayMaskMode (const char *type) const
	Get the node to the display mask mode type. More...

std::vector< std::string >	getDisplayMaskModes () const
	Returns a list of added display mask modes. More...

void	setDefaultMode (int)

int	getDefaultMode () const

virtual void	setRenderCacheMode (int)

Public Member Functions inherited from App::TransactionalObject
virtual const char *	detachFromDocument ()

virtual bool	isAttachedToDocument () const

	TransactionalObject (void)
	Constructor. More...

virtual	~TransactionalObject ()

Public Member Functions inherited from App::ExtensionContainer
ExtensionIterator	extensionBegin ()

	ExtensionContainer ()

ExtensionIterator	extensionEnd ()

App::Extension *	getExtension (Base::Type, bool derived=true, bool no_except=false) const

App::Extension *	getExtension (const std::string &name) const

template<typename ExtensionT >
ExtensionT *	getExtensionByType (bool no_except=false, bool derived=true) const

std::vector< Extension * >	getExtensionsDerivedFrom (Base::Type type) const

template<typename ExtensionT >
std::vector< ExtensionT * >	getExtensionsDerivedFromType () const

bool	hasExtension (Base::Type, bool derived=true) const

bool	hasExtension (const std::string &name) const

bool	hasExtensions () const

void	registerExtension (Base::Type extension, App::Extension *ext)

virtual	~ExtensionContainer ()

virtual Property *	getPropertyByName (const char *name) const override
	find a property by its name More...

virtual const char *	getPropertyName (const Property *prop) const override
	get the name of a property More...

virtual void	getPropertyMap (std::map< std::string, Property * > &Map) const override
	get all properties of the class (including properties of the parent) More...

virtual void	getPropertyList (std::vector< Property * > &List) const override
	get all properties of the class (including properties of the parent) More...

virtual short	getPropertyType (const Property *prop) const override
	get the Type of a Property More...

virtual short	getPropertyType (const char *name) const override
	get the Type of a named Property More...

virtual const char *	getPropertyGroup (const Property *prop) const override
	get the Group of a Property More...

virtual const char *	getPropertyGroup (const char *name) const override
	get the Group of a named Property More...

virtual const char *	getPropertyDocumentation (const Property *prop) const override
	get the Group of a Property More...

virtual const char *	getPropertyDocumentation (const char *name) const override
	get the Group of a named Property More...

virtual void	Save (Base::Writer &writer) const override
	This method is used to save properties to an XML document. More...

void	saveExtensions (Base::Writer &writer) const

void	restoreExtensions (Base::XMLReader &reader)

Public Member Functions inherited from App::PropertyContainer
virtual App::Property *	addDynamicProperty (const char type, const char name=nullptr, const char group=nullptr, const char doc=nullptr, short attr=0, bool ro=false, bool hidden=false)

bool	changeDynamicProperty (const Property prop, const char group, const char *doc)

virtual void	editProperty (const char *)

virtual App::Property *	getDynamicPropertyByName (const char *name) const

DynamicProperty::PropData	getDynamicPropertyData (const Property *prop) const

virtual std::vector< std::string >	getDynamicPropertyNames () const

virtual std::string	getFullName () const

virtual unsigned int	getMemSize (void) const
	This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? More...

virtual Property *	getPropertyByName (const char *name) const
	find a property by its name More...

virtual const char *	getPropertyDocumentation (const char *name) const
	get the Group of a named Property More...

virtual const char *	getPropertyDocumentation (const Property *prop) const
	get the Group of a Property More...

virtual const char *	getPropertyGroup (const char *name) const
	get the Group of a named Property More...

virtual const char *	getPropertyGroup (const Property *prop) const
	get the Group of a Property More...

virtual void	getPropertyList (std::vector< Property * > &List) const
	get all properties of the class (including properties of the parent) More...

virtual void	getPropertyMap (std::map< std::string, Property * > &Map) const
	get all properties of the class (including properties of the parent) More...

virtual const char *	getPropertyName (const Property *prop) const
	get the name of a property More...

virtual void	getPropertyNamedList (std::vector< std::pair< const char , Property > > &List) const
	get all properties with their names, may contain duplicates and aliases More...

const char *	getPropertyPrefix () const

virtual short	getPropertyType (const char *name) const
	get the Type of a named Property More...

virtual short	getPropertyType (const Property *prop) const
	get the Type of a Property More...

bool	isHidden (const char *name) const
	check if the named property is hidden More...

bool	isHidden (const Property *prop) const
	check if the property is hidden More...

bool	isReadOnly (const char *name) const
	check if the named property is read-only More...

bool	isReadOnly (const Property *prop) const
	check if the property is read-only More...

virtual void	onPropertyStatusChanged (const Property &prop, unsigned long oldStatus)

	PropertyContainer ()
	A constructor. More...

virtual bool	removeDynamicProperty (const char *name)

virtual void	Restore (Base::XMLReader &reader)
	This method is used to restore properties from an XML document. More...

virtual void	Save (Base::Writer &writer) const
	This method is used to save properties to an XML document. More...

void	setPropertyPrefix (const char *prefix)

void	setPropertyStatus (unsigned char bit, bool value)
	set the Status bit of all properties at once More...

virtual	~PropertyContainer ()
	A destructor. More...

Public Member Functions inherited from Base::Persistence
void	dumpToStream (std::ostream &stream, int compression)

virtual unsigned int	getMemSize () const =0
	This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? More...

virtual Base::Type	getTypeId (void) const

virtual void	Restore (XMLReader &)=0
	This method is used to restore properties from an XML document. More...

virtual void	RestoreDocFile (Reader &)
	This method is used to restore large amounts of data from a file In this method you simply stream in your SaveDocFile() saved data. More...

void	restoreFromStream (std::istream &stream)

virtual void	Save (Writer &) const =0
	This method is used to save properties to an XML document. More...

virtual void	SaveDocFile (Writer &) const
	This method is used to save large amounts of data to a binary file. More...

Public Member Functions inherited from Base::BaseClass
	BaseClass ()
	Construction. More...

	BaseClass (const BaseClass &)=default

virtual PyObject *	getPyObject ()
	This method returns the Python wrapper for a C++ object. More...

virtual Type	getTypeId () const

bool	isDerivedFrom (const Type type) const

BaseClass &	operator= (const BaseClass &)=default

virtual void	setPyObject (PyObject *)

virtual	~BaseClass ()
	Destruction. More...

Additional Inherited Members
Public Types inherited from Gui::ViewProvider
enum	EditMode { Default = 0 , Transform , Cutting , Color }

Public Types inherited from App::ExtensionContainer
typedef std::map< Base::Type, App::Extension * >::iterator	ExtensionIterator

Static Public Member Functions inherited from Gui::ViewProvider
static const std::string &	hiddenMarker ()

static const char *	hasHiddenMarker (const char *subname)

static SbMatrix	convert (const Base::Matrix4D &rcMatrix)

static Base::Matrix4D	convert (const SbMatrix &sbMat)

static void	eventCallback (void ud, SoEventCallback node)

Static Public Member Functions inherited from Base::Persistence
static void *	create (void)

static std::string	encodeAttribute (const std::string &)
	Encodes an attribute upon saving. More...

static Base::Type	getClassTypeId (void)

static void	init (void)

Static Public Member Functions inherited from Base::BaseClass
static void *	create ()

static Type	getClassTypeId ()

static void	init ()

Public Attributes inherited from Gui::ViewProvider
boost::signals2::signal< void()>	signalChangeIcon
	signal on icon change More...

boost::signals2::signal< void(const QString &)>	signalChangeToolTip
	signal on tooltip change More...

boost::signals2::signal< void(const QString &)>	signalChangeStatusTip
	signal on status tip change More...

Protected Member Functions inherited from Gui::ViewProvider
virtual bool	setEdit (int ModNum)
	is called by the document when the provider goes in edit mode More...

virtual void	unsetEdit (int ModNum)
	is called when you lose the edit mode More...

int	getEditingMode () const
	return the edit mode or -1 if nothing is being edited More...

virtual QIcon	mergeGreyableOverlayIcons (const QIcon &orig) const

virtual void	setModeSwitch ()
	Turn on mode switch. More...

bool	checkRecursion (SoNode *)
	Helper method to check that the node is valid, i.e. More...

SoPickedPoint *	getPointOnRay (const SbVec2s &pos, const View3DInventorViewer *viewer) const
	Helper method to get picked entities while editing. More...

SoPickedPoint *	getPointOnRay (const SbVec3f &pos, const SbVec3f &dir, const View3DInventorViewer *viewer) const
	Helper method to get picked entities while editing. More...

void	onBeforeChange (const App::Property *prop)
	Reimplemented from subclass. More...

void	onChanged (const App::Property *prop)
	Reimplemented from subclass. More...

Protected Member Functions inherited from App::TransactionalObject
void	onBeforeChangeProperty (Document doc, const Property prop)

Protected Member Functions inherited from App::PropertyContainer
virtual const PropertyData &	getPropertyData (void) const

virtual void	handleChangedPropertyName (Base::XMLReader &reader, const char TypeName, const char PropName)
	PropertyContainer::handleChangedPropertyName is called during restore to possibly fix reading of older versions of this property container. More...

virtual void	handleChangedPropertyType (Base::XMLReader &reader, const char TypeName, Property prop)
	PropertyContainer::handleChangedPropertyType is called during restore to possibly fix reading of older versions of the property container. More...

virtual void	onBeforeChange (const Property *)
	get called before the value is changed More...

virtual void	onChanged (const Property *)
	get called by the container when a property has changed More...

Static Protected Member Functions inherited from App::PropertyContainer
static const PropertyData *	getPropertyDataPtr (void)

Static Protected Member Functions inherited from Base::BaseClass
static void	initSubclass (Base::Type &toInit, const char ClassName, const char ParentName, Type::instantiationMethod method=nullptr)

Protected Attributes inherited from Gui::ViewProvider
SoSeparator *	pcRoot
	The root Separator of the ViewProvider. More...

SoTransform *	pcTransform
	this is transformation for the provider More...

const char *	sPixmap

SoSwitch *	pcModeSwitch
	this is the mode switch, all the different viewing modes are collected here More...

SoSeparator *	pcAnnotation
	The root separator for annotations. More...

ViewProviderPy *	pyViewObject

std::string	overrideMode

std::bitset< 32 >	StatusBits

Protected Attributes inherited from App::PropertyContainer
DynamicProperty	dynamicProps

Constructor & Destructor Documentation

◆ ViewProviderCrossSections()

MeshPartGui::ViewProviderCrossSections::ViewProviderCrossSections ( )

References Gui::ViewProvider::pcRoot.

◆ ~ViewProviderCrossSections()

MeshPartGui::ViewProviderCrossSections::~ViewProviderCrossSections ( )

Member Function Documentation

◆ getDefaultDisplayMode()

const char * MeshPartGui::ViewProviderCrossSections::getDefaultDisplayMode ( ) const

virtual

get the default display mode

Reimplemented from Gui::ViewProvider.

◆ getDisplayModes()

std::vector< std::string > MeshPartGui::ViewProviderCrossSections::getDisplayModes ( void ) const

virtual

returns a list of all possible display modes

Reimplemented from Gui::ViewProvider.

◆ setCoords()

void MeshPartGui::ViewProviderCrossSections::setCoords ( const std::vector< Base::Vector3f > & v )

References Base::Vector3< _Precision >::x, Base::Vector3< _Precision >::y, and Base::Vector3< _Precision >::z.

◆ updateData()

void MeshPartGui::ViewProviderCrossSections::updateData ( const App::Property * )

virtual

Reimplemented from Gui::ViewProvider.

Referenced by ArchStructure.CommandStructuralSystem::Activated(), PathScripts.PathJobDlg.JobCreate::exec_(), draftviewproviders.view_dimension.ViewProviderLinearDimension::onChanged(), draftviewproviders.view_dimension.ViewProviderAngularDimension::onChanged(), draftviewproviders.view_wire.ViewProviderWire::onChanged(), PathScripts.PathOpGui.TaskPanelPage::pageUpdateData(), PathScripts.PathPropertyBagGui.TaskPanel::setupUi(), and PathScripts.PathSetupSheetGui.OpTaskPanel::setupUi().

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

FreeCAD/src/Mod/MeshPart/Gui/CrossSections.cpp

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ ViewProviderCrossSections()

◆ ~ViewProviderCrossSections()

Member Function Documentation

◆ getDefaultDisplayMode()

◆ getDisplayModes()

◆ setCoords()

◆ updateData()