// This file is generated by WOK (CPPExt). // Please do not edit this file; modify original file instead. // The copyright and license terms as defined for the original file apply to // this header file considered to be the "object code" form of the original source. #ifndef _Graphic2d_HidingText_HeaderFile #define _Graphic2d_HidingText_HeaderFile #ifndef _Standard_HeaderFile #include #endif #ifndef _Standard_DefineHandle_HeaderFile #include #endif #ifndef _Handle_Graphic2d_HidingText_HeaderFile #include #endif #ifndef _Standard_Integer_HeaderFile #include #endif #ifndef _Standard_ShortReal_HeaderFile #include #endif #ifndef _Graphic2d_Text_HeaderFile #include #endif #ifndef _Handle_Graphic2d_GraphicObject_HeaderFile #include #endif #ifndef _Standard_Real_HeaderFile #include #endif #ifndef _Quantity_PlaneAngle_HeaderFile #include #endif #ifndef _Quantity_Ratio_HeaderFile #include #endif #ifndef _Aspect_TypeOfText_HeaderFile #include #endif #ifndef _Quantity_Factor_HeaderFile #include #endif #ifndef _Standard_Boolean_HeaderFile #include #endif #ifndef _Quantity_Length_HeaderFile #include #endif #ifndef _Handle_Graphic2d_Drawer_HeaderFile #include #endif #ifndef _Aspect_FStream_HeaderFile #include #endif class Graphic2d_GraphicObject; class TCollection_ExtendedString; class Graphic2d_Drawer; //! The primitive HidingText
//! is a Text above a surounded hiding polygon.
//! The text foreground color depends of the
//! SetColorIndex() method.
//! The polygon background color of the
//! SetHidingColorIndex() method.
//! The outline frame foreground color and width depends
//! of the SetFrameColorIndex() & SetFrameWidthIndex() methods.
class Graphic2d_HidingText : public Graphic2d_Text { public: //! Creates a text in a graphic object
//! The text is .
//! The reference point is , .
//! The orientation angle is .
//! The margin ratio is ,defines the proportional
//! margin between the text height and the outline frame.
//! The type of text is and must be one of :
//! Aspect_TOT_SOLID,
//! Aspect_TOT_OUTLINE
//! The scale factor apply to the original font size,
//! Angles are measured counterclockwise with 0 radian
//! at 3 o'clock.
//! Warning: a text can be orientable,slantable,zoomable or outlinable
//! only when this options are enable regardless of the graphic driver.
//! i.e: Xw driver does not,but Xdps or PS driver does.
Standard_EXPORT Graphic2d_HidingText(const Handle(Graphic2d_GraphicObject)& aGraphicObject,const TCollection_ExtendedString& aText,const Standard_Real X,const Standard_Real Y,const Quantity_PlaneAngle anAngle = 0.0,const Quantity_Ratio aMargin = 0.1,const Aspect_TypeOfText aType = Aspect_TOT_SOLID,const Quantity_Factor aScale = 1.0); //! Sets the color index for the frame of the hiding text .
//! default color is 0 (no out line frame is drawn).
Standard_EXPORT void SetFrameColorIndex(const Standard_Integer anIndex = 0) ; //! Sets the width index for the frame of the hiding text .
//! default width is 0 (1 pixel out line frame is drawn).
Standard_EXPORT void SetFrameWidthIndex(const Standard_Integer anIndex = 0) ; //! Sets the interior color index for the frame of the hiding text .
//! default color is 0 (the current view background color).
Standard_EXPORT void SetHidingColorIndex(const Standard_Integer anIndex = 0) ; //! Compute text size depending of a required bounding box,
//! Adjust the text position depending of the text origine
//! and base line if Adjust is TRUE,
//! Expand the text when the Width is smaller that the
//! Fit Width if "Expand" is TRUE.
//! and returns Standard_True if the current Driver used is
//! enable to fit the text size.
//! Warning: The fit computation is apply only if the corresponding
//! dimension is > 0.
Standard_EXPORT virtual Standard_Boolean Fit(const Quantity_Length aWidth,const Quantity_Length aHeight,const Standard_Boolean Adjust = Standard_True,const Standard_Boolean Expand = Standard_True) ; //! Trunc the text when the Width of the text is greater
//! that the defined Width Max,
//! and returns Standard_True if the current Driver used is
//! enable to trunc the text size.
Standard_EXPORT virtual Standard_Boolean Trunc(const Quantity_Length aWidth) ; //! Returns Standard_True if the current Driver used is enabled
//! to get the right size and hiding text offsets in the
//! world size parameter ,,,
//! depending of the attributes of the text and the current scale
//! of the view.
//! NOTE that the text offsets defines the relative position of the
//! of the text string origin from the lower left corner of the hiding text
//! boundary limits.
Standard_EXPORT virtual Standard_Boolean TextSize(Quantity_Length& aWidth,Quantity_Length& aHeight,Quantity_Length& anXoffset,Quantity_Length& anYoffset) const; //! Returns the text margin.
Standard_EXPORT Quantity_Ratio Margin() const; //! Returns the text hiding color index.
Standard_EXPORT Standard_Integer HidingColorIndex() const; //! Returns the text frame color index.
Standard_EXPORT Standard_Integer FrameColorIndex() const; //! Returns the text frame width index.
Standard_EXPORT Standard_Integer FrameWidthIndex() const; Standard_EXPORT virtual void Save(Aspect_FStream& aFStream) const; DEFINE_STANDARD_RTTI(Graphic2d_HidingText) protected: //! Draws the text .
Standard_EXPORT virtual void Draw(const Handle(Graphic2d_Drawer)& aDrawer) ; //! Returns Standard_True if the text is picked,
//! Standard_False if not.
Standard_EXPORT virtual Standard_Boolean Pick(const Standard_ShortReal X,const Standard_ShortReal Y,const Standard_ShortReal aPrecision,const Handle(Graphic2d_Drawer)& aDrawer) ; private: //! Computes the MinMax of the text if possible.
Standard_EXPORT virtual Standard_Boolean ComputeMinMax() ; Standard_Integer myHidingColorIndex; Standard_Integer myFrameColorIndex; Standard_Integer myFrameWidthIndex; Standard_ShortReal myMargin; }; // other Inline functions and methods (like "C++: function call" methods) #endif