mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-08-04 13:13:25 +03:00
a5a7b3185b
Update empty method guards to new style with regex (see PR). Used clang-format 18.1.8. New actions to validate code formatting is added. Update .clang-format with disabling of include sorting. It is temporary changes, then include will be sorted. Apply formatting for /src and /tools folder. The files with .hxx,.cxx,.lxx,.h,.pxx,.hpp,*.cpp extensions.
261 lines
11 KiB
C++
261 lines
11 KiB
C++
// Created on: 1995-10-09
|
|
// Created by: Arnaud BOUZY/Odile Olivier
|
|
// Copyright (c) 1995-1999 Matra Datavision
|
|
// Copyright (c) 1999-2014 OPEN CASCADE SAS
|
|
//
|
|
// This file is part of Open CASCADE Technology software library.
|
|
//
|
|
// This library is free software; you can redistribute it and/or modify it under
|
|
// the terms of the GNU Lesser General Public License version 2.1 as published
|
|
// by the Free Software Foundation, with special exception defined in the file
|
|
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
|
|
// distribution for complete text of the license and disclaimer of any warranty.
|
|
//
|
|
// Alternatively, this file may be used under the terms of Open CASCADE
|
|
// commercial license or contractual agreement.
|
|
|
|
#ifndef _AIS_Trihedron_HeaderFile
|
|
#define _AIS_Trihedron_HeaderFile
|
|
|
|
#include <AIS_InteractiveObject.hxx>
|
|
#include <AIS_KindOfInteractive.hxx>
|
|
#include <Graphic3d_ArrayOfTriangles.hxx>
|
|
#include <PrsMgr_PresentationManager.hxx>
|
|
#include <Prs3d_DatumAspect.hxx>
|
|
#include <Prs3d_DatumMode.hxx>
|
|
#include <Prs3d_DatumParts.hxx>
|
|
#include <Prs3d_LineAspect.hxx>
|
|
#include <SelectMgr_Selection.hxx>
|
|
#include <Quantity_Color.hxx>
|
|
|
|
class Geom_Axis2Placement;
|
|
|
|
//! Create a selectable trihedron
|
|
//! The trihedron includes 1 origin, 3 axes and 3 labels.
|
|
//! Default text of labels are "X", "Y", "Z".
|
|
//! Color of origin and any axis, color of arrows and labels may be changed.
|
|
//! Visual presentation might be shown in two, shaded and wireframe modes, wireframe by default).
|
|
//! There are 4 modes of selection:
|
|
//! - AIS_TrihedronSelectionMode_EntireObject to select trihedron, priority = 1
|
|
//! - AIS_TrihedronSelectionMode_Origin to select its origin, priority = 5
|
|
//! - AIS_TrihedronSelectionMode_Axes to select its axis, priority = 3
|
|
//! - AIS_TrihedronSelectionMode_MainPlanes to select its planes, priority = 2
|
|
//!
|
|
//! Warning!
|
|
//! For the presentation of trihedron, the default unit of length is the millimetre,
|
|
//! and the default value for the representation of the axes is 100.
|
|
//! If you modify these dimensions, you must temporarily recover the Drawer.
|
|
//! From inside it, you take the aspect in which the values for length are stocked.
|
|
//! For trihedron, this is Prs3d_Drawer_LineAspect.
|
|
//! You change the values inside this Aspect and recalculate the presentation.
|
|
class AIS_Trihedron : public AIS_InteractiveObject
|
|
{
|
|
DEFINE_STANDARD_RTTIEXT(AIS_Trihedron, AIS_InteractiveObject)
|
|
public:
|
|
//! Initializes a trihedron entity.
|
|
Standard_EXPORT AIS_Trihedron(const Handle(Geom_Axis2Placement)& theComponent);
|
|
|
|
//! Returns datum display mode.
|
|
Prs3d_DatumMode DatumDisplayMode() const { return myTrihDispMode; }
|
|
|
|
//! Sets Shading or Wireframe display mode, triangle or segment graphic group is used relatively.
|
|
void SetDatumDisplayMode(Prs3d_DatumMode theMode) { myTrihDispMode = theMode; }
|
|
|
|
//! Returns the right-handed coordinate system set in SetComponent.
|
|
const Handle(Geom_Axis2Placement)& Component() const { return myComponent; }
|
|
|
|
//! Constructs the right-handed coordinate system aComponent.
|
|
Standard_EXPORT void SetComponent(const Handle(Geom_Axis2Placement)& theComponent);
|
|
|
|
//! Returns true if the trihedron object has a size other
|
|
//! than the default size of 100 mm. along each axis.
|
|
Standard_Boolean HasOwnSize() const { return myHasOwnSize; }
|
|
|
|
//! Returns the size of trihedron object; 100.0 by DEFAULT.
|
|
Standard_EXPORT Standard_Real Size() const;
|
|
|
|
//! Sets the size of trihedron object.
|
|
Standard_EXPORT void SetSize(const Standard_Real theValue);
|
|
|
|
//! Removes any non-default settings for size of this trihedron object.
|
|
//! If the object has 1 color, the default size of the
|
|
//! drawer is reproduced, otherwise DatumAspect becomes null.
|
|
Standard_EXPORT void UnsetSize();
|
|
|
|
//! Returns true if trihedron has own text color
|
|
Standard_Boolean HasTextColor() const { return myHasOwnTextColor; }
|
|
|
|
//! Returns trihedron text color
|
|
Standard_EXPORT Quantity_Color TextColor() const;
|
|
|
|
//! Sets color of label of trihedron axes.
|
|
Standard_EXPORT void SetTextColor(const Quantity_Color& theColor);
|
|
|
|
//! Sets color of label of trihedron axis.
|
|
Standard_EXPORT void SetTextColor(const Prs3d_DatumParts thePart, const Quantity_Color& theColor);
|
|
|
|
//! Returns true if trihedron has own arrow color
|
|
Standard_Boolean HasArrowColor() const { return myHasOwnArrowColor; }
|
|
|
|
//! Returns trihedron arrow color
|
|
Standard_EXPORT Quantity_Color ArrowColor() const;
|
|
|
|
//! Sets color of arrow of trihedron axes.
|
|
Standard_EXPORT void SetArrowColor(const Quantity_Color& theColor);
|
|
|
|
//! Sets color of arrow of trihedron axes.
|
|
Standard_EXPORT void SetArrowColor(const Prs3d_DatumParts thePart,
|
|
const Quantity_Color& theColor);
|
|
|
|
//! Returns color of datum part: origin or some of trihedron axes.
|
|
Standard_EXPORT Quantity_Color DatumPartColor(Prs3d_DatumParts thePart);
|
|
|
|
//! Sets color of datum part: origin or some of trihedron axes.
|
|
//! If presentation is shading mode, this color is set for both sides of facing model
|
|
Standard_EXPORT void SetDatumPartColor(const Prs3d_DatumParts thePart,
|
|
const Quantity_Color& theColor);
|
|
//! Sets color of origin.
|
|
//! Standard_DEPRECATED("This method is deprecated - SetColor() should be called instead")
|
|
Standard_EXPORT void SetOriginColor(const Quantity_Color& theColor);
|
|
|
|
//! Sets color of x-axis.
|
|
//! Standard_DEPRECATED("This method is deprecated - SetColor() should be called instead")
|
|
Standard_EXPORT void SetXAxisColor(const Quantity_Color& theColor);
|
|
|
|
//! Sets color of y-axis.
|
|
//! Standard_DEPRECATED("This method is deprecated - SetColor() should be called instead")
|
|
Standard_EXPORT void SetYAxisColor(const Quantity_Color& theColor);
|
|
|
|
//! Sets color of z-axis.
|
|
//! Standard_DEPRECATED("This method is deprecated - SetColor() should be called instead")
|
|
Standard_EXPORT void SetAxisColor(const Quantity_Color& theColor);
|
|
|
|
//! Returns true if arrows are to be drawn
|
|
Standard_EXPORT Standard_Boolean ToDrawArrows() const;
|
|
|
|
//! Sets whether to draw the arrows in visualization
|
|
Standard_EXPORT void SetDrawArrows(const Standard_Boolean theToDraw);
|
|
|
|
//! Returns priority of selection for owner of the given type
|
|
Standard_Integer SelectionPriority(Prs3d_DatumParts thePart)
|
|
{
|
|
return mySelectionPriority[thePart];
|
|
}
|
|
|
|
//! Sets priority of selection for owner of the given type
|
|
void SetSelectionPriority(Prs3d_DatumParts thePart, Standard_Integer thePriority)
|
|
{
|
|
mySelectionPriority[thePart] = thePriority;
|
|
}
|
|
|
|
//! Returns text of axis. Parameter thePart should be XAxis, YAxis or ZAxis
|
|
const TCollection_ExtendedString& Label(Prs3d_DatumParts thePart) { return myLabels[thePart]; }
|
|
|
|
//! Sets text label for trihedron axis. Parameter thePart should be XAxis, YAxis or ZAxis
|
|
void SetLabel(const Prs3d_DatumParts thePart, const TCollection_ExtendedString& theName)
|
|
{
|
|
myLabels[thePart] = theName;
|
|
}
|
|
|
|
public:
|
|
//! Sets the color theColor for this trihedron object, it changes color of axes.
|
|
Standard_EXPORT virtual void SetColor(const Quantity_Color& theColor) Standard_OVERRIDE;
|
|
|
|
//! Returns true if the display mode selected, aMode, is valid for trihedron datums.
|
|
virtual Standard_Boolean AcceptDisplayMode(const Standard_Integer theMode) const Standard_OVERRIDE
|
|
{
|
|
return theMode == 0;
|
|
}
|
|
|
|
//! Returns index 3, selection of the planes XOY, YOZ, XOZ.
|
|
virtual Standard_Integer Signature() const Standard_OVERRIDE { return 3; }
|
|
|
|
//! Indicates that the type of Interactive Object is datum.
|
|
virtual AIS_KindOfInteractive Type() const Standard_OVERRIDE
|
|
{
|
|
return AIS_KindOfInteractive_Datum;
|
|
}
|
|
|
|
//! Removes the settings for color.
|
|
Standard_EXPORT virtual void UnsetColor() Standard_OVERRIDE;
|
|
|
|
public:
|
|
//! Method which clear all selected owners belonging
|
|
//! to this selectable object ( for fast presentation draw ).
|
|
Standard_EXPORT virtual void ClearSelected() Standard_OVERRIDE;
|
|
|
|
//! Method which draws selected owners ( for fast presentation draw ).
|
|
Standard_EXPORT virtual void HilightSelected(const Handle(PrsMgr_PresentationManager)& thePM,
|
|
const SelectMgr_SequenceOfOwner& theOwners)
|
|
Standard_OVERRIDE;
|
|
|
|
//! Method which hilight an owner belonging to
|
|
//! this selectable object ( for fast presentation draw ).
|
|
Standard_EXPORT virtual void HilightOwnerWithColor(
|
|
const Handle(PrsMgr_PresentationManager)& thePM,
|
|
const Handle(Prs3d_Drawer)& theStyle,
|
|
const Handle(SelectMgr_EntityOwner)& theOwner) Standard_OVERRIDE;
|
|
|
|
protected:
|
|
//! Compute trihedron presentation.
|
|
Standard_EXPORT void Compute(const Handle(PrsMgr_PresentationManager)& thePrsMgr,
|
|
const Handle(Prs3d_Presentation)& thePrs,
|
|
const Standard_Integer theMode) Standard_OVERRIDE;
|
|
|
|
//! Compute selection.
|
|
Standard_EXPORT virtual void ComputeSelection(const Handle(SelectMgr_Selection)& theSelection,
|
|
const Standard_Integer theMode) Standard_OVERRIDE;
|
|
|
|
//! Dumps the content of me into the stream
|
|
Standard_EXPORT virtual void DumpJson(Standard_OStream& theOStream,
|
|
Standard_Integer theDepth = -1) const Standard_OVERRIDE;
|
|
|
|
protected:
|
|
//! Creates a sensitive entity for the datum part that will be used in selection owner creation.
|
|
Standard_EXPORT Handle(Select3D_SensitiveEntity) createSensitiveEntity(
|
|
const Prs3d_DatumParts thePart,
|
|
const Handle(SelectMgr_EntityOwner)& theOwner) const;
|
|
|
|
//! Computes presentation for display mode equal 1.
|
|
Standard_EXPORT void computePresentation(const Handle(PrsMgr_PresentationManager)& thePrsMgr,
|
|
const Handle(Prs3d_Presentation)& thePrs);
|
|
|
|
//! Returns own datum aspect of trihedron, create this aspect if it was not created yet.
|
|
Standard_EXPORT void setOwnDatumAspect();
|
|
|
|
//! Returns primitives.
|
|
const Handle(Graphic3d_ArrayOfPrimitives)& arrayOfPrimitives(Prs3d_DatumParts thePart) const
|
|
{
|
|
return myPrimitives[thePart];
|
|
}
|
|
|
|
//! Updates graphic groups for the current datum mode
|
|
//! Parameters of datum position and orientation
|
|
Standard_EXPORT void updatePrimitives(const Handle(Prs3d_DatumAspect)& theAspect,
|
|
Prs3d_DatumMode theMode,
|
|
const gp_Pnt& theOrigin,
|
|
const gp_Dir& theXDir,
|
|
const gp_Dir& theYDir,
|
|
const gp_Dir& theZDir);
|
|
|
|
protected:
|
|
Handle(Geom_Axis2Placement) myComponent;
|
|
Prs3d_DatumMode myTrihDispMode;
|
|
Standard_Boolean myHasOwnSize;
|
|
Standard_Boolean myHasOwnTextColor;
|
|
Standard_Boolean myHasOwnArrowColor;
|
|
|
|
TCollection_ExtendedString myLabels[Prs3d_DatumParts_NB];
|
|
Standard_Integer mySelectionPriority[Prs3d_DatumParts_NB];
|
|
|
|
Handle(Graphic3d_Group) myPartToGroup[Prs3d_DatumParts_NB];
|
|
NCollection_List<Prs3d_DatumParts> mySelectedParts;
|
|
Handle(Graphic3d_AspectLine3d) myHiddenLineAspect;
|
|
|
|
Handle(Graphic3d_ArrayOfPrimitives) myPrimitives[Prs3d_DatumParts_NB];
|
|
};
|
|
|
|
DEFINE_STANDARD_HANDLE(AIS_Trihedron, AIS_InteractiveObject)
|
|
|
|
#endif // _AIS_Trihedron_HeaderFile
|