Files
create/src/Gui/ViewProviderCoordinateSystem.h
Benjamin Nauck 4c66d2e3d4 Gui: Refactor LCS fixes
* use early exit to highlight main execution path
* use `auto*` for pointer
* use getObject<T>() instead of casting result from getObject()
* remove empty updateData()
* rename origin to lcs in setTemporaryVisibility for clarity
2025-06-12 10:27:06 +02:00

121 lines
4.2 KiB
C++

/***************************************************************************
* Copyright (c) 2015 Stefan Tröger <stefantroeger@gmx.net> *
* Copyright (c) 2015 Alexander Golubev (Fat-Zer) <fatzer2@gmail.com> *
* *
* 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 *
* *
***************************************************************************/
#ifndef GUI_VIEWPROVIDER_ViewProviderOrigin_H
#define GUI_VIEWPROVIDER_ViewProviderOrigin_H
#include <functional>
#include <Base/Bitmask.h>
#include <App/PropertyGeo.h>
#include "ViewProviderGeoFeatureGroup.h"
namespace Gui {
class Document;
class ViewProviderDatum;
enum class DatumElement
{
// clang-format off
Origin = 1 << 0,
Axes = 1 << 1,
Planes = 1 << 2
// clang-format on
};
using DatumElements = Base::Flags<DatumElement>;
class GuiExport ViewProviderCoordinateSystem : public ViewProviderGeoFeatureGroup
{
PROPERTY_HEADER_WITH_OVERRIDE(Gui::ViewProviderCoordinateSystem);
public:
/// constructor.
ViewProviderCoordinateSystem();
/// destructor.
~ViewProviderCoordinateSystem() override;
/// @name Override methods
///@{
std::vector<App::DocumentObject*> claimChildren() const override;
std::vector<App::DocumentObject*> claimChildren3D() const override;
SoGroup* getChildRoot() const override {return pcGroupChildren;}
void attach(App::DocumentObject* pcObject) override;
std::vector<std::string> getDisplayModes() const override;
void setDisplayMode(const char* ModeName) override;
///@}
/** @name Temporary visibility mode
* Control the visibility of origin and associated objects when needed
*/
///@{
/// Set temporary visibility of some of origin's objects e.g. while rotating or mirroring
void setTemporaryVisibility (DatumElements elements);
/// Returns true if the origin in temporary visibility mode
bool isTemporaryVisibility ();
/// Reset the visibility
void resetTemporaryVisibility ();
///@}
void setTemporaryScale(double factor);
void resetTemporarySize();
void setPlaneLabelVisibility(bool val);
bool canDragObjects() const override {
return false;
}
/// Returns default size. Use this if it is not possible to determine appropriate size by other means
static double defaultSize();
// the factor by which the axes are longer than the planes
static constexpr float axesScaling = 1.5f;
// default color for origini: light-blue (50, 150, 250, 255 stored as 0xRRGGBBAA)
static const uint32_t defaultColor = 0x3296faff;
protected:
bool onDelete(const std::vector<std::string> &) override;
private:
using DatumObjectFunc = std::function<void(ViewProviderDatum*)>;
void applyDatumObjects(const DatumObjectFunc& func);
private:
SoGroup *pcGroupChildren;
std::map<Gui::ViewProvider*, bool> tempVisMap;
};
} // namespace Gui
ENABLE_BITMASK_OPERATORS(Gui::DatumElement)
#endif // GUI_VIEWPROVIDER_ViewProviderOrigin_H