Loading files
3d097a032This file is pinned to the selected release. Download the original to open it in your design tool.
// Created on: 2014-11-10
// Copyright (c) 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_TextLabel_HeaderFile
#define _AIS_TextLabel_HeaderFile
#include <AIS_InteractiveObject.hxx>
#include <gp_Pnt.hxx>
#include <gp_Ax2.hxx>
#include <Graphic3d_VerticalTextAlignment.hxx>
#include <Graphic3d_HorizontalTextAlignment.hxx>
#include <Font_FontAspect.hxx>
#include <TCollection_ExtendedString.hxx>
class Font_TextFormatter;
//! Presentation of the text.
class AIS_TextLabel : public AIS_InteractiveObject
{
public:
//! Default constructor
Standard_EXPORT AIS_TextLabel();
//! Return TRUE for supported display mode.
bool AcceptDisplayMode(const int theMode) const override { return theMode == 0; }
//! Setup color of entire text.
Standard_EXPORT void SetColor(const Quantity_Color& theColor) override;
//! Setup transparency within [0, 1] range.
Standard_EXPORT void SetTransparency(const double theValue) override;
//! Removes the transparency setting.
void UnsetTransparency() override { SetTransparency(0.0); }
//! Material has no effect for text label.
void SetMaterial(const Graphic3d_MaterialAspect&) override {}
//! Setup text.
Standard_EXPORT void SetText(const TCollection_ExtendedString& theText);
//! Setup position.
Standard_EXPORT void SetPosition(const gp_Pnt& thePosition);
//! Setup horizontal justification.
Standard_EXPORT void SetHJustification(const Graphic3d_HorizontalTextAlignment theHJust);
//! Setup vertical justification.
Standard_EXPORT void SetVJustification(const Graphic3d_VerticalTextAlignment theVJust);
//! Setup angle.
Standard_EXPORT void SetAngle(const double theAngle);
//! Setup zoomable property.
Standard_EXPORT void SetZoomable(const bool theIsZoomable);
//! Setup height.
Standard_EXPORT void SetHeight(const double theHeight);
//! Setup font aspect.
Standard_EXPORT void SetFontAspect(const Font_FontAspect theFontAspect);
//! Setup font.
Standard_EXPORT void SetFont(const char* theFont);
//! Setup label orientation in the model 3D space.
Standard_EXPORT void SetOrientation3D(const gp_Ax2& theOrientation);
//! Reset label orientation in the model 3D space.
Standard_EXPORT void UnsetOrientation3D();
//! Returns position.
Standard_EXPORT const gp_Pnt& Position() const;
//! Returns the label text.
const TCollection_ExtendedString& Text() const { return myText; }
//! Returns the font of the label text.
Standard_EXPORT const TCollection_AsciiString& FontName() const;
//! Returns the font aspect of the label text.
Standard_EXPORT Font_FontAspect FontAspect() const;
//! Returns label orientation in the model 3D space.
Standard_EXPORT const gp_Ax2& Orientation3D() const;
//! Returns true if the current text placement mode uses text orientation in the model 3D space.
Standard_EXPORT bool HasOrientation3D() const;
Standard_EXPORT void SetFlipping(const bool theIsFlipping);
Standard_EXPORT bool HasFlipping() const;
//! Returns flag if text uses position as point of attach
bool HasOwnAnchorPoint() const { return myHasOwnAnchorPoint; }
//! Set flag if text uses position as point of attach
void SetOwnAnchorPoint(const bool theOwnAnchorPoint) { myHasOwnAnchorPoint = theOwnAnchorPoint; }
//! Define the display type of the text.
//!
//! TODT_NORMAL Default display. Text only.
//! TODT_SUBTITLE There is a subtitle under the text.
//! TODT_DEKALE The text is displayed with a 3D style.
//! TODT_BLEND The text is displayed in XOR.
//! TODT_DIMENSION Dimension line under text will be invisible.
Standard_EXPORT void SetDisplayType(const Aspect_TypeOfDisplayText theDisplayType);
//! Modifies the colour of the subtitle for the TODT_SUBTITLE TextDisplayType
//! and the colour of backgroubd for the TODT_DEKALE TextDisplayType.
Standard_EXPORT void SetColorSubTitle(const Quantity_Color& theColor);
//! Returns text presentation formatter; NULL by default, which means standard text formatter will
//! be used.
const occ::handle<Font_TextFormatter>& TextFormatter() const { return myFormatter; }
//! Setup text formatter for presentation. It's empty by default.
void SetTextFormatter(const occ::handle<Font_TextFormatter>& theFormatter)
{
myFormatter = theFormatter;
}
protected:
//! Compute
Standard_EXPORT void Compute(const occ::handle<PrsMgr_PresentationManager>& theprsMgr,
const occ::handle<Prs3d_Presentation>& thePrs,
const int theMode) override;
//! Compute selection
Standard_EXPORT void ComputeSelection(const occ::handle<SelectMgr_Selection>& theSelection,
const int theMode) override;
//! Calculate label center, width and height
Standard_EXPORT bool calculateLabelParams(const gp_Pnt& thePosition,
gp_Pnt& theCenterOfLabel,
double& theWidth,
double& theHeight) const;
//! Calculate label transformation
Standard_EXPORT gp_Trsf calculateLabelTrsf(const gp_Pnt& thePosition,
gp_Pnt& theCenterOfLabel) const;
protected:
occ::handle<Font_TextFormatter> myFormatter;
TCollection_ExtendedString myText;
gp_Ax2 myOrientation3D;
bool myHasOrientation3D;
bool myHasOwnAnchorPoint;
bool myHasFlipping;
public:
//! CASCADE RTTI
DEFINE_STANDARD_RTTIEXT(AIS_TextLabel, AIS_InteractiveObject)
};
#endif // _AIS_TextLabel_HeaderFile