Creates and updates a group of attributes for text primitives. More...

#include <Graphic3d_AspectText3d.hxx>

Inheritance diagram for Graphic3d_AspectText3d:

[legend]

Public Member Functions
	Graphic3d_AspectText3d ()
	Creates a context table for text primitives defined with the following default values: Color : Quantity_NOC_YELLOW Font : Font_NOF_ASCII_MONO The style : Aspect_TOST_NORMAL The display type : Aspect_TODT_NORMAL.

	Graphic3d_AspectText3d (const Quantity_Color &theColor, Standard_CString theFont, Standard_Real theExpansionFactor, Standard_Real theSpace, Aspect_TypeOfStyleText theStyle=Aspect_TOST_NORMAL, Aspect_TypeOfDisplayText theDisplayType=Aspect_TODT_NORMAL)
	Creates a context table for text primitives defined with the specified values.

const Quantity_Color &	Color () const
	Return the text color.

const Quantity_ColorRGBA &	ColorRGBA () const
	Return the text color.

void	SetColor (const Quantity_Color &theColor)
	Modifies the color.

void	SetColor (const Quantity_ColorRGBA &theColor)
	Modifies the color.

const TCollection_AsciiString &	Font () const
	Return the font.

void	SetFont (const TCollection_AsciiString &theFont)
	Modifies the font.

void	SetFont (const Standard_CString theFont)
	Modifies the font.

Aspect_TypeOfStyleText	Style () const
	Return the text style.

void	SetStyle (Aspect_TypeOfStyleText theStyle)
	Modifies the style of the text.

Aspect_TypeOfDisplayText	DisplayType () const
	Return display type.

void	SetDisplayType (Aspect_TypeOfDisplayText theDisplayType)
	Define the display type of the text.

bool	GetTextZoomable () const
	Returns TRUE when the Text Zoomable is on.

Standard_ShortReal	GetTextAngle () const
	Returns Angle of degree.

void	SetTextAngle (const Standard_Real theAngle)
	Turns usage of text rotated.

Font_FontAspect	GetTextFontAspect () const
	Returns text FontAspect.

virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
	Dumps the content of me into the stream.

Public Member Functions inherited from Graphic3d_Aspects
	Graphic3d_Aspects ()
	Creates a context table for drawing primitives defined with the following default values:

Aspect_InteriorStyle	InteriorStyle () const
	Return interior rendering style; Aspect_IS_SOLID by default.

void	SetInteriorStyle (const Aspect_InteriorStyle theStyle)
	Modifies the interior type used for rendering.

Graphic3d_TypeOfShadingModel	ShadingModel () const
	Returns shading model; Graphic3d_TypeOfShadingModel_DEFAULT by default. Graphic3d_TOSM_DEFAULT means that Shading Model set as default for entire Viewer will be used.

void	SetShadingModel (const Graphic3d_TypeOfShadingModel theShadingModel)
	Sets shading model.

Graphic3d_AlphaMode	AlphaMode () const
	Returns the way how alpha value should be treated (Graphic3d_AlphaMode_BlendAuto by default, for backward compatibility).

Standard_ShortReal	AlphaCutoff () const
	Returns alpha cutoff threshold, for discarding fragments within Graphic3d_AlphaMode_Mask mode (0.5 by default). If the alpha value is greater than or equal to this value then it is rendered as fully opaque, otherwise, it is rendered as fully transparent.

void	SetAlphaMode (Graphic3d_AlphaMode theMode, Standard_ShortReal theAlphaCutoff=0.5f)
	Defines the way how alpha value should be treated.

const Quantity_ColorRGBA &	ColorRGBA () const
	Return color.

const Quantity_Color &	Color () const
	Return the color.

void	SetColor (const Quantity_Color &theColor)
	Modifies the color.

const Quantity_Color &	InteriorColor () const
	Return interior color.

const Quantity_ColorRGBA &	InteriorColorRGBA () const
	Return interior color.

void	SetInteriorColor (const Quantity_Color &theColor)
	Modifies the color of the interior of the face.

void	SetInteriorColor (const Quantity_ColorRGBA &theColor)
	Modifies the color of the interior of the face.

const Quantity_Color &	BackInteriorColor () const
	Return back interior color.

const Quantity_ColorRGBA &	BackInteriorColorRGBA () const
	Return back interior color.

void	SetBackInteriorColor (const Quantity_Color &theColor)
	Modifies the color of the interior of the back face.

void	SetBackInteriorColor (const Quantity_ColorRGBA &theColor)
	Modifies the color of the interior of the back face.

const Graphic3d_MaterialAspect &	FrontMaterial () const
	Returns the surface material of external faces.

Graphic3d_MaterialAspect &	ChangeFrontMaterial ()
	Returns the surface material of external faces.

void	SetFrontMaterial (const Graphic3d_MaterialAspect &theMaterial)
	Modifies the surface material of external faces.

const Graphic3d_MaterialAspect &	BackMaterial () const
	Returns the surface material of internal faces.

Graphic3d_MaterialAspect &	ChangeBackMaterial ()
	Returns the surface material of internal faces.

void	SetBackMaterial (const Graphic3d_MaterialAspect &theMaterial)
	Modifies the surface material of internal faces.

Graphic3d_TypeOfBackfacingModel	FaceCulling () const
	Return face culling mode; Graphic3d_FaceCulling_BackClosed by default. A back-facing polygon is defined as a polygon whose vertices are in a clockwise order with respect to screen coordinates.

void	SetFaceCulling (Graphic3d_TypeOfBackfacingModel theCulling)
	Set face culling mode.

bool	Distinguish () const
	Returns true if material properties should be distinguished for back and front faces (false by default).

void	SetDistinguish (bool toDistinguish)
	Set material distinction between front and back faces.

void	SetDistinguishOn ()
	Allows material distinction between front and back faces.

void	SetDistinguishOff ()
	Forbids material distinction between front and back faces.

const Handle< Graphic3d_ShaderProgram > &	ShaderProgram () const
	Return shader program.

void	SetShaderProgram (const Handle< Graphic3d_ShaderProgram > &theProgram)
	Sets up OpenGL/GLSL shader program.

const Handle< Graphic3d_TextureSet > &	TextureSet () const
	Return texture array to be mapped.

void	SetTextureSet (const Handle< Graphic3d_TextureSet > &theTextures)
	Setup texture array to be mapped.

Handle< Graphic3d_TextureMap >	TextureMap () const
	Return texture to be mapped.

void	SetTextureMap (const Handle< Graphic3d_TextureMap > &theTexture)
	Assign texture to be mapped. See also SetTextureMapOn() to actually activate texture mapping.

bool	ToMapTexture () const
	Return true if texture mapping is enabled (false by default).

bool	TextureMapState () const
	Return true if texture mapping is enabled (false by default).

void	SetTextureMapOn (bool theToMap)
	Enable or disable texture mapping (has no effect if texture is not set).

void	SetTextureMapOn ()
	Enable texture mapping (has no effect if texture is not set).

void	SetTextureMapOff ()
	Disable texture mapping.

const Graphic3d_PolygonOffset &	PolygonOffset () const
	Returns current polygon offsets settings.

void	SetPolygonOffset (const Graphic3d_PolygonOffset &theOffset)
	Sets polygon offsets settings.

void	PolygonOffsets (Standard_Integer &theMode, Standard_ShortReal &theFactor, Standard_ShortReal &theUnits) const
	Returns current polygon offsets settings.

void	SetPolygonOffsets (const Standard_Integer theMode, const Standard_ShortReal theFactor=1.0f, const Standard_ShortReal theUnits=0.0f)
	Sets up OpenGL polygon offsets mechanism. <aMode> parameter can contain various combinations of Aspect_PolygonOffsetMode enumeration elements (Aspect_POM_None means that polygon offsets are not changed). If <aMode> is different from Aspect_POM_Off and Aspect_POM_None, then <aFactor> and <aUnits> arguments are used by graphic renderer to calculate a depth offset value:

Aspect_TypeOfMarker	MarkerType () const
	Return marker type; Aspect_TOM_POINT by default.

void	SetMarkerType (Aspect_TypeOfMarker theType)
	Modifies the type of marker.

Standard_ShortReal	MarkerScale () const
	Return marker scale factor; 1.0 by default.

void	SetMarkerScale (const Standard_ShortReal theScale)
	Modifies the scale factor. Marker type Aspect_TOM_POINT is not affected by the marker size scale factor. It is always the smallest displayable dot. Warning: Raises Standard_OutOfRange if the scale is a negative value.

const Handle< Graphic3d_MarkerImage > &	MarkerImage () const
	Returns marker's image texture. Could be null handle if marker aspect has been initialized as default type of marker.

void	SetMarkerImage (const Handle< Graphic3d_MarkerImage > &theImage)
	Set marker's image texture.

bool	IsMarkerSprite () const
	Returns TRUE if marker should be drawn using marker sprite (either user-provided or generated).

const Handle< TCollection_HAsciiString > &	TextFont () const
	Returns the font; NULL string by default.

void	SetTextFont (const Handle< TCollection_HAsciiString > &theFont)
	Modifies the font.

Font_FontAspect	TextFontAspect () const
	Returns text FontAspect.

void	SetTextFontAspect (Font_FontAspect theFontAspect)
	Turns usage of Aspect text.

Aspect_TypeOfDisplayText	TextDisplayType () const
	Returns display type; Aspect_TODT_NORMAL by default.

void	SetTextDisplayType (Aspect_TypeOfDisplayText theType)
	Sets display type.

const Quantity_ColorRGBA &	ColorSubTitleRGBA () const
	Returns text background/shadow color; equals to EdgeColor() property.

const Quantity_Color &	ColorSubTitle () const
	Return text background/shadow color; equals to EdgeColor() property.

void	SetColorSubTitle (const Quantity_Color &theColor)
	Modifies text background/shadow color; equals to EdgeColor() property.

void	SetColorSubTitle (const Quantity_ColorRGBA &theColor)
	Modifies text background/shadow color; equals to EdgeColor() property.

bool	IsTextZoomable () const
	Returns TRUE when the Text Zoomable is on.

void	SetTextZoomable (bool theFlag)
	Turns usage of text zoomable on/off.

Aspect_TypeOfStyleText	TextStyle () const
	Returns the text style; Aspect_TOST_NORMAL by default.

void	SetTextStyle (Aspect_TypeOfStyleText theStyle)
	Modifies the style of the text.

Standard_ShortReal	TextAngle () const
	Returns Angle of degree.

void	SetTextAngle (Standard_ShortReal theAngle)
	Turns usage of text rotated.

bool	ToDrawEdges () const
	Returns true if mesh edges should be drawn (false by default).

void	SetDrawEdges (bool theToDraw)
	Set if mesh edges should be drawn or not.

void	SetEdgeOn ()
	The edges of FillAreas are drawn.

void	SetEdgeOff ()
	The edges of FillAreas are not drawn.

const Quantity_Color &	EdgeColor () const
	Return color of edges.

const Quantity_ColorRGBA &	EdgeColorRGBA () const
	Return color of edges.

void	SetEdgeColor (const Quantity_Color &theColor)
	Modifies the color of the edge of the face.

void	SetEdgeColor (const Quantity_ColorRGBA &theColor)
	Modifies the color of the edge of the face.

Aspect_TypeOfLine	EdgeLineType () const
	Return edges line type (same as LineType()).

void	SetEdgeLineType (Aspect_TypeOfLine theType)
	Modifies the edge line type (same as SetLineType())

Standard_ShortReal	EdgeWidth () const
	Return width for edges in pixels (same as LineWidth()).

void	SetEdgeWidth (Standard_Real theWidth)
	Modifies the edge thickness (same as SetLineWidth())

bool	ToSkipFirstEdge () const
	Returns TRUE if drawing element edges should discard first edge in triangle; FALSE by default. Graphics hardware works mostly with triangles, so that wireframe presentation will draw triangle edges by default. This flag allows rendering wireframe presentation of quad-only array split into triangles. For this, quads should be split in specific order, so that the quad diagonal (to be NOT rendered) goes first: 1---—2 / / Triangle #1: 2-0-1; Triangle #2: 0-2-3 0---—3.

void	SetSkipFirstEdge (bool theToSkipFirstEdge)
	Set skip first triangle edge flag for drawing wireframe presentation of quads array split into triangles.

bool	ToDrawSilhouette () const
	Returns TRUE if silhouette (outline) should be drawn (with edge color and width); FALSE by default.

void	SetDrawSilhouette (bool theToDraw)
	Enables/disables drawing silhouette (outline).

const Handle< Graphic3d_HatchStyle > &	HatchStyle () const
	Returns the hatch type used when InteriorStyle is IS_HATCH.

void	SetHatchStyle (const Handle< Graphic3d_HatchStyle > &theStyle)
	Modifies the hatch type used when InteriorStyle is IS_HATCH.

void	SetHatchStyle (const Aspect_HatchStyle theStyle)
	Modifies the hatch type used when InteriorStyle is IS_HATCH.

bool	IsEqual (const Graphic3d_Aspects &theOther)
	Check for equality with another aspects.

bool	ToSuppressBackFaces () const

void	SetSuppressBackFaces (bool theToSuppress)

bool	BackFace () const

void	AllowBackFace ()

void	SuppressBackFace ()

Aspect_TypeOfLine	LineType () const
	Return line type; Aspect_TOL_SOLID by default.

void	SetLineType (Aspect_TypeOfLine theType)
	Modifies the line type.

uint16_t	LinePattern () const
	Return custom stipple line pattern; 0xFFFF by default.

void	SetLinePattern (uint16_t thePattern)
	Modifies the stipple line pattern, and changes line type to Aspect_TOL_USERDEFINED for non-standard pattern.

uint16_t	LineStippleFactor () const
	Return a multiplier for each bit in the line stipple pattern within [1, 256] range; 1 by default.

void	SetLineStippleFactor (uint16_t theFactor)
	Set a multiplier for each bit in the line stipple pattern.

Standard_ShortReal	LineWidth () const
	Return width for edges in pixels; 1.0 by default.

void	SetLineWidth (Standard_ShortReal theWidth)
	Modifies the line thickness Warning: Raises Standard_OutOfRange if the width is a negative value.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Graphic3d_Aspects
static uint16_t	DefaultLinePatternForType (Aspect_TypeOfLine theType)
	Return stipple line pattern for line type.

static Aspect_TypeOfLine	DefaultLineTypeForPattern (uint16_t thePattern)
	Return line type for stipple line pattern.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Protected Attributes inherited from Graphic3d_Aspects
Handle< Graphic3d_ShaderProgram >	myProgram
	Returns true if mesh edges should be drawn (false by default).

Handle< Graphic3d_TextureSet >	myTextureSet
	Returns true if mesh edges should be drawn (false by default).

Handle< Graphic3d_MarkerImage >	myMarkerImage
	Returns true if mesh edges should be drawn (false by default).

Handle< Graphic3d_HatchStyle >	myHatchStyle
	Returns true if mesh edges should be drawn (false by default).

Handle< TCollection_HAsciiString >	myTextFont
	Returns true if mesh edges should be drawn (false by default).

Graphic3d_MaterialAspect	myFrontMaterial
	Returns true if mesh edges should be drawn (false by default).

Graphic3d_MaterialAspect	myBackMaterial
	Returns true if mesh edges should be drawn (false by default).

Quantity_ColorRGBA	myInteriorColor
	Returns true if mesh edges should be drawn (false by default).

Quantity_ColorRGBA	myBackInteriorColor
	Returns true if mesh edges should be drawn (false by default).

Quantity_ColorRGBA	myEdgeColor
	Returns true if mesh edges should be drawn (false by default).

Graphic3d_PolygonOffset	myPolygonOffset
	Returns true if mesh edges should be drawn (false by default).

Aspect_InteriorStyle	myInteriorStyle
	Returns true if mesh edges should be drawn (false by default).

Graphic3d_TypeOfShadingModel	myShadingModel
	Returns true if mesh edges should be drawn (false by default).

Graphic3d_TypeOfBackfacingModel	myFaceCulling
	Returns true if mesh edges should be drawn (false by default).

Graphic3d_AlphaMode	myAlphaMode
	Returns true if mesh edges should be drawn (false by default).

Standard_ShortReal	myAlphaCutoff
	Returns true if mesh edges should be drawn (false by default).

Aspect_TypeOfLine	myLineType
	Returns true if mesh edges should be drawn (false by default).

Standard_ShortReal	myLineWidth
	Returns true if mesh edges should be drawn (false by default).

uint16_t	myLineFactor
	Returns true if mesh edges should be drawn (false by default).

uint16_t	myLinePattern
	Returns true if mesh edges should be drawn (false by default).

Aspect_TypeOfMarker	myMarkerType
	Returns true if mesh edges should be drawn (false by default).

Standard_ShortReal	myMarkerScale
	Returns true if mesh edges should be drawn (false by default).

Aspect_TypeOfStyleText	myTextStyle
	Returns true if mesh edges should be drawn (false by default).

Aspect_TypeOfDisplayText	myTextDisplayType
	Returns true if mesh edges should be drawn (false by default).

Font_FontAspect	myTextFontAspect
	Returns true if mesh edges should be drawn (false by default).

Standard_ShortReal	myTextAngle
	Returns true if mesh edges should be drawn (false by default).

bool	myToSkipFirstEdge
	Returns true if mesh edges should be drawn (false by default).

bool	myToDistinguishMaterials
	Returns true if mesh edges should be drawn (false by default).

bool	myToDrawEdges
	Returns true if mesh edges should be drawn (false by default).

bool	myToDrawSilhouette
	Returns true if mesh edges should be drawn (false by default).

bool	myToMapTexture
	Returns true if mesh edges should be drawn (false by default).

bool	myIsTextZoomable
	Returns true if mesh edges should be drawn (false by default).

Detailed Description

Creates and updates a group of attributes for text primitives.

Constructor & Destructor Documentation

◆ Graphic3d_AspectText3d() [1/2]

Graphic3d_AspectText3d::Graphic3d_AspectText3d ( )

Creates a context table for text primitives defined with the following default values: Color : Quantity_NOC_YELLOW Font : Font_NOF_ASCII_MONO The style : Aspect_TOST_NORMAL The display type : Aspect_TODT_NORMAL.

◆ Graphic3d_AspectText3d() [2/2]

Graphic3d_AspectText3d::Graphic3d_AspectText3d	(	const Quantity_Color &	theColor,
		Standard_CString	theFont,
		Standard_Real	theExpansionFactor,
		Standard_Real	theSpace,
		Aspect_TypeOfStyleText	theStyle = `Aspect_TOST_NORMAL`,
		Aspect_TypeOfDisplayText	theDisplayType = `Aspect_TODT_NORMAL`
	)

Creates a context table for text primitives defined with the specified values.

Parameters

theColor	[in] text color
theFont	[in] font family name or alias like Font_NOF_ASCII_MONO
theExpansionFactor	[in] deprecated parameter, has no effect
theSpace	[in] deprecated parameter, has no effect
theStyle	[in] font style
theDisplayType	[in] display mode

Member Function Documentation

◆ Color()

const Quantity_Color & Graphic3d_AspectText3d::Color ( ) const

inline

Return the text color.

◆ ColorRGBA()

const Quantity_ColorRGBA & Graphic3d_AspectText3d::ColorRGBA ( ) const

inline

Return the text color.

◆ DisplayType()

Aspect_TypeOfDisplayText Graphic3d_AspectText3d::DisplayType ( ) const

inline

Return display type.

◆ DumpJson()

virtual void Graphic3d_AspectText3d::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	theDepth = `-1`
	)		const

overridevirtual

Dumps the content of me into the stream.

Reimplemented from Graphic3d_Aspects.

◆ Font()

const TCollection_AsciiString & Graphic3d_AspectText3d::Font ( ) const

inline

Return the font.

◆ GetTextAngle()

Standard_ShortReal Graphic3d_AspectText3d::GetTextAngle ( ) const

inline

Returns Angle of degree.

◆ GetTextFontAspect()

Font_FontAspect Graphic3d_AspectText3d::GetTextFontAspect ( ) const

inline

Returns text FontAspect.

◆ GetTextZoomable()

bool Graphic3d_AspectText3d::GetTextZoomable ( ) const

inline

Returns TRUE when the Text Zoomable is on.

◆ SetColor() [1/2]

void Graphic3d_AspectText3d::SetColor ( const Quantity_Color & theColor )

inline

Modifies the color.

◆ SetColor() [2/2]

void Graphic3d_AspectText3d::SetColor ( const Quantity_ColorRGBA & theColor )

inline

Modifies the color.

◆ SetDisplayType()

void Graphic3d_AspectText3d::SetDisplayType ( Aspect_TypeOfDisplayText theDisplayType )

inline

Define the display type of the text.

◆ SetFont() [1/2]

void Graphic3d_AspectText3d::SetFont ( const Standard_CString theFont )

inline

Modifies the font.

◆ SetFont() [2/2]

void Graphic3d_AspectText3d::SetFont ( const TCollection_AsciiString & theFont )

inline

Modifies the font.

◆ SetStyle()

void Graphic3d_AspectText3d::SetStyle ( Aspect_TypeOfStyleText theStyle )

inline

Modifies the style of the text.

◆ SetTextAngle()

void Graphic3d_AspectText3d::SetTextAngle ( const Standard_Real theAngle )

inline

Turns usage of text rotated.

◆ Style()

Aspect_TypeOfStyleText Graphic3d_AspectText3d::Style ( ) const

inline

Return the text style.

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

Graphic3d_AspectText3d.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Graphic3d_AspectText3d() [1/2]

◆ Graphic3d_AspectText3d() [2/2]

Member Function Documentation

◆ Color()

◆ ColorRGBA()

◆ DisplayType()

◆ DumpJson()

◆ Font()

◆ GetTextAngle()

◆ GetTextFontAspect()

◆ GetTextZoomable()

◆ SetColor() [1/2]

◆ SetColor() [2/2]

◆ SetDisplayType()

◆ SetFont() [1/2]

◆ SetFont() [2/2]

◆ SetStyle()

◆ SetTextAngle()

◆ Style()