Files
create/src/Mod/Part/Gui/ViewProvider2DObject.cpp
2025-01-19 15:27:15 -05:00

467 lines
17 KiB
C++

/***************************************************************************
* Copyright (c) 2004 Jürgen Riegel <juergen.riegel@web.de> *
* *
* This file is part of the FreeCAD CAx development system. *
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Library General Public *
* License as published by the Free Software Foundation; either *
* version 2 of the License, or (at your option) any later version. *
* *
* This library is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU Library General Public License for more details. *
* *
* You should have received a copy of the GNU Library General Public *
* License along with this library; see the file COPYING.LIB. If not, *
* write to the Free Software Foundation, Inc., 59 Temple Place, *
* Suite 330, Boston, MA 02111-1307, USA *
* *
***************************************************************************/
#include "PreCompiled.h"
#ifndef _PreComp_
# include <cfloat>
# include <Inventor/nodes/SoAnnotation.h>
# include <Inventor/nodes/SoBaseColor.h>
# include <Inventor/nodes/SoDepthBuffer.h>
# include <Inventor/nodes/SoDrawStyle.h>
# include <Inventor/nodes/SoLineSet.h>
# include <Inventor/nodes/SoMaterial.h>
# include <Inventor/nodes/SoPickStyle.h>
# include <Inventor/nodes/SoSeparator.h>
# include <Inventor/nodes/SoVertexProperty.h>
#endif
#include <App/Application.h>
#include <Base/Console.h>
#include <Base/Parameter.h>
#include <Base/Reader.h>
#include <Gui/Inventor/SoFCBoundingBox.h>
#include "ViewProvider2DObject.h"
#include <Inventor/nodes/SoFaceSet.h>
#include <Inventor/nodes/SoShapeHints.h>
#include <Inventor/nodes/SoSwitch.h>
using namespace PartGui;
using namespace std;
//**************************************************************************
// Construction/Destruction
const char* ViewProvider2DObjectGrid::GridStyleEnums[]= {"Dashed","Light",nullptr};
App::PropertyQuantityConstraint::Constraints ViewProvider2DObjectGrid::GridSizeRange = {0.001,DBL_MAX,1.0};
PROPERTY_SOURCE(PartGui::ViewProvider2DObjectGrid, PartGui::ViewProvider2DObject)
ViewProvider2DObjectGrid::ViewProvider2DObjectGrid()
{
ADD_PROPERTY_TYPE(ShowGrid,(false),"Grid",(App::PropertyType)(App::Prop_None),"Switch the grid on/off");
ADD_PROPERTY_TYPE(ShowOnlyInEditMode,(true),"Grid",(App::PropertyType)(App::Prop_None),"Show only while in edit mode");
ADD_PROPERTY_TYPE(GridSize,(10.0),"Grid",(App::PropertyType)(App::Prop_None),"Gap size of the grid");
ADD_PROPERTY_TYPE(GridStyle,(0L),"Grid",(App::PropertyType)(App::Prop_None),"Appearance style of the grid");
ADD_PROPERTY_TYPE(TightGrid,(true),"Grid",(App::PropertyType)(App::Prop_None),"Switch the tight grid mode on/off");
ADD_PROPERTY_TYPE(GridSnap,(false),"Grid",(App::PropertyType)(App::Prop_None),"Switch the grid snap on/off");
ADD_PROPERTY_TYPE(GridAutoSize,(true),"Grid",(App::PropertyType)(App::Prop_Hidden),"Autosize grid based on shape boundbox");
ADD_PROPERTY_TYPE(maxNumberOfLines,(10000),"Grid",(App::PropertyType)(App::Prop_None),"Maximum Number of Lines in grid");
GridRoot = new SoAnnotation();
GridRoot->ref();
GridRoot->setName("GridRoot");
MinX = MinY = -100;
MaxX = MaxY = 100;
GridStyle.setEnums(GridStyleEnums);
GridSize.setConstraints(&GridSizeRange);
pcRoot->addChild(GridRoot);
sPixmap = "Part_2D_object";
}
ViewProvider2DObjectGrid::~ViewProvider2DObjectGrid()
{
GridRoot->unref();
}
// **********************************************************************************
SoSeparator* ViewProvider2DObjectGrid::createGrid()
{
float Step = GridSize.getValue(); //pow(10,floor(log10(Size/5.0)));
float MiX, MaX, MiY, MaY;
if (TightGrid.getValue()) {
MiX = MinX - (MaxX-MinX)*0.2f;
MaX = MaxX + (MaxX-MinX)*0.2f;
MiY = MinY - (MaxY-MinY)*0.2f;
MaY = MaxY + (MaxY-MinY)*0.2f;
}
else {
// make sure that nine of the numbers are exactly zero because log(0)
// is not defined
float xMin = std::abs(MinX) < FLT_EPSILON ? 0.01f : MinX;
float xMax = std::abs(MaxX) < FLT_EPSILON ? 0.01f : MaxX;
float yMin = std::abs(MinY) < FLT_EPSILON ? 0.01f : MinY;
float yMax = std::abs(MaxY) < FLT_EPSILON ? 0.01f : MaxY;
MiX = -exp(ceil(log(std::abs(xMin))));
MiX = std::min<float>(MiX,(float)-exp(ceil(log(std::abs(0.1f*xMax)))));
MaX = exp(ceil(log(std::abs(xMax))));
MaX = std::max<float>(MaX,(float)exp(ceil(log(std::abs(0.1f*xMin)))));
MiY = -exp(ceil(log(std::abs(yMin))));
MiY = std::min<float>(MiY,(float)-exp(ceil(log(std::abs(0.1f*yMax)))));
MaY = exp(ceil(log(std::abs(yMax))));
MaY = std::max<float>(MaY,(float)exp(ceil(log(std::abs(0.1f*yMin)))));
}
//Round the values otherwise grid is not aligned with center
MiX = (floor(MiX / Step)-0.5) * Step;
MaX = (ceil(MaX / Step)+0.5) * Step;
MiY = (floor(MiY / Step)-0.5) * Step;
MaY = (ceil(MaY / Step)+0.5) * Step;
double zGrid = 0.0; // carpet-grid separation
SoGroup *parent = new Gui::SoSkipBoundingGroup();
Gui::coinRemoveAllChildren(GridRoot);
GridRoot->addChild(parent);
SoBaseColor *mycolor;
SoVertexProperty *vts;
// gridlines
mycolor = new SoBaseColor;
mycolor->rgb.setValue(0.7f, 0.7f ,0.7f);
parent->addChild(mycolor);
if (GridStyle.getValue() == 0) {
ParameterGrp::handle hGrp = App::GetApplication().GetParameterGroupByPath("User parameter:BaseApp/Preferences/Mod/Part");
int pattern = hGrp->GetInt("GridLinePattern", 0x0f0f);
SoDrawStyle* DefaultStyle = new SoDrawStyle;
DefaultStyle->lineWidth = 1;
DefaultStyle->linePattern = pattern;
parent->addChild(DefaultStyle);
}
else {
SoMaterial* LightStyle = new SoMaterial;
LightStyle->transparency = 0.7f;
parent->addChild(LightStyle);
}
SoPickStyle* PickStyle = new SoPickStyle;
PickStyle->style = SoPickStyle::UNPICKABLE;
parent->addChild(PickStyle);
SoLineSet *grid = new SoLineSet;
vts = new SoVertexProperty;
grid->vertexProperty = vts;
// vertical lines
int vlines = static_cast<int>((MaX - MiX) / Step + 0.5f);
// horizontal lines
int hlines = static_cast<int>((MaY - MiY) / Step + 0.5f);
int lines = vlines + hlines;
if (lines > maxNumberOfLines.getValue()) {
Base::Console().Warning("Grid Disabled: Requested number of lines %d is larger than the maximum configured of %d\n."
"Either increase the 'GridSize' property to a more reasonable value (recommended) or increase the 'maxNumberOfLines' property.\n", lines, maxNumberOfLines.getValue());
parent->addChild(vts);
parent->addChild(grid);
return GridRoot;
}
// set the grid indices
grid->numVertices.setNum(lines);
int32_t* vertices = grid->numVertices.startEditing();
for (int i=0; i<lines; i++)
vertices[i] = 2;
grid->numVertices.finishEditing();
// set the grid coordinates
vts->vertex.setNum(2*lines);
SbVec3f* vertex_coords = vts->vertex.startEditing();
// vertical lines
int i_offset_x = static_cast<int>(MiX / Step);
for (int i=0; i<vlines; i++) {
vertex_coords[2*i].setValue((i+i_offset_x)*Step, MiY, zGrid);
vertex_coords[2*i+1].setValue((i+i_offset_x)*Step, MaY, zGrid);
}
// horizontal lines
int i_offset_y = static_cast<int>(MiY / Step);
for (int i=vlines; i<lines; i++) {
vertex_coords[2*i].setValue(MiX, (i-vlines+i_offset_y)*Step, zGrid);
vertex_coords[2*i+1].setValue(MaX, (i-vlines+i_offset_y)*Step, zGrid);
}
vts->vertex.finishEditing();
parent->addChild(vts);
parent->addChild(grid);
return GridRoot;
}
void ViewProvider2DObjectGrid::updateData(const App::Property* prop)
{
ViewProvider2DObject::updateData(prop);
if (prop->is<Part::PropertyPartShape>()) {
if (GridAutoSize.getValue()) {
Base::BoundBox3d bbox = static_cast<const Part::PropertyPartShape*>(prop)->getBoundingBox();
if (!bbox.IsValid())
return;
Gui::coinRemoveAllChildren(GridRoot);
Base::Placement place = static_cast<const Part::PropertyPartShape*>(prop)->getComplexData()->getPlacement();
place.invert();
Base::ViewOrthoProjMatrix proj(place.toMatrix());
Base::BoundBox2d bbox2d = bbox.ProjectBox(&proj);
this->MinX = bbox2d.MinX;
this->MaxX = bbox2d.MaxX;
this->MinY = bbox2d.MinY;
this->MaxY = bbox2d.MaxY;
}
if (ShowGrid.getValue() && !(ShowOnlyInEditMode.getValue() && !this->isEditing()) ) {
createGrid();
}
else {
Gui::coinRemoveAllChildren(GridRoot);
}
}
}
void ViewProvider2DObjectGrid::onChanged(const App::Property* prop)
{
// call father
ViewProviderPart::onChanged(prop);
if (prop == &ShowGrid || prop == &ShowOnlyInEditMode || prop == &Visibility) {
if (ShowGrid.getValue() && ((Visibility.getValue() && !ShowOnlyInEditMode.getValue()) || this->isEditing()))
createGrid();
else
Gui::coinRemoveAllChildren(GridRoot);
}
if ((prop == &GridSize) || (prop == &GridStyle) || (prop == &TightGrid)) {
if (ShowGrid.getValue() && !(ShowOnlyInEditMode.getValue() && !this->isEditing())) {
createGrid();
}
}
}
void ViewProvider2DObjectGrid::Restore(Base::XMLReader &reader)
{
ViewProviderPart::Restore(reader);
}
void ViewProvider2DObjectGrid::handleChangedPropertyType(Base::XMLReader &reader,
const char * TypeName,
App::Property * prop)
{
Base::Type inputType = Base::Type::fromName(TypeName);
if (prop->isDerivedFrom<App::PropertyFloat>() &&
inputType.isDerivedFrom(App::PropertyFloat::getClassTypeId())) {
// Do not directly call the property's Restore method in case the implementation
// has changed. So, create a temporary PropertyFloat object and assign the value.
App::PropertyFloat floatProp;
floatProp.Restore(reader);
static_cast<App::PropertyFloat*>(prop)->setValue(floatProp.getValue());
}
else {
ViewProviderPart::handleChangedPropertyType(reader, TypeName, prop);
}
}
void ViewProvider2DObjectGrid::attach(App::DocumentObject *pcFeat)
{
ViewProvider2DObject::attach(pcFeat);
if (ShowGrid.getValue() && !(ShowOnlyInEditMode.getValue() && !this->isEditing()))
createGrid();
}
bool ViewProvider2DObjectGrid::setEdit(int)
{
if (ShowGrid.getValue())
createGrid();
return false;
}
void ViewProvider2DObjectGrid::unsetEdit(int)
{
if (ShowGrid.getValue() && ShowOnlyInEditMode.getValue())
Gui::coinRemoveAllChildren(GridRoot);
}
void ViewProvider2DObjectGrid::updateGridExtent(float minx, float maxx, float miny, float maxy)
{
bool redraw = false;
if (minx < MinX || maxx > MaxX || miny < MinY || maxy > MaxY)
redraw = true;
MinX = minx;
MaxX = maxx;
MinY = miny;
MaxY = maxy;
if (redraw && ShowGrid.getValue() && !(ShowOnlyInEditMode.getValue() && !this->isEditing()))
createGrid();
}
// -----------------------------------------------------------------------
PROPERTY_SOURCE(PartGui::ViewProvider2DObject, PartGui::ViewProviderPart)
ViewProvider2DObject::ViewProvider2DObject()
: plane(new SoSwitch)
{
ADD_PROPERTY_TYPE(ShowPlane,
(false),
"Display Options",
(App::PropertyType)(App::Prop_None),
"If true, plane related with object is additionally rendered.");
}
ViewProvider2DObject::~ViewProvider2DObject() = default;
void ViewProvider2DObject::attach(App::DocumentObject* documentObject)
{
ViewProviderPart::attach(documentObject);
getAnnotation()->addChild(plane);
updatePlane();
}
void ViewProvider2DObject::updateData(const App::Property* property)
{
ViewProviderPart::updateData(property);
if (dynamic_cast<const Part::PropertyPartShape*>(property)) {
updatePlane();
}
}
void ViewProvider2DObject::onChanged(const App::Property* property)
{
ViewProviderPart::onChanged(property);
if (property == &ShowPlane) {
plane->whichChild = ShowPlane.getValue() ? SO_SWITCH_ALL : SO_SWITCH_NONE;
}
}
std::vector<std::string> ViewProvider2DObject::getDisplayModes() const
{
// get the modes of the father
std::vector<std::string> StrList = ViewProviderGeometryObject::getDisplayModes();
// add your own modes
StrList.emplace_back("Flat Lines");
//StrList.push_back("Shaded");
StrList.emplace_back("Wireframe");
StrList.emplace_back("Points");
return StrList;
}
const char* ViewProvider2DObject::getDefaultDisplayMode() const
{
return "Wireframe";
}
void ViewProvider2DObject::updatePlane()
{
plane->whichChild = ShowPlane.getValue() ? SO_SWITCH_ALL : SO_SWITCH_NONE;
Gui::coinRemoveAllChildren(plane);
auto shapeProperty = getObject()->getPropertyByName<Part::PropertyPartShape>("Shape");
if (!shapeProperty) {
return;
}
auto bbox = shapeProperty->getBoundingBox();
Base::Placement place = shapeProperty->getComplexData()->getPlacement();
Base::ViewOrthoProjMatrix proj(place.inverse().toMatrix());
Base::BoundBox2d bb = bbox.ProjectBox(&proj);
SbVec3f verts[4] = {
SbVec3f(bb.MinX - horizontalPlanePadding, bb.MinY - verticalPlanePadding, 0),
SbVec3f(bb.MinX - horizontalPlanePadding, bb.MaxY + verticalPlanePadding, 0),
SbVec3f(bb.MaxX + horizontalPlanePadding, bb.MaxY + verticalPlanePadding, 0),
SbVec3f(bb.MaxX + horizontalPlanePadding, bb.MinY - verticalPlanePadding, 0),
};
static const int32_t lines[6] = { 0, 1, 2, 3, 0, -1 };
auto pCoords = new SoCoordinate3();
pCoords->point.setNum(4);
pCoords->point.setValues(0, 4, verts);
plane->addChild(pCoords);
auto pLines = new SoIndexedLineSet();
pLines->coordIndex.setNum(6);
pLines->coordIndex.setValues(0, 6, lines);
plane->addChild(pLines);
// add semi transparent face
auto faceSeparator = new SoSeparator();
plane->addChild(faceSeparator);
auto material = new SoMaterial();
SbColor color(1.0f, 1.0f, 0.0f);
material->transparency.setValue(0.85f);
material->ambientColor.setValue(color);
material->diffuseColor.setValue(color);
faceSeparator->addChild(material);
// disable backface culling and render with two-sided lighting
auto shapeHints = new SoShapeHints();
shapeHints->vertexOrdering = SoShapeHints::COUNTERCLOCKWISE;
shapeHints->shapeType = SoShapeHints::UNKNOWN_SHAPE_TYPE;
faceSeparator->addChild(shapeHints);
auto pickStyle = new SoPickStyle();
pickStyle->style = SoPickStyle::UNPICKABLE;
faceSeparator->addChild(pickStyle);
auto faceSet = new SoFaceSet();
auto vertexProperty = new SoVertexProperty();
vertexProperty->vertex.setValues(0, 4, verts);
faceSet->vertexProperty.setValue(vertexProperty);
faceSeparator->addChild(faceSet);
auto ps = new SoPickStyle();
ps->style.setValue(SoPickStyle::BOUNDING_BOX);
auto dashed = new SoDrawStyle();
dashed->linePattern = 0xF0F0;
auto annotation = new SoAnnotation();
annotation->addChild(dashed);
annotation->addChild(pLines);
plane->addChild(annotation);
plane->addChild(ps);
}
namespace Gui {
/// @cond DOXERR
PROPERTY_SOURCE_TEMPLATE(PartGui::ViewProvider2DObjectPython, PartGui::ViewProvider2DObject)
/// @endcond
// explicit template instantiation
template class PartGuiExport ViewProviderFeaturePythonT<PartGui::ViewProvider2DObject>;
}