// Created on: 1993-06-11
// Created by: Jean-Louis FRENKEL
// Copyright (c) 1993-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 _Prs3d_ArrowAspect_HeaderFile
#define _Prs3d_ArrowAspect_HeaderFile

#include <Graphic3d_AspectLine3d.hxx>
#include <Prs3d_BasicAspect.hxx>

//! A framework for displaying arrows in representations of dimensions and relations.
class Prs3d_ArrowAspect : public Prs3d_BasicAspect
{
  DEFINE_STANDARD_RTTIEXT(Prs3d_ArrowAspect, Prs3d_BasicAspect)
public:
  //! Constructs an empty framework for displaying arrows
  //! in representations of lengths. The lengths displayed
  //! are either on their own or in chamfers, fillets,
  //! diameters and radii.
  Standard_EXPORT Prs3d_ArrowAspect();

  //! Constructs a framework to display an arrow with a
  //! shaft of the length aLength and having a head with
  //! sides at the angle anAngle from each other.
  Standard_EXPORT Prs3d_ArrowAspect(const Standard_Real anAngle, const Standard_Real aLength);

  Standard_EXPORT Prs3d_ArrowAspect(const Handle(Graphic3d_AspectLine3d)& theAspect);

  //! defines the angle of the arrows.
  Standard_EXPORT void SetAngle(const Standard_Real anAngle);

  //! returns the current value of the angle used when drawing an arrow.
  Standard_Real Angle() const { return myAngle; }

  //! Defines the length of the arrows.
  void SetLength(const Standard_Real theLength) { myLength = theLength; }

  //! Returns the current value of the length used when drawing an arrow.
  Standard_Real Length() const { return myLength; }

  //! Turns usage of arrow zoomable on/off
  void SetZoomable(bool theIsZoomable) { myIsZoomable = theIsZoomable; }

  //! Returns TRUE when the Arrow Zoomable is on; TRUE by default.
  bool IsZoomable() const { return myIsZoomable; }

  void SetColor(const Quantity_Color& theColor) { myArrowAspect->SetColor(theColor); }

  const Handle(Graphic3d_AspectLine3d)& Aspect() const { return myArrowAspect; }

  void SetAspect(const Handle(Graphic3d_AspectLine3d)& theAspect) { myArrowAspect = theAspect; }

  //! Dumps the content of me into the stream
  Standard_EXPORT virtual void DumpJson(Standard_OStream& theOStream,
                                        Standard_Integer  theDepth = -1) const Standard_OVERRIDE;

protected:
  Handle(Graphic3d_AspectLine3d) myArrowAspect;
  Standard_Real                  myAngle;
  Standard_Real                  myLength;
  Standard_Boolean               myIsZoomable;
};

DEFINE_STANDARD_HANDLE(Prs3d_ArrowAspect, Prs3d_BasicAspect)

#endif // _Prs3d_ArrowAspect_HeaderFile
