0032308: Configuration - make Xlib dependency optional

[occt.git] / src / AIS / AIS_PlaneTrihedron.hxx

// Created on: 1996-12-13
// Created by: Jean-Pierre COMBE/Odile Olivier
// Copyright (c) 1996-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_PlaneTrihedron_HeaderFile
#define _AIS_PlaneTrihedron_HeaderFile

#include <AIS_InteractiveObject.hxx>
#include <TCollection_AsciiString.hxx>

class AIS_Line;
class AIS_Point;
class Geom_Plane;

//! To construct a selectable 2d axis system in a 3d
//! drawing. This can be placed anywhere in the 3d
//! system, and provides a coordinate system for
//! drawing curves and shapes in a plane.
//! There are 3 selection modes:
//! -   mode 0   selection of the whole plane "trihedron"
//! -   mode 1   selection of the origin of the plane "trihedron"
//! -   mode 2   selection of the axes.
//! Warning
//! For the presentation of planes and trihedra, the
//! millimetre is default unit of length, and 100 the default
//! value for the representation of the axes. If you modify
//! these dimensions, you must temporarily recover the
//! Drawer object. From inside it, take the Aspects in
//! which   the values for length are stocked, for example,
//! PlaneAspect for planes and LineAspect for
//! trihedra. Change these values and recalculate the presentation.
class AIS_PlaneTrihedron : public AIS_InteractiveObject
{
  DEFINE_STANDARD_RTTIEXT(AIS_PlaneTrihedron, AIS_InteractiveObject)
public:

  //! Initializes the plane aPlane. The plane trihedron is
  //! constructed from this and an axis.
  Standard_EXPORT AIS_PlaneTrihedron(const Handle(Geom_Plane)& aPlane);
  
  //! Returns the component specified in SetComponent.
  Standard_EXPORT Handle(Geom_Plane) Component();
  
  //! Creates an instance of the component object aPlane.
  Standard_EXPORT void SetComponent (const Handle(Geom_Plane)& aPlane);
  
  //! Returns the "XAxis".
  Standard_EXPORT Handle(AIS_Line) XAxis() const;
  
  //! Returns the "YAxis".
  Standard_EXPORT Handle(AIS_Line) YAxis() const;
  
  //! Returns the point of origin of the plane trihedron.
  Standard_EXPORT Handle(AIS_Point) Position() const;
  
  //! Sets the length of the X and Y axes.
  Standard_EXPORT void SetLength (const Standard_Real theLength);
  
  //! Returns the length of X and Y axes.
  Standard_EXPORT Standard_Real GetLength() const;
  
  //! Returns true if the display mode selected, aMode, is valid.
  Standard_EXPORT Standard_Boolean AcceptDisplayMode (const Standard_Integer aMode) const Standard_OVERRIDE;

  virtual Standard_Integer Signature() const Standard_OVERRIDE { return 4; }

  //! Returns datum as the type of Interactive Object.
  virtual AIS_KindOfInteractive Type() const Standard_OVERRIDE { return AIS_KindOfInteractive_Datum; }

  //! Allows you to provide settings for the color aColor.
  Standard_EXPORT virtual void SetColor (const Quantity_Color& theColor) Standard_OVERRIDE;

  void SetXLabel (const TCollection_AsciiString& theLabel) { myXLabel = theLabel; }

  void SetYLabel (const TCollection_AsciiString& theLabel) { myYLabel = theLabel; }

protected:

  Standard_EXPORT virtual void Compute (const Handle(PrsMgr_PresentationManager)& theprsMgr,
                                        const Handle(Prs3d_Presentation)& thePrs,
                                        const Standard_Integer theMode) Standard_OVERRIDE;

private:

  Standard_EXPORT virtual void ComputeSelection (const Handle(SelectMgr_Selection)& theSel,
                                                 const Standard_Integer theMode) Standard_OVERRIDE;

private:

  Handle(Geom_Plane) myPlane;
  Handle(AIS_InteractiveObject) myShapes[3];
  TCollection_AsciiString myXLabel;
  TCollection_AsciiString myYLabel;

};

DEFINE_STANDARD_HANDLE(AIS_PlaneTrihedron, AIS_InteractiveObject)

#endif // _AIS_PlaneTrihedron_HeaderFile