Open CASCADE Technology  7.3.0
Public Member Functions | Static Public Member Functions | Data Fields

Prs3d_Text Class Reference

A framework to define the display of texts. More...

#include <Prs3d_Text.hxx>

Inheritance diagram for Prs3d_Text:
Inheritance graph
[legend]

Public Member Functions

 Standard_DEPRECATED ("Prs3d_Text::Draw() taking Graphic3d_Group should be used instead") static void Draw(const Handle< Prs3d_Presentation > &thePrs
 Alias to another method Draw() for backward compatibility. More...
 
 Standard_DEPRECATED ("Prs3d_Text::Draw() taking Graphic3d_Group should be used instead") static void Draw(const Handle< Prs3d_Presentation > &thePrs
 Alias to another method Draw() for backward compatibility. More...
 

Static Public Member Functions

static void Draw (const Handle< Graphic3d_Group > &theGroup, const Handle< Prs3d_TextAspect > &theAspect, const TCollection_ExtendedString &theText, const gp_Pnt &theAttachmentPoint)
 Defines the display of the text. More...
 
static void Draw (const Handle< Graphic3d_Group > &theGroup, const Handle< Prs3d_TextAspect > &theAspect, const TCollection_ExtendedString &theText, const gp_Ax2 &theOrientation, const Standard_Boolean theHasOwnAnchor=Standard_True)
 Draws the text label. More...
 
- Static Public Member Functions inherited from Prs3d_Root
static Handle< Graphic3d_GroupCurrentGroup (const Handle< Prs3d_Presentation > &thePrs3d)
 Returns the current (last created) group of primititves inside graphic objects in the display. A group also contains the attributes whose ranges are limited to the primitives in it. More...
 
static Handle< Graphic3d_GroupNewGroup (const Handle< Prs3d_Presentation > &thePrs3d)
 Returns the new group of primitives inside graphic objects in the display. A group also contains the attributes whose ranges are limited to the primitives in it. More...
 

Data Fields

const Handle< Prs3d_Drawer > & theDrawer
 
const Handle< Prs3d_Drawer > const TCollection_ExtendedStringtheText
 
const Handle< Prs3d_Drawer > const TCollection_ExtendedString const gp_PnttheAttachmentPoint
 
const Handle< Prs3d_TextAspect > & theAspect
 
const Handle< Prs3d_TextAspect > const TCollection_ExtendedStringtheText
 
const Handle< Prs3d_TextAspect > const TCollection_ExtendedString const gp_Ax2theOrientation
 

Detailed Description

A framework to define the display of texts.

Member Function Documentation

◆ Draw() [1/2]

static void Prs3d_Text::Draw ( const Handle< Graphic3d_Group > &  theGroup,
const Handle< Prs3d_TextAspect > &  theAspect,
const TCollection_ExtendedString theText,
const gp_Pnt theAttachmentPoint 
)
static

Defines the display of the text.

Parameters
theGroupgroup to add primitives
theAspectpresentation attributes
theTexttext to draw
theAttachmentPointattachment point

◆ Draw() [2/2]

static void Prs3d_Text::Draw ( const Handle< Graphic3d_Group > &  theGroup,
const Handle< Prs3d_TextAspect > &  theAspect,
const TCollection_ExtendedString theText,
const gp_Ax2 theOrientation,
const Standard_Boolean  theHasOwnAnchor = Standard_True 
)
static

Draws the text label.

Parameters
theGroupgroup to add primitives
theAspectpresentation attributes
theTexttext to draw
theOrientationlocation and orientation specified in the model 3D space
theHasOwnAnchor

◆ Standard_DEPRECATED() [1/2]

Prs3d_Text::Standard_DEPRECATED ( "Prs3d_Text::Draw() taking Graphic3d_Group should be used instead"  ) const &

Alias to another method Draw() for backward compatibility.

◆ Standard_DEPRECATED() [2/2]

Prs3d_Text::Standard_DEPRECATED ( "Prs3d_Text::Draw() taking Graphic3d_Group should be used instead"  ) const &

Alias to another method Draw() for backward compatibility.

Field Documentation

◆ theAspect

const Handle< Prs3d_TextAspect >& Prs3d_Text::theAspect

◆ theAttachmentPoint

const Handle< Prs3d_Drawer > const TCollection_ExtendedString const gp_Pnt& Prs3d_Text::theAttachmentPoint
Initial value:

◆ theDrawer

const Handle< Prs3d_Drawer >& Prs3d_Text::theDrawer

◆ theOrientation

const Handle< Prs3d_TextAspect > const TCollection_ExtendedString const gp_Ax2& Prs3d_Text::theOrientation

◆ theText [1/2]

const Handle< Prs3d_Drawer > const TCollection_ExtendedString& Prs3d_Text::theText

◆ theText [2/2]

const Handle< Prs3d_TextAspect > const TCollection_ExtendedString& Prs3d_Text::theText

The documentation for this class was generated from the following file: