#include <Graphic3d_Vertex.hxx>
#include <Graphic3d_ZLayerSettings.hxx>
-#include <MMgt_TShared.hxx>
-
#include <Standard.hxx>
#include <Standard_Boolean.hxx>
#include <Standard_CString.hxx>
#include <TCollection_AsciiString.hxx>
#include <TCollection_ExtendedString.hxx>
-#include <V3d_ListOfTransient.hxx>
+#include <V3d_ListOfLight.hxx>
+#include <V3d_ListOfView.hxx>
#include <V3d_TypeOfOrientation.hxx>
#include <V3d_TypeOfShadingModel.hxx>
-#include <V3d_TypeOfSurfaceDetail.hxx>
-#include <V3d_TypeOfUpdate.hxx>
#include <V3d_TypeOfView.hxx>
#include <V3d_TypeOfVisualization.hxx>
-#include <Quantity_NameOfColor.hxx>
-#include <Quantity_Length.hxx>
-#include <Quantity_Parameter.hxx>
-#include <Quantity_PlaneAngle.hxx>
-#include <Quantity_TypeOfColor.hxx>
+#include <Quantity_Color.hxx>
class Aspect_Grid;
class Graphic3d_AspectMarker3d;
class Graphic3d_Structure;
class V3d_BadValue;
class V3d_CircularGrid;
-class V3d_Light;
class V3d_RectangularGrid;
class V3d_View;
class Quantity_Color;
-class V3d_Viewer;
-DEFINE_STANDARD_HANDLE(V3d_Viewer, MMgt_TShared)
-
//! Defines services on Viewer type objects.
//! The methods of this class allow editing and
//! interrogation of the parameters linked to the viewer
//! its friend classes (View,light,plane).
-class V3d_Viewer : public MMgt_TShared
+class V3d_Viewer : public Standard_Transient
{
-
+ friend class V3d_View;
+ DEFINE_STANDARD_RTTIEXT(V3d_Viewer, Standard_Transient)
public:
-
- //! Create a Viewer with the given graphic driver and the given parameters or
- //! with their default values.
- //! Currently creating of more than 100 viewer instances
- //! is not supported and leads to an exception.
- //! This limitation might be addressed in some future OCCT releases.
- //! If the size of the view is <= 0
- //! Warning: Client must creates a graphic driver
- Standard_EXPORT V3d_Viewer(const Handle(Graphic3d_GraphicDriver)& theDriver, const Standard_ExtString theName, const Standard_CString theDomain = "", const Quantity_Length theViewSize = 1000.0, const V3d_TypeOfOrientation theViewProj = V3d_XposYnegZpos, const Quantity_NameOfColor theViewBackground = Quantity_NOC_GRAY30, const V3d_TypeOfVisualization theVisualization = V3d_ZBUFFER, const V3d_TypeOfShadingModel theShadingModel = V3d_GOURAUD, const V3d_TypeOfUpdate theUpdateMode = V3d_WAIT, const Standard_Boolean theComputedMode = Standard_True, const Standard_Boolean theDefaultComputedMode = Standard_True, const V3d_TypeOfSurfaceDetail theSurfaceDetail = V3d_TEX_NONE);
-
- //! creates a view in the viewer according to its
- //! default parameters.
+ //! Create a Viewer with the given graphic driver and with default parameters:
+ //! - View orientation: V3d_XposYnegZpos
+ //! - View background: Quantity_NOC_GRAY30
+ //! - Shading model: V3d_GOURAUD
+ Standard_EXPORT V3d_Viewer (const Handle(Graphic3d_GraphicDriver)& theDriver);
+
+ //! Returns True if One View more can be defined in this Viewer.
+ Standard_EXPORT Standard_Boolean IfMoreViews() const;
+
+ //! Creates a view in the viewer according to its default parameters.
Standard_EXPORT Handle(V3d_View) CreateView();
- //! Activates all of the views of a viewer attached
- //! to a window.
+ //! Activates all of the views of a viewer attached to a window.
Standard_EXPORT void SetViewOn();
- //! Activates a particular view in the Viewer .
- //! Must be call if the Window attached to the view
- //! has been Deiconified .
- Standard_EXPORT void SetViewOn (const Handle(V3d_View)& View);
-
+ //! Activates a particular view in the Viewer.
+ //! Must be call if the Window attached to the view has been Deiconified.
+ Standard_EXPORT void SetViewOn (const Handle(V3d_View)& theView);
+
//! Deactivates all the views of a Viewer
//! attached to a window.
Standard_EXPORT void SetViewOff();
//! Deactivates a particular view in the Viewer.
//! Must be call if the Window attached to the view
//! has been Iconified .
- Standard_EXPORT void SetViewOff (const Handle(V3d_View)& View);
+ Standard_EXPORT void SetViewOff (const Handle(V3d_View)& theView);
//! Deprecated, Redraw() should be used instead.
- Standard_EXPORT void Update();
-
- //! Updates the lights of all the views of a viewer.
- Standard_EXPORT void UpdateLights();
-
+ void Update() { Redraw(); }
+
//! Redraws all the views of the Viewer even if no
//! modification has taken place. Must be called if
//! all the views of the Viewer are exposed, as for
//! Suppresses the Viewer.
Standard_EXPORT void Remove();
-
- //! Erase all Objects in All the views.
- Standard_EXPORT void Erase() const;
-
- //! UnHighlight all Objects in All the views.
- Standard_EXPORT void UnHighlight() const;
-
- //! Defines the default base colour of views attached
- //! to the Viewer by supplying the type of colour
- //! definition and the three component values..
- Standard_EXPORT void SetDefaultBackgroundColor (const Quantity_TypeOfColor Type, const Quantity_Parameter V1, const Quantity_Parameter V2, const Quantity_Parameter V3);
-
- //! Defines the default background colour of views
- //! attached to the viewer by supplying the name of the
- //! colour under the form Quantity_NOC_xxxx .
- Standard_EXPORT void SetDefaultBackgroundColor (const Quantity_NameOfColor Name);
-
+
+ //! Return Graphic Driver instance.
+ const Handle(Graphic3d_GraphicDriver)& Driver() const { return myDriver; }
+
+ //! Returns the structure manager associated to this viewer.
+ Handle(Graphic3d_StructureManager) StructureManager() const { return myStructureManager; }
+
+ //! Return default Rendering Parameters.
+ //! By default these parameters are set in a new V3d_View.
+ const Graphic3d_RenderingParams& DefaultRenderingParams() const { return myDefaultRenderingParams; }
+
+ //! Set default Rendering Parameters.
+ void SetDefaultRenderingParams (const Graphic3d_RenderingParams& theParams) { myDefaultRenderingParams = theParams; }
+
//! Defines the default background colour of views
//! attached to the viewer by supplying the color object
- Standard_EXPORT void SetDefaultBackgroundColor (const Quantity_Color& Color);
-
- //! Defines the default gradient background colours of view
- //! attached to the viewer by supplying the name of the
- //! colours under the form Quantity_NOC_xxxx .
- Standard_EXPORT void SetDefaultBgGradientColors (const Quantity_NameOfColor Name1, const Quantity_NameOfColor Name2, const Aspect_GradientFillMethod FillStyle = Aspect_GFM_HOR);
+ void SetDefaultBackgroundColor (const Quantity_Color& theColor) { myBackground.SetColor (theColor); }
+
+ //! Returns the gradient background of the view.
+ const Aspect_GradientBackground& GetGradientBackground() const { return myGradientBackground; }
//! Defines the default gradient background colours of views
//! attached to the viewer by supplying the colour objects
- Standard_EXPORT void SetDefaultBgGradientColors (const Quantity_Color& Color1, const Quantity_Color& Color2, const Aspect_GradientFillMethod FillStyle = Aspect_GFM_HOR);
-
- //! Gives a default size for the creation of views of
- //! the viewer.
- Standard_EXPORT void SetDefaultViewSize (const Quantity_Length Size);
-
- //! Gives the default projection for creating views
- //! in the viewer.
- Standard_EXPORT void SetDefaultViewProj (const V3d_TypeOfOrientation Orientation);
-
- //! Gives the default visualization mode..
- Standard_EXPORT void SetDefaultVisualization (const V3d_TypeOfVisualization Type);
+ void SetDefaultBgGradientColors (const Quantity_Color& theColor1,
+ const Quantity_Color& theColor2,
+ const Aspect_GradientFillMethod theFillStyle = Aspect_GFM_HOR)
+ {
+ myGradientBackground.SetColors (theColor1, theColor2, theFillStyle);
+ }
+
+ //! Returns the default size of the view.
+ Standard_Real DefaultViewSize() const { return myViewSize; }
+
+ //! Gives a default size for the creation of views of the viewer.
+ Standard_EXPORT void SetDefaultViewSize (const Standard_Real theSize);
+
+ //! Returns the default Projection.
+ V3d_TypeOfOrientation DefaultViewProj() const { return myViewProj; }
+
+ //! Sets the default projection for creating views in the viewer.
+ void SetDefaultViewProj (const V3d_TypeOfOrientation theOrientation) { myViewProj = theOrientation; }
+
+ //! Returns the default type of Visualization.
+ V3d_TypeOfVisualization DefaultVisualization() const { return myVisualization; }
+
+ //! Gives the default visualization mode.
+ void SetDefaultVisualization (const V3d_TypeOfVisualization theType) { myVisualization = theType; }
+
+ //! Returns the default type of Shading
+ V3d_TypeOfShadingModel DefaultShadingModel() const { return myShadingModel; }
//! Gives the default type of SHADING.
- Standard_EXPORT void SetDefaultShadingModel (const V3d_TypeOfShadingModel Type);
-
- //! Gives the default type of texture mapping.
- Standard_EXPORT void SetDefaultSurfaceDetail (const V3d_TypeOfSurfaceDetail Type);
-
- Standard_EXPORT void SetDefaultAngle (const Quantity_PlaneAngle Angle);
-
- //! Defines the mode of regenerating the views making
- //! up the viewer. This can be immediate <ASAP> or
- //! deferred <WAIT>. In this latter case, the views are
- //! updated when the method Update(me) is called.
- Standard_EXPORT void SetUpdateMode (const V3d_TypeOfUpdate theMode);
-
- Standard_EXPORT void SetDefaultTypeOfView (const V3d_TypeOfView Type);
-
- Standard_EXPORT void SetPrivilegedPlane (const gp_Ax3& aPlane);
-
- Standard_EXPORT gp_Ax3 PrivilegedPlane() const;
+ void SetDefaultShadingModel (const V3d_TypeOfShadingModel theType) { myShadingModel = theType; }
+
+ void SetDefaultTypeOfView (const V3d_TypeOfView theType) { myDefaultTypeOfView = theType; }
+
+ //! Returns the default background colour object.
+ Quantity_Color DefaultBackgroundColor() const { return myBackground.Color(); }
+
+ //! Returns the gradient background colour objects of the view.
+ void DefaultBgGradientColors (Quantity_Color& theColor1, Quantity_Color& theColor2) const { myGradientBackground.Colors (theColor1, theColor2); }
+
+ //! Return all Z layer ids in sequence ordered by overlay level from lowest layer to highest ( foreground ).
+ //! The first layer ID in sequence is the default layer that can't be removed.
+ Standard_EXPORT void GetAllZLayers (TColStd_SequenceOfInteger& theLayerSeq) const;
+
+ //! Add a new top-level Z layer to all managed views and get its ID as <theLayerId> value.
+ //! The Z layers are controlled entirely by viewer, it is not possible to add a layer to a particular view.
+ //! The method returns Standard_False if the layer can not be created.
+ //! The layer mechanism allows to display structures in higher layers in overlay of structures in lower layers.
+ Standard_EXPORT Standard_Boolean AddZLayer (Standard_Integer& theLayerId);
+
+ //! Remove Z layer with ID <theLayerId>.
+ //! Method returns Standard_False if the layer can not be removed or doesn't exists.
+ //! By default, there are always default bottom-level layer that can't be removed.
+ Standard_EXPORT Standard_Boolean RemoveZLayer (const Standard_Integer theLayerId);
+
+ //! Returns the settings of a single Z layer.
+ Standard_EXPORT Graphic3d_ZLayerSettings ZLayerSettings (const Standard_Integer theLayerId);
+
+ //! Sets the settings for a single Z layer.
+ Standard_EXPORT void SetZLayerSettings (const Standard_Integer theLayerId, const Graphic3d_ZLayerSettings& theSettings);
+
+public:
+
+ //! Return an iterator for active views.
+ V3d_ListOfViewIterator ActiveViewIterator() const { return V3d_ListOfViewIterator (myActiveViews); }
+
+ //! Initializes an internal iterator on the active views.
+ void InitActiveViews() { myActiveViewsIterator.Initialize (myActiveViews); }
+
+ //! Returns true if there are more active view(s) to return.
+ Standard_Boolean MoreActiveViews() const { return myActiveViewsIterator.More(); }
+
+ //! Go to the next active view (if there is not, ActiveView will raise an exception)
+ void NextActiveViews() { if (!myActiveViews.IsEmpty()) myActiveViewsIterator.Next(); }
- Standard_EXPORT void DisplayPrivilegedPlane (const Standard_Boolean OnOff, const Quantity_Length aSize = 1);
+ const Handle(V3d_View)& ActiveView() const { return myActiveViewsIterator.Value(); }
+ //! returns true if there is only one active view.
+ Standard_Boolean LastActiveView() const { return myActiveViews.Extent() == 1; }
+
+public:
+
+ //! Return an iterator for defined views.
+ V3d_ListOfViewIterator DefinedViewIterator() const { return V3d_ListOfViewIterator (myDefinedViews); }
+
+ //! Initializes an internal iterator on the Defined views.
+ void InitDefinedViews() { myDefinedViewsIterator.Initialize (myDefinedViews); }
+
+ //! returns true if there are more Defined view(s) to return.
+ Standard_Boolean MoreDefinedViews() const { return myDefinedViewsIterator.More(); }
+
+ //! Go to the next Defined view (if there is not, DefinedView will raise an exception)
+ void NextDefinedViews() { if (!myDefinedViews.IsEmpty()) myDefinedViewsIterator.Next(); }
+
+ const Handle(V3d_View)& DefinedView() const { return myDefinedViewsIterator.Value(); }
+
+public: //! @name lights management
+
+ //! Defines default lights:
+ //! positional-light 0.3 0. 0.
+ //! directional-light V3d_XnegYposZpos
+ //! directional-light V3d_XnegYneg
+ //! ambient-light
+ Standard_EXPORT void SetDefaultLights();
+
//! Activates MyLight in the viewer.
- Standard_EXPORT void SetLightOn (const Handle(V3d_Light)& MyLight);
+ Standard_EXPORT void SetLightOn (const Handle(V3d_Light)& theLight);
//! Activates all the lights defined in this viewer.
Standard_EXPORT void SetLightOn();
//! Deactivates MyLight in this viewer.
- Standard_EXPORT void SetLightOff (const Handle(V3d_Light)& MyLight);
+ Standard_EXPORT void SetLightOff (const Handle(V3d_Light)& theLight);
//! Deactivate all the Lights defined in this viewer.
Standard_EXPORT void SetLightOff();
-
+
+ //! Adds Light in Sequence Of Lights.
+ Standard_EXPORT void AddLight (const Handle(V3d_Light)& theLight);
+
//! Delete Light in Sequence Of Lights.
- Standard_EXPORT void DelLight (const Handle(V3d_Light)& MyLight);
-
- //! Defines the selected light.
- Standard_EXPORT void SetCurrentSelectedLight (const Handle(V3d_Light)& TheLight);
-
- //! Defines the selected light at NULL.
- Standard_EXPORT void ClearCurrentSelectedLight();
-
- //! Returns the default background colour depending of the type.
- Standard_EXPORT void DefaultBackgroundColor (const Quantity_TypeOfColor Type, Quantity_Parameter& V1, Quantity_Parameter& V2, Quantity_Parameter& V3) const;
-
- //! Returns the default background colour object.
- Standard_EXPORT Quantity_Color DefaultBackgroundColor() const;
-
- //! Returns the gradient background colour objects of the view.
- Standard_EXPORT void DefaultBgGradientColors (Quantity_Color& Color1, Quantity_Color& Color2) const;
-
- //! Returns the default size of the view.
- Standard_EXPORT Quantity_Length DefaultViewSize() const;
-
- //! Returns the default Projection.
- Standard_EXPORT V3d_TypeOfOrientation DefaultViewProj() const;
-
- //! Returns the default type of Visualization.
- Standard_EXPORT V3d_TypeOfVisualization DefaultVisualization() const;
-
- //! Returns the default type of Shading
- Standard_EXPORT V3d_TypeOfShadingModel DefaultShadingModel() const;
-
- //! Returns the default type of texture mapping
- Standard_EXPORT V3d_TypeOfSurfaceDetail DefaultSurfaceDetail() const;
-
- Standard_EXPORT Quantity_PlaneAngle DefaultAngle() const;
-
- //! Returns the regeneration mode of views in the viewer.
- Standard_EXPORT V3d_TypeOfUpdate UpdateMode() const;
-
- //! Returns True if One View more can be
- //! activated in this Viewer.
- Standard_EXPORT Standard_Boolean IfMoreViews() const;
-
- //! initializes an iteration on the active views.
- Standard_EXPORT void InitActiveViews();
-
- //! returns true if there are more active view(s) to return.
- Standard_EXPORT Standard_Boolean MoreActiveViews() const;
-
- //! Go to the next active view
- //! (if there is not, ActiveView will raise an exception)
- Standard_EXPORT void NextActiveViews();
-
- Standard_EXPORT Handle(V3d_View) ActiveView() const;
-
- //! returns true if there is only
- //! one active view.
- Standard_EXPORT Standard_Boolean LastActiveView() const;
-
- //! initializes an iteration on the Defined views.
- Standard_EXPORT void InitDefinedViews();
-
- //! returns true if there are more Defined view(s) to return.
- Standard_EXPORT Standard_Boolean MoreDefinedViews() const;
-
- //! Go to the next Defined view
- //! (if there is not, DefinedView will raise an exception)
- Standard_EXPORT void NextDefinedViews();
-
- Standard_EXPORT Handle(V3d_View) DefinedView() const;
-
- //! initializes an iteration on the active Lights.
- Standard_EXPORT void InitActiveLights();
-
- //! returns true if there are more active Light(s) to return.
- Standard_EXPORT Standard_Boolean MoreActiveLights() const;
-
- //! Go to the next active Light
- //! (if there is not, ActiveLight will raise an exception)
- Standard_EXPORT void NextActiveLights();
-
- Standard_EXPORT Handle(V3d_Light) ActiveLight() const;
-
- //! initializes an iteration on the Defined Lights.
- Standard_EXPORT void InitDefinedLights();
-
- //! returns true if there are more Defined Light(s) to return.
- Standard_EXPORT Standard_Boolean MoreDefinedLights() const;
-
- //! Go to the next Defined Light
- //! (if there is not, DefinedLight will raise an exception)
- Standard_EXPORT void NextDefinedLights();
-
- Standard_EXPORT Handle(V3d_Light) DefinedLight() const;
-
- //! Returns the structure manager associated to this viewer.
- Standard_EXPORT Handle(Graphic3d_StructureManager) StructureManager() const;
-
- //! Returns the Selected Light.
- Standard_EXPORT Handle(V3d_Light) CurrentSelectedLight() const;
+ Standard_EXPORT void DelLight (const Handle(V3d_Light)& theLight);
+ //! Updates the lights of all the views of a viewer.
+ Standard_EXPORT void UpdateLights();
+
Standard_EXPORT Standard_Boolean IsGlobalLight (const Handle(V3d_Light)& TheLight) const;
+
+ //! Return an iterator for defined lights.
+ V3d_ListOfLightIterator ActiveLightIterator() const { return V3d_ListOfLightIterator (myActiveLights); }
+
+ //! Initializes an internal iteratator on the active Lights.
+ void InitActiveLights() { myActiveLightsIterator.Initialize (myActiveLights); }
+
+ //! returns true if there are more active Light(s) to return.
+ Standard_Boolean MoreActiveLights() const { return myActiveLightsIterator.More(); }
+
+ //! Go to the next active Light (if there is not, ActiveLight() will raise an exception)
+ void NextActiveLights() { myActiveLightsIterator.Next(); }
+
+ const Handle(V3d_Light)& ActiveLight() const { return myActiveLightsIterator.Value(); }
+
+public:
+
+ //! Return an iterator for defined lights.
+ V3d_ListOfLightIterator DefinedLightIterator() const { return V3d_ListOfLightIterator (myDefinedLights); }
+
+ //! Initializes an internal iterattor on the Defined Lights.
+ void InitDefinedLights() { myDefinedLightsIterator.Initialize (myDefinedLights); }
+ //! Returns true if there are more Defined Light(s) to return.
+ Standard_Boolean MoreDefinedLights() const { return myDefinedLightsIterator.More(); }
+
+ //! Go to the next Defined Light (if there is not, DefinedLight() will raise an exception)
+ void NextDefinedLights() { if (!myDefinedLights.IsEmpty()) myDefinedLightsIterator.Next(); }
+
+ const Handle(V3d_Light)& DefinedLight() const { return myDefinedLightsIterator.Value(); }
+
+public: //! @name objects management
+
+ //! Erase all Objects in All the views.
+ Standard_EXPORT void Erase() const;
+
+ //! UnHighlight all Objects in All the views.
+ Standard_EXPORT void UnHighlight() const;
+
+public:
+
//! returns true if the computed mode can be used.
- Standard_EXPORT Standard_Boolean ComputedMode() const;
-
+ Standard_Boolean ComputedMode() const { return myComputedMode; }
+
+ //! Set if the computed mode can be used.
+ void SetComputedMode (const Standard_Boolean theMode) { myComputedMode = theMode; }
+
//! returns true if by default the computed mode must be used.
- Standard_EXPORT Standard_Boolean DefaultComputedMode() const;
-
+ Standard_Boolean DefaultComputedMode() const { return myDefaultComputedMode; }
+
+ //! Set if by default the computed mode must be used.
+ void SetDefaultComputedMode (const Standard_Boolean theMode) { myDefaultComputedMode = theMode; }
+
+public: //! @name privileged plane management
+
+ const gp_Ax3& PrivilegedPlane() const { return myPrivilegedPlane; }
+
+ Standard_EXPORT void SetPrivilegedPlane (const gp_Ax3& thePlane);
+
+ Standard_EXPORT void DisplayPrivilegedPlane (const Standard_Boolean theOnOff, const Standard_Real theSize = 1);
+
+public: //! @name grid management
+
//! Activates the grid in all views of <me>.
Standard_EXPORT void ActivateGrid (const Aspect_GridType aGridType, const Aspect_GridDrawMode aGridDrawMode);
//! marker size : 3.0
Standard_EXPORT void SetGridEcho (const Handle(Graphic3d_AspectMarker3d)& aMarker);
- //! Returns TRUE when grid echo must be displayed
- //! at hit point.
- Standard_EXPORT Standard_Boolean GridEcho() const;
+ //! Returns TRUE when grid echo must be displayed at hit point.
+ Standard_Boolean GridEcho() const { return myGridEcho; }
//! Returns Standard_True if a grid is activated in <me>.
Standard_EXPORT Standard_Boolean IsActive() const;
//! Returns the defined grid in <me>.
Standard_EXPORT Handle(Aspect_Grid) Grid() const;
-
+
//! Returns the current grid type defined in <me>.
- Standard_EXPORT Aspect_GridType GridType() const;
+ Aspect_GridType GridType() const { return myGridType; }
//! Returns the current grid draw mode defined in <me>.
Standard_EXPORT Aspect_GridDrawMode GridDrawMode() const;
//! Returns the definition of the rectangular grid.
- Standard_EXPORT void RectangularGridValues (Quantity_Length& XOrigin, Quantity_Length& YOrigin, Quantity_Length& XStep, Quantity_Length& YStep, Quantity_PlaneAngle& RotationAngle) const;
+ Standard_EXPORT void RectangularGridValues (Standard_Real& XOrigin, Standard_Real& YOrigin, Standard_Real& XStep, Standard_Real& YStep, Standard_Real& RotationAngle) const;
//! Sets the definition of the rectangular grid.
//! <XOrigin>, <YOrigin> defines the origin of the grid.
//! <XStep> defines the interval between 2 vertical lines.
//! <YStep> defines the interval between 2 horizontal lines.
//! <RotationAngle> defines the rotation angle of the grid.
- Standard_EXPORT void SetRectangularGridValues (const Quantity_Length XOrigin, const Quantity_Length YOrigin, const Quantity_Length XStep, const Quantity_Length YStep, const Quantity_PlaneAngle RotationAngle);
+ Standard_EXPORT void SetRectangularGridValues (const Standard_Real XOrigin, const Standard_Real YOrigin, const Standard_Real XStep, const Standard_Real YStep, const Standard_Real RotationAngle);
//! Returns the definition of the circular grid.
- Standard_EXPORT void CircularGridValues (Quantity_Length& XOrigin, Quantity_Length& YOrigin, Quantity_Length& RadiusStep, Standard_Integer& DivisionNumber, Quantity_PlaneAngle& RotationAngle) const;
+ Standard_EXPORT void CircularGridValues (Standard_Real& XOrigin, Standard_Real& YOrigin, Standard_Real& RadiusStep, Standard_Integer& DivisionNumber, Standard_Real& RotationAngle) const;
//! Sets the definition of the circular grid.
//! <XOrigin>, <YOrigin> defines the origin of the grid.
//! <RadiusStep> defines the interval between 2 circles.
//! <DivisionNumber> defines the section number of one half circle.
//! <RotationAngle> defines the rotation angle of the grid.
- Standard_EXPORT void SetCircularGridValues (const Quantity_Length XOrigin, const Quantity_Length YOrigin, const Quantity_Length RadiusStep, const Standard_Integer DivisionNumber, const Quantity_PlaneAngle RotationAngle);
+ Standard_EXPORT void SetCircularGridValues (const Standard_Real XOrigin, const Standard_Real YOrigin, const Standard_Real RadiusStep, const Standard_Integer DivisionNumber, const Standard_Real RotationAngle);
//! Returns the location and the size of the grid.
- Standard_EXPORT void CircularGridGraphicValues (Quantity_Length& Radius, Quantity_Length& OffSet) const;
+ Standard_EXPORT void CircularGridGraphicValues (Standard_Real& Radius, Standard_Real& OffSet) const;
//! Sets the location and the size of the grid.
//! <XSize> defines the width of the grid.
//! <YSize> defines the height of the grid.
//! <OffSet> defines the displacement along the plane normal.
- Standard_EXPORT void SetCircularGridGraphicValues (const Quantity_Length Radius, const Quantity_Length OffSet);
+ Standard_EXPORT void SetCircularGridGraphicValues (const Standard_Real Radius, const Standard_Real OffSet);
//! Returns the location and the size of the grid.
- Standard_EXPORT void RectangularGridGraphicValues (Quantity_Length& XSize, Quantity_Length& YSize, Quantity_Length& OffSet) const;
+ Standard_EXPORT void RectangularGridGraphicValues (Standard_Real& XSize, Standard_Real& YSize, Standard_Real& OffSet) const;
//! Sets the location and the size of the grid.
//! <XSize> defines the width of the grid.
//! <YSize> defines the height of the grid.
//! <OffSet> defines the displacement along the plane normal.
- Standard_EXPORT void SetRectangularGridGraphicValues (const Quantity_Length XSize, const Quantity_Length YSize, const Quantity_Length OffSet);
-
- //! Returns the gradient background of the view.
- Standard_EXPORT Aspect_GradientBackground GetGradientBackground() const;
-
- //! defines default lights -
- //! positional-light 0.3 0. 0.
- //! directional-light V3d_XnegYposZpos
- //! directional-light V3d_XnegYneg
- //! ambient-light
- Standard_EXPORT void SetDefaultLights();
+ Standard_EXPORT void SetRectangularGridGraphicValues (const Standard_Real XSize, const Standard_Real YSize, const Standard_Real OffSet);
-
//! Display grid echo at requested point in the view.
Standard_EXPORT void ShowGridEcho (const Handle(V3d_View)& theView, const Graphic3d_Vertex& thePoint);
-
//! Temporarly hide grid echo.
Standard_EXPORT void HideGridEcho (const Handle(V3d_View)& theView);
- //! Add a new top-level Z layer to all managed views and get
- //! its ID as <theLayerId> value. The Z layers are controlled entirely
- //! by viewer, it is not possible to add a layer to a
- //! particular view. The method returns Standard_False if the layer can
- //! not be created. The layer mechanism allows to display structures
- //! in higher layers in overlay of structures in lower layers.
- Standard_EXPORT Standard_Boolean AddZLayer (Standard_Integer& theLayerId);
-
- //! Remove Z layer with ID <theLayerId>. Method returns
- //! Standard_False if the layer can not be removed or doesn't exists.
- //! By default, there are always default bottom-level layer that can't
- //! be removed.
- Standard_EXPORT Standard_Boolean RemoveZLayer (const Standard_Integer theLayerId);
-
- //! Return all Z layer ids in sequence ordered by overlay level
- //! from lowest layer to highest ( foreground ). The first layer ID
- //! in sequence is the default layer that can't be removed.
- Standard_EXPORT void GetAllZLayers (TColStd_SequenceOfInteger& theLayerSeq) const;
-
- //! Sets the settings for a single Z layer.
- Standard_EXPORT void SetZLayerSettings (const Standard_Integer theLayerId, const Graphic3d_ZLayerSettings& theSettings);
-
- //! Returns the settings of a single Z layer.
- Standard_EXPORT Graphic3d_ZLayerSettings ZLayerSettings (const Standard_Integer theLayerId);
-
- //! Return Graphic Driver instance.
- Standard_EXPORT const Handle(Graphic3d_GraphicDriver)& Driver() const;
-
- Standard_EXPORT Standard_ExtString NextName() const;
-
- Standard_EXPORT Standard_CString Domain() const;
-
- //! Return default Rendering Parameters.
- //! By default these parameters are set in a new V3d_View.
- Standard_EXPORT const Graphic3d_RenderingParams& DefaultRenderingParams() const;
-
- //! Set default Rendering Parameters.
- Standard_EXPORT void SetDefaultRenderingParams (const Graphic3d_RenderingParams& theParams);
-
-friend class V3d_View;
-friend class V3d_Light;
+public: //! @name deprecated methods
- DEFINE_STANDARD_RTTI(V3d_Viewer,MMgt_TShared)
+ Standard_DEPRECATED("This constructor is deprecated")
+ Standard_EXPORT V3d_Viewer (const Handle(Graphic3d_GraphicDriver)& theDriver,
+ const Standard_ExtString theName,
+ const Standard_CString theDomain = "",
+ const Standard_Real theViewSize = 1000.0,
+ const V3d_TypeOfOrientation theViewProj = V3d_XposYnegZpos,
+ const Quantity_Color& theViewBackground = Quantity_NOC_GRAY30,
+ const V3d_TypeOfVisualization theVisualization = V3d_ZBUFFER,
+ const V3d_TypeOfShadingModel theShadingModel = V3d_GOURAUD,
+ const Standard_Boolean theComputedMode = Standard_True,
+ const Standard_Boolean theDefaultComputedMode = Standard_True);
-protected:
-
- Standard_EXPORT void IncrCount();
+ //! Defines the default base colour of views attached
+ //! to the Viewer by supplying the type of colour
+ //! definition and the three component values.
+ Standard_DEPRECATED("This method is deprecated - SetDefaultBackgroundColor() taking Quantity_Color should be used instead")
+ void SetDefaultBackgroundColor (const Quantity_TypeOfColor theType,
+ const Standard_Real theV1,
+ const Standard_Real theV2,
+ const Standard_Real theV3)
+ {
+ Standard_Real aV1 = theV1;
+ Standard_Real aV2 = theV2;
+ Standard_Real aV3 = theV3;
+ if (aV1 < 0.0) aV1 = 0.0; else if (aV1 > 1.0) aV1 = 1.0;
+ if (aV2 < 0.0) aV2 = 0.0; else if (aV2 > 1.0) aV2 = 1.0;
+ if (aV3 < 0.0) aV3 = 0.0; else if (aV3 > 1.0) aV3 = 1.0;
+ SetDefaultBackgroundColor (Quantity_Color (aV1, aV2, aV3, theType));
+ }
+
+ Standard_DEPRECATED("This method is deprecated - DefaultBackgroundColor() without arguments should be used instead")
+ void DefaultBackgroundColor (const Quantity_TypeOfColor theType, Standard_Real& theV1, Standard_Real& theV2, Standard_Real& theV3) const
+ {
+ Quantity_Color aColor = DefaultBackgroundColor();
+ aColor.Values (theV1, theV2, theV3, theType) ;
+ }
private:
//! Returns the default background colour.
- Standard_EXPORT Aspect_Background GetBackgroundColor() const;
-
+ const Aspect_Background& GetBackgroundColor() const { return myBackground; }
+
//! Adds View in Sequence Of Views.
- Standard_EXPORT void AddView (const Handle(V3d_View)& MyView);
+ Standard_EXPORT void AddView (const Handle(V3d_View)& theView);
//! Delete View in Sequence Of Views.
- Standard_EXPORT void DelView (const Handle(V3d_View)& MyView);
+ Standard_EXPORT void DelView (const Handle(V3d_View)& theView);
- //! Adds Light in Sequence Of Lights.
- Standard_EXPORT void AddLight (const Handle(V3d_Light)& MyLight);
-
- Standard_EXPORT Standard_Boolean IsActive (const Handle(V3d_View)& aView) const;
-
private:
- Standard_Integer myNextCount;
Handle(Graphic3d_GraphicDriver) myDriver;
- TCollection_ExtendedString myName;
- TCollection_AsciiString myDomain;
Handle(Graphic3d_StructureManager) myStructureManager;
- V3d_ListOfTransient MyDefinedViews;
- V3d_ListOfTransient MyActiveViews;
- V3d_ListOfTransient MyDefinedLights;
- V3d_ListOfTransient MyActiveLights;
- Aspect_Background MyBackground;
- Aspect_GradientBackground MyGradientBackground;
- Standard_Real MyViewSize;
- V3d_TypeOfOrientation MyViewProj;
- V3d_TypeOfVisualization MyVisualization;
- V3d_TypeOfShadingModel MyShadingModel;
- V3d_TypeOfSurfaceDetail MySurfaceDetail;
- Quantity_PlaneAngle MyDefaultAngle;
- V3d_TypeOfView MyDefaultTypeOfView;
+ TColStd_MapOfInteger myLayerIds;
+ Aspect_GenId myZLayerGenId;
+
+ V3d_ListOfView myDefinedViews;
+ V3d_ListOfView myActiveViews;
+ V3d_ListOfLight myDefinedLights;
+ V3d_ListOfLight myActiveLights;
+
+ Aspect_Background myBackground;
+ Aspect_GradientBackground myGradientBackground;
+ Standard_Real myViewSize;
+ V3d_TypeOfOrientation myViewProj;
+ V3d_TypeOfVisualization myVisualization;
+ V3d_TypeOfShadingModel myShadingModel;
+ V3d_TypeOfView myDefaultTypeOfView;
Graphic3d_RenderingParams myDefaultRenderingParams;
- Handle(V3d_Light) MyCurrentSelectedLight;
- TColStd_ListIteratorOfListOfTransient myActiveViewsIterator;
- TColStd_ListIteratorOfListOfTransient myDefinedViewsIterator;
- TColStd_ListIteratorOfListOfTransient myActiveLightsIterator;
- TColStd_ListIteratorOfListOfTransient myDefinedLightsIterator;
+
+ V3d_ListOfView::Iterator myActiveViewsIterator;
+ V3d_ListOfView::Iterator myDefinedViewsIterator;
+ V3d_ListOfLight::Iterator myActiveLightsIterator;
+ V3d_ListOfLight::Iterator myDefinedLightsIterator;
+
Standard_Boolean myComputedMode;
Standard_Boolean myDefaultComputedMode;
+
gp_Ax3 myPrivilegedPlane;
Handle(Graphic3d_Structure) myPlaneStructure;
Standard_Boolean myDisplayPlane;
- Quantity_Length myDisplayPlaneLength;
+ Standard_Real myDisplayPlaneLength;
+
Handle(V3d_RectangularGrid) myRGrid;
Handle(V3d_CircularGrid) myCGrid;
Aspect_GridType myGridType;
Handle(Graphic3d_Group) myGridEchoGroup;
Handle(Graphic3d_AspectMarker3d) myGridEchoAspect;
Graphic3d_Vertex myGridEchoLastVert;
- TColStd_MapOfInteger myLayerIds;
- Aspect_GenId myZLayerGenId;
+
};
+DEFINE_STANDARD_HANDLE(V3d_Viewer, Standard_Transient)
+
#endif // _V3d_Viewer_HeaderFile
projects / occt.git / blobdiff