PartGui::SoBrepFaceSet Class Reference

First some words to the history and the reason why we have this class: In older FreeCAD versions we had an own Inventor node for each sub-element of a shape with its own highlight node. More...

#include <SoBrepFaceSet.h>

Classes
class	VBO

Public Member Functions
	SoBrepFaceSet ()

Static Public Member Functions
static void	initClass ()

Public Attributes
SoMFInt32	partIndex

Protected Member Functions
virtual SoDetail *	createTriangleDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, const SoPrimitiveVertex *v3, SoPickedPoint *pp)
virtual void	doAction (SoAction *action)
virtual void	generatePrimitives (SoAction *action)
virtual void	getBoundingBox (SoGetBoundingBoxAction *action)
virtual void	GLRender (SoGLRenderAction *action)
virtual void	GLRenderBelowPath (SoGLRenderAction *action)
virtual	~SoBrepFaceSet ()

Detailed Description

First some words to the history and the reason why we have this class: In older FreeCAD versions we had an own Inventor node for each sub-element of a shape with its own highlight node.

For more complex objects the number of nodes increased dramatically with the result that interactions with such objects was almost impossible because every little rotation or hovering caused a very time consuming redraw. The most time consuming part was not the OpenGL calls to render the elements but the traversal of these many nodes.

So, the idea was to have one node that handles all faces of a shape, one node that handles all edges and another node that handles the vertexes. And each of these nodes manages the highlighting and selection itself.

Now to SoBrepFaceSet in detail: The most complex nodes of them is SoBrepFaceSet because it adds some extra logic for the handling of faces. As you can see this class also has the attribute partIndex which is an array of integers. This basically expresses the logical grouping of the faces in the coordIndex field – the parts. This means that a part in SoBrepFaceSet corresponds to a face in a shape object. Each part value gives you the number of triangles a certain face consists of. That's also the reason why SoBrepFaceSet only renders triangles. If you want a quad to be rendered than create two triangles and set the corresponding part number to 2.

Example: Let's say you have a shape with two faces. When meshing face 1 it creates 10 triangles and face 2 creates 5 triangles. Then the partIndex attribute would be the array [10,5].

Highlighting/selection: The highlightIndex now defines which part of the shape must be highlighted. So, in the above example it can have the values 0, 1, or -1 (i.e. no highlighting). The highlightIndex is a SoSFInt32 field because only one part can be highlighted at a moment while selectionIndex is a SoMFInt32 field because several parts can be selected at a time. All the logic how to do the rendering is done inside renderHighlight()/renderSelection().

Actually you can access the highlightIndex directly or you can apply a SoHighlightElementAction on it. And don't forget: if you do some mouse picking and you got a SoFaceDetail then use getPartIndex() to get the correct part.

As an example how to use the class correctly see ViewProviderPartExt::updateVisual().

Constructor & Destructor Documentation

SoBrepFaceSet()

SoBrepFaceSet::SoBrepFaceSet

(

)

References partIndex.

~SoBrepFaceSet()

SoBrepFaceSet::~SoBrepFaceSet ( )

protectedvirtual

Member Function Documentation

createTriangleDetail()

SoDetail * SoBrepFaceSet::createTriangleDetail ( SoRayPickAction *  action, const SoPrimitiveVertex *  v1, const SoPrimitiveVertex *  v2, const SoPrimitiveVertex *  v3, SoPickedPoint *  pp  )

protectedvirtual

doAction()

void SoBrepFaceSet::doAction ( SoAction *  action )

protectedvirtual

References Gui::SoSelectionElementAction::All, Gui::SoSelectionElementAction::Append, Gui::SoFCSelectionCounter::checkAction(), Gui::SoSelectionElementAction::Color, Gui::SoFCSelectionRoot::getActionContext(), Gui::SoHighlightElementAction::getColor(), Gui::SoSelectionElementAction::getColor(), Gui::SoSelectionElementAction::getColors(), Gui::SoHighlightElementAction::getElement(), Gui::SoSelectionElementAction::getElement(), Gui::SoSelectionElementAction::getType(), Gui::SoHighlightElementAction::isHighlighted(), Gui::SoSelectionElementAction::isSecondary(), partIndex, Gui::SoSelectionElementAction::Remove, and Gui::SoFCSelectionRoot::removeActionContext().

generatePrimitives()

void SoBrepFaceSet::generatePrimitives ( SoAction *  action )

protectedvirtual

References partIndex, and draftgeoutils.general::v1().

getBoundingBox()

void SoBrepFaceSet::getBoundingBox ( SoGetBoundingBoxAction *  action )

protectedvirtual

References partIndex.

GLRender()

void SoBrepFaceSet::GLRender ( SoGLRenderAction *  action )

protectedvirtual

References Gui::SoFCSelectionCounter::checkRenderCache(), Gui::SoGLVBOActivatedElement::get(), Gui::SoFCSelectionRoot::getRenderContext(), femsolver.signal::notify(), and partIndex.

GLRenderBelowPath()

void SoBrepFaceSet::GLRenderBelowPath ( SoGLRenderAction *  action )

protectedvirtual

initClass()

void SoBrepFaceSet::initClass ( void  )

static

Member Data Documentation

partIndex

SoMFInt32 PartGui::SoBrepFaceSet::partIndex

Referenced by PartDesignGui::ViewProviderDatumPlane::attach(), doAction(), generatePrimitives(), getBoundingBox(), GLRender(), PartGui::ViewProviderPartExt::setHighlightedFaces(), SoBrepFaceSet(), PartDesignGui::ViewProviderAddSub::updateAddSubShapeIndicator(), PartGui::ViewProviderPartExt::updateData(), and PartGui::ViewProviderPartExt::updateVisual().

---

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

• FreeCAD/src/Mod/Part/Gui/SoBrepFaceSet.h
• FreeCAD/src/Mod/Part/Gui/SoBrepFaceSet.cpp