This is the base text class. It's part of Dtk_CompositeText.
It's used into a lot of 2D Entities
It contains an inner Dtk_Oriented2dBBox and a outer Dtk_Oriented2dBBox.
This class represents the base texts used in the annotations entities...
The Dtk_Text uses a lot of informations. The most important ones are shown in the picture below:
. More...

Public Types
enum	MirroringTypeEnum { NoMirroring = 0, HorizontalMirroring, VerticalMirroring }

Public Member Functions
Dtk_anchor_type &	AnchorType ()
	Retrieves the text anchor type - get/set -. More...

const Dtk_anchor_type &	AnchorType () const
	Retrieves the text anchor type - read only -. More...

Text_or_character **	ConvertToText_or_character (Dtk_Int32 &outNumTexts) const
	Converts the Dtk_text to a Text_or_character - for backward compatibility only -. More...

Dtk_ErrorStatus	CreateFrameAsGeometry (Dtk_tab< Dtk_CurvePtr > &outGeoms) const
	Creates geometries corresponding to the text frame type. More...

	Dtk_Text ()
	Base constructor. More...

	Dtk_Text (const Dtk_Text &s)
	Copy constructor. More...

	Dtk_Text (Dtk_string inTextString, const Dtk_Oriented2dBBox &inInnerBox, const Dtk_Oriented2dBBox &inOuterBox, const Dtk_anchor_type &inAnchorType, const DTK_Text_type &inTextType, const Dtk_Int32 &inHorizontalVerticalType, const Dtk_InfoPtr &inInfos, const Dtk_TextStyle &inTextStyle, const Dtk_Double64 &inSlant, const Dtk_Int32 &inFontIndex, const Dtk_Int32 &inMirroringType)
	Constructor from struct text_or_character_def - for backward compatibility only -. More...

	Dtk_Text (Dtk_string inTextString, const Dtk_Oriented2dBBox &inInnerBox, const Dtk_Oriented2dBBox &inOuterBox, const Dtk_Double64 &inSlant, const Dtk_bool &inHorizontalVerticalType, const DTK_Text_type &inTextType, const Dtk_InfoPtr &inInfos, const Dtk_TextStyle &inTextStyle)
	Constructor. More...

	Dtk_Text (Dtk_Text &&s) DTK_NOEXCEPT
	\MoveConstructor{s} More...

Dtk_Text *	ExplodeText (Dtk_Int32 **outNumFontArray, Dtk_Int32 &outNumTexts) const
	Explodes the Dtk_Text to other Dtk_Text according the IGES font number. More...

Dtk_frame_type	FrameType () const
	Retrieves the text frame type - read only -. More...

void	GetFrame (Dtk_Frame &outFrame) const
	Retrieves the Frame - read only -. More...

Dtk_InfoPtr &	GetInfo ()
	Retrieves the text infos. More...

const Dtk_InfoPtr &	GetInfo () const
	Retrieves the text infos - read only -. More...

Dtk_Oriented2dBBox &	GetInnerBoundingBox ()

const Dtk_Oriented2dBBox &	GetInnerBoundingBox () const
	Processes the inner bounding box. More...

Dtk_Double64	GetInnerRotationAngle (const Dtk_dir &inXAxis=Dtk_dir(1, 0, 0), const Dtk_dir &inYAxis=Dtk_dir(0, 1, 0))
	Gets the inner bounding box rotation angle giving a reference base. More...

void	GetInnerXYAxis (Dtk_dir &outXAxis, Dtk_dir &outYAxis) const
	Gets the inner bounding box orientation. More...

Dtk_Oriented2dBBox &	GetOuterBoundingBox ()

const Dtk_Oriented2dBBox &	GetOuterBoundingBox () const
	Processes the outer bounding box. More...

Dtk_Double64	GetOuterRotationAngle (const Dtk_dir &inXAxis=Dtk_dir(1, 0, 0), const Dtk_dir &inYAxis=Dtk_dir(0, 1, 0))
	Gets the outer bounding box rotation angle giving a reference base. More...

void	GetOuterXYAxis (Dtk_dir &outXAxis, Dtk_dir &outYAxis) const
	Gets the outer bounding box orientation. More...

Dtk_pnt &	InnerLocation ()
	Retrieves the inner bounding box location - get/set -. More...

const Dtk_pnt &	InnerLocation () const
	Retrieves the inner bounding box location - read only -. More...

Dtk_ErrorStatus	InnerTranslate (const Dtk_dir &inTranslateDir)
	Translates the inner bounding box giving a translation vector. More...

Dtk_dir &	InnerXAxis ()
	Retrieves the inner bounding box XAxis - get/set -. More...

const Dtk_dir &	InnerXAxis () const
	Retrieves the inner bounding box XAxis - read only -. More...

Dtk_dir &	InnerYAxis ()
	Retrieves the inner bounding box YAxis - get/set -. More...

const Dtk_dir &	InnerYAxis () const
	Retrieves the inner bounding box YAxis - read only -. More...

Dtk_bool	IsEmpty () const
	Tells if the Dtk_Text is empty or not - read only -. More...

Dtk_Text &	operator= (const Dtk_Text &inToBeAssigned)
	Assignment Operator. More...

Dtk_Text &	operator= (Dtk_Text &&s) DTK_NOEXCEPT

Dtk_pnt &	OuterLocation ()
	Retrieves the outer bounding box location - get/set -. More...

const Dtk_pnt &	OuterLocation () const
	Retrieves the outer bounding box location - read only -. More...

Dtk_ErrorStatus	OuterTranslate (const Dtk_dir &inTranslateDir)
	Translates the outer bounding box giving a translation vector. More...

Dtk_dir &	OuterXAxis ()
	Retrieves the outer bounding box XAxis - get/set -. More...

const Dtk_dir &	OuterXAxis () const
	Retrieves the outer bounding box XAxis - read only -. More...

Dtk_dir &	OuterYAxis ()
	Retrieves the outer bounding box YAxis - get/set -. More...

const Dtk_dir &	OuterYAxis () const
	Retrieves the outer bounding box YAxis - read only -. More...

Dtk_pnt	ProcessBottomLeftAnchorPoint () const
	Processes the bottom-left inner anchor point. More...

MirroringTypeEnum	ProcessMirroringType (const Dtk_dir &inZAxis=Dtk_dir(0, 0, 1)) const
	Processes the mirroring type giving the reference Z Axis. More...

Dtk_Double64	ProcessRotationAngle (const Dtk_dir &inZAxis=Dtk_dir(0, 0, 1)) const
	Processes the inner bounding box rotation angle giving the reference Z Axis. More...

Dtk_Int32	ProcessTextNumLines () const
	Processes the line feed number. More...

Dtk_ErrorStatus	Reverse ()
	Reverses the text The text anchor type is replaced by the opposed one and the text orientation is reversed. More...

	SetAsDeprecated ("2020.2", "Use CreateFrameAsGeometry( Dtk_tab<Dtk_CurvePtr> &outGeoms) instead") Dtk_ErrorStatus CreateFrameAsGeometry(Dtk_tab< Geometric_set_select_entity * > &outGeoms) const
	OBSOLETE Creates geometries corresponding to the text frame type. More...

void	SetFrameType (const Dtk_frame_type &inFrameType, Dtk_tab< Dtk_CurvePtr > inRelatedGeomElements)
	Set the text frame information - get/set -. More...

Dtk_ErrorStatus	SetInnerAnchorPoint (const Dtk_pnt &inNewOrigin, const Dtk_anchor_type &inLocationAnchorType)
	Set the text inner anchor point. More...

Dtk_ErrorStatus	SetInnerAnchorPointWithTranslation (const Dtk_pnt &new_origin, const Dtk_anchor_type location_anchor_type)

Dtk_ErrorStatus	SetInnerBoundingBox (const Dtk_Oriented2dBBox &innerBoundingBox)
	Sets the inner bounding box. More...

Dtk_ErrorStatus	SetInnerRotationAngle (const Dtk_Double64 &inRotationAngle, const Dtk_dir &inXAxis=Dtk_dir(1, 0, 0), const Dtk_dir &inYAxis=Dtk_dir(0, 1, 0))
	Sets the inner bounding box rotation angle giving a reference base. More...

void	SetInnerXLength (const Dtk_Double64 &inXLength)
	Sets the inner bounding box X length. More...

void	SetInnerXYAxis (const Dtk_dir &inXAxis, const Dtk_dir &inYAxis)
	Sets the inner bounding box orientation. More...

void	SetInnerYLength (const Dtk_Double64 &inYLength)
	Sets the inner bounding box Y length. More...

Dtk_ErrorStatus	SetOuterAnchorPoint (const Dtk_pnt &inNewOrigin, const Dtk_anchor_type &inLocationAnchorType)
	Set the text outer anchor point. More...

Dtk_ErrorStatus	SetOuterAnchorPointWithTranslation (const Dtk_pnt &new_origin, const Dtk_anchor_type location_anchor_type)

Dtk_ErrorStatus	SetOuterBoundingBox (const Dtk_Oriented2dBBox &outerBoundingBox)
	Sets the outer bounding box. More...

Dtk_ErrorStatus	SetOuterRotationAngle (const Dtk_Double64 &inRotationAngle, const Dtk_dir &inXAxis=Dtk_dir(1, 0, 0), const Dtk_dir &inYAxis=Dtk_dir(0, 1, 0))
	Sets the outer bounding box rotation angle giving a reference base. More...

void	SetOuterXLength (const Dtk_Double64 &inXLength)
	Sets the outer bounding box X length. More...

void	SetOuterXYAxis (const Dtk_dir &inXAxis, const Dtk_dir &inYAxis)
	Sets the outer bounding box orientation. More...

void	SetOuterYLength (const Dtk_Double64 &inYLength)
	Sets the outer bounding box Y length. More...

Dtk_ErrorStatus	SetVerticallyOrientedStatus (const Dtk_bool &inVerticallyOrientedStatus)
	Sets the text vertically oriented status. More...

Dtk_string &	Text ()
	Retrieves the text string - get/set -. More...

const Dtk_string &	Text () const
	Retrieves the text string - read only -. More...

Dtk_TextStyle &	TextStyle ()
	Retrieves the text text style - get/set -. More...

const Dtk_TextStyle &	TextStyle () const
	Retrieves the text text style - read only -. More...

DTK_Text_subtype &	TextSubType ()
	Retrieves the text subtype - get/set -. More...

const DTK_Text_subtype &	TextSubType () const
	Retrieves the text subtype - read only -. More...

DTK_Text_type &	TextType ()
	Retrieves the text type - get/set -. More...

const DTK_Text_type &	TextType () const
	Retrieves the text type - read only -. More...

Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)
	Applies a transformation matrix to the text. More...

Dtk_ErrorStatus	Translate (const Dtk_dir &inTranslateDir)
	Translates the text giving a translation vector. More...

const Dtk_bool &	VerticallyOrientedStatus () const
	Retrieves the text vertically oriented Status - read only -. More...

	~Dtk_Text ()
	Destructor. More...

Protected Attributes
Dtk_Handle *	_Private

Friends
Dtk_CompositeText	operator+ (const Dtk_Text &s1, const Dtk_Text &s2)

std::ostream &	operator<< (std::ostream &o, const Dtk_Text &d)

Detailed Description

This is the base text class. It's part of Dtk_CompositeText.
It's used into a lot of 2D Entities
It contains an inner Dtk_Oriented2dBBox and a outer Dtk_Oriented2dBBox.
This class represents the base texts used in the annotations entities...
The Dtk_Text uses a lot of informations. The most important ones are shown in the picture below:
.

Dtk_Text Most Important Informations

The Dtk_Text also uses an anchor point notion. Here the 9 anchor point types:

Anchor Type Samples

Member Enumeration Documentation

◆ MirroringTypeEnum

enum Dtk_Text::MirroringTypeEnum

Enumerator
NoMirroring
HorizontalMirroring
VerticalMirroring

                             {
           NoMirroring = 0,
           HorizontalMirroring,
           VerticalMirroring
      };

Constructor & Destructor Documentation

◆ ~Dtk_Text()

Dtk_Text::~Dtk_Text ( )

Destructor.

◆ Dtk_Text() [1/5]

Dtk_Text::Dtk_Text ( )

Base constructor.

◆ Dtk_Text() [2/5]

Dtk_Text::Dtk_Text ( const Dtk_Text & s )

Copy constructor.

Parameters

s	Object to copy.

◆ Dtk_Text() [3/5]

Dtk_Text::Dtk_Text ( Dtk_Text && s )

\MoveConstructor{s}

◆ Dtk_Text() [4/5]

Dtk_Text::Dtk_Text	(	Dtk_string	inTextString,
		const Dtk_Oriented2dBBox &	inInnerBox,
		const Dtk_Oriented2dBBox &	inOuterBox,
		const Dtk_anchor_type &	inAnchorType,
		const DTK_Text_type &	inTextType,
		const Dtk_Int32 &	inHorizontalVerticalType,
		const Dtk_InfoPtr &	inInfos,
		const Dtk_TextStyle &	inTextStyle,
		const Dtk_Double64 &	inSlant,
		const Dtk_Int32 &	inFontIndex,
		const Dtk_Int32 &	inMirroringType
	)

Constructor from struct text_or_character_def - for backward compatibility only -.

Full featured constructor

Parameters

inTextString	The text string
inInnerBox	The inner bounding box
inOuterBox	The outer bounding box
inAnchorType	The anchor type
inTextType	The text type
inHorizontalVerticalType	The horizontal/vertical text orientation
inInfos	The text infos
inTextStyle	The text style
inSlant	The text slant - PI / 2.0 for normal text -
inFontIndex	The font index
inMirroringType	The mirroring type

◆ Dtk_Text() [5/5]

Dtk_Text::Dtk_Text	(	Dtk_string	inTextString,
		const Dtk_Oriented2dBBox &	inInnerBox,
		const Dtk_Oriented2dBBox &	inOuterBox,
		const Dtk_Double64 &	inSlant,
		const Dtk_bool &	inHorizontalVerticalType,
		const DTK_Text_type &	inTextType,
		const Dtk_InfoPtr &	inInfos,
		const Dtk_TextStyle &	inTextStyle
	)

Constructor.

Parameters

inTextString	The text string
inInnerBox	The inner bounding box
inOuterBox	The outer bounding box
inSlant	The text slant - PI / 2.0 for normal text -
inHorizontalVerticalType	The horizontal/vertical text orientation
inTextType	The text type
inInfos	The text infos
inTextStyle	The text style

Member Function Documentation

◆ AnchorType() [1/2]

Dtk_anchor_type& Dtk_Text::AnchorType ( )

Retrieves the text anchor type - get/set -.

Returns: The text anchor type

See also: AnchorType() const

◆ AnchorType() [2/2]

const Dtk_anchor_type& Dtk_Text::AnchorType ( ) const

Retrieves the text anchor type - read only -.

Returns: The text anchor type

See also: AnchorType()

◆ ConvertToText_or_character()

Text_or_character** Dtk_Text::ConvertToText_or_character ( Dtk_Int32 & outNumTexts ) const

Converts the Dtk_text to a Text_or_character - for backward compatibility only -.

Parameters

outNumTexts Resulting Text_or_character array size

Returns: the Text_or_character array.

◆ CreateFrameAsGeometry()

Dtk_ErrorStatus Dtk_Text::CreateFrameAsGeometry ( Dtk_tab< Dtk_CurvePtr > & outGeoms ) const

Creates geometries corresponding to the text frame type.

Parameters

outGeoms the resulting geometries

Returns: dtkNoError if OK

◆ ExplodeText()

Dtk_Text* Dtk_Text::ExplodeText	(	Dtk_Int32 **	outNumFontArray,
		Dtk_Int32 &	outNumTexts
	)		const

Explodes the Dtk_Text to other Dtk_Text according the IGES font number.

Parameters

outNumFontArray	Font numbers array - size = outNumTexts -
outNumTexts	Number of resulting texts

Returns: the Exploded resulting Dtk_Text array - size = outNumTexts -.

◆ FrameType()

Dtk_frame_type Dtk_Text::FrameType ( ) const

Retrieves the text frame type - read only -.

Returns: The text frame type

See also: FrameType()

◆ GetFrame()

void Dtk_Text::GetFrame ( Dtk_Frame & outFrame ) const

Retrieves the Frame - read only -.

Parameters

outFrame The frame

See also: FrameType() const

◆ GetInfo() [1/2]

Dtk_InfoPtr& Dtk_Text::GetInfo ( )

Retrieves the text infos.

Returns: The text infos

◆ GetInfo() [2/2]

const Dtk_InfoPtr& Dtk_Text::GetInfo ( ) const

Retrieves the text infos - read only -.

Returns: The text infos

◆ GetInnerBoundingBox() [1/2]

Dtk_Oriented2dBBox& Dtk_Text::GetInnerBoundingBox ( )

◆ GetInnerBoundingBox() [2/2]

const Dtk_Oriented2dBBox& Dtk_Text::GetInnerBoundingBox ( ) const

Processes the inner bounding box.

Returns: The inner bounding box

◆ GetInnerRotationAngle()

Dtk_Double64 Dtk_Text::GetInnerRotationAngle	(	const Dtk_dir &	inXAxis = `Dtk_dir(1, 0, 0)`,
		const Dtk_dir &	inYAxis = `Dtk_dir(0, 1, 0)`
	)

Gets the inner bounding box rotation angle giving a reference base.

Parameters

inXAxis	The reference X Axis - default value = (1,0,0)
inYAxis	The reference Y Axis - default value = (0,1,0)

Returns: The rotation angle

See also: SetRotationAngle

◆ GetInnerXYAxis()

void Dtk_Text::GetInnerXYAxis	(	Dtk_dir &	outXAxis,
		Dtk_dir &	outYAxis
	)		const

Gets the inner bounding box orientation.

Parameters

outXAxis	The inner bounding box X Axis
outYAxis	The inner bounding box Y Axis

See also: SetInnerXYAxis

◆ GetOuterBoundingBox() [1/2]

Dtk_Oriented2dBBox& Dtk_Text::GetOuterBoundingBox ( )

◆ GetOuterBoundingBox() [2/2]

const Dtk_Oriented2dBBox& Dtk_Text::GetOuterBoundingBox ( ) const

Processes the outer bounding box.

Returns: The outer bounding box

◆ GetOuterRotationAngle()

Dtk_Double64 Dtk_Text::GetOuterRotationAngle	(	const Dtk_dir &	inXAxis = `Dtk_dir(1, 0, 0)`,
		const Dtk_dir &	inYAxis = `Dtk_dir(0, 1, 0)`
	)

Gets the outer bounding box rotation angle giving a reference base.

Parameters

inXAxis	The reference X Axis - default value = (1,0,0)
inYAxis	The reference Y Axis - default value = (0,1,0)

Returns: The rotation angle

See also: SetRotationAngle

◆ GetOuterXYAxis()

void Dtk_Text::GetOuterXYAxis	(	Dtk_dir &	outXAxis,
		Dtk_dir &	outYAxis
	)		const

Gets the outer bounding box orientation.

Parameters

outXAxis	The outer bounding box X Axis
outYAxis	The outer bounding box Y Axis

See also: SetOuterXYAxis

◆ InnerLocation() [1/2]

Dtk_pnt& Dtk_Text::InnerLocation ( )

Retrieves the inner bounding box location - get/set -.

Returns: The inner bounding box location

See also: InnerLocation() const

◆ InnerLocation() [2/2]

const Dtk_pnt& Dtk_Text::InnerLocation ( ) const

Retrieves the inner bounding box location - read only -.

Returns: The inner bounding box location

See also: InnerLocation()

◆ InnerTranslate()

Dtk_ErrorStatus Dtk_Text::InnerTranslate ( const Dtk_dir & inTranslateDir )

Translates the inner bounding box giving a translation vector.

Parameters

inTranslateDir the translation vector

Returns: dtkNoError if OK

◆ InnerXAxis() [1/2]

Dtk_dir& Dtk_Text::InnerXAxis ( )

Retrieves the inner bounding box XAxis - get/set -.

Returns: The inner bounding box XAxis

See also: InnerXAxis() const

◆ InnerXAxis() [2/2]

const Dtk_dir& Dtk_Text::InnerXAxis ( ) const

Retrieves the inner bounding box XAxis - read only -.

Returns: The inner bounding box XAxis

See also: InnerXAxis()

◆ InnerYAxis() [1/2]

Dtk_dir& Dtk_Text::InnerYAxis ( )

Retrieves the inner bounding box YAxis - get/set -.

Returns: The inner bounding box YAxis

See also: InnerYAxis() const

◆ InnerYAxis() [2/2]

const Dtk_dir& Dtk_Text::InnerYAxis ( ) const

Retrieves the inner bounding box YAxis - read only -.

Returns: The inner bounding box YAxis

See also: InnerYAxis()

◆ IsEmpty()

Dtk_bool Dtk_Text::IsEmpty ( ) const

Tells if the Dtk_Text is empty or not - read only -.

Returns: DTK_TRUE if the Dtk_text is empty or DTK_FALSE else.

Remarks: This method internally checks the string of the Dtk_text. If the string length is == 0 so the Dtk_text is empty.

◆ operator=() [1/2]

Dtk_Text& Dtk_Text::operator= ( const Dtk_Text & inToBeAssigned )

Assignment Operator.

Parameters

inTobeAssigned Object to copy.

◆ operator=() [2/2]

Dtk_Text& Dtk_Text::operator= ( Dtk_Text && s )

◆ OuterLocation() [1/2]

Dtk_pnt& Dtk_Text::OuterLocation ( )

Retrieves the outer bounding box location - get/set -.

Returns: The outer bounding box location

See also: OuterLocation() const

◆ OuterLocation() [2/2]

const Dtk_pnt& Dtk_Text::OuterLocation ( ) const

Retrieves the outer bounding box location - read only -.

Returns: The outer bounding box location

See also: OuterLocation()

◆ OuterTranslate()

Dtk_ErrorStatus Dtk_Text::OuterTranslate ( const Dtk_dir & inTranslateDir )

Translates the outer bounding box giving a translation vector.

Parameters

inTranslateDir the translation vector

Returns: dtkNoError if OK

◆ OuterXAxis() [1/2]

Dtk_dir& Dtk_Text::OuterXAxis ( )

Retrieves the outer bounding box XAxis - get/set -.

Returns: The outer bounding box XAxis

See also: OuterXAxis() const

◆ OuterXAxis() [2/2]

const Dtk_dir& Dtk_Text::OuterXAxis ( ) const

Retrieves the outer bounding box XAxis - read only -.

Returns: The outer bounding box XAxis

See also: OuterXAxis()

◆ OuterYAxis() [1/2]

Dtk_dir& Dtk_Text::OuterYAxis ( )

Retrieves the outer bounding box YAxis - get/set -.

Returns: The outer bounding box YAxis

See also: OuterYAxis() const

◆ OuterYAxis() [2/2]

const Dtk_dir& Dtk_Text::OuterYAxis ( ) const

Retrieves the outer bounding box YAxis - read only -.

Returns: The outer bounding box YAxis

See also: OuterYAxis()

◆ ProcessBottomLeftAnchorPoint()

Dtk_pnt Dtk_Text::ProcessBottomLeftAnchorPoint ( ) const

Processes the bottom-left inner anchor point.

Returns: The bottom-left inner anchor point

◆ ProcessMirroringType()

MirroringTypeEnum Dtk_Text::ProcessMirroringType ( const Dtk_dir & inZAxis = Dtk_dir(0, 0, 1) ) const

Processes the mirroring type giving the reference Z Axis.

Parameters

inZAxis the reference Z Axis

Returns: The mirroring type

◆ ProcessRotationAngle()

Dtk_Double64 Dtk_Text::ProcessRotationAngle ( const Dtk_dir & inZAxis = Dtk_dir(0, 0, 1) ) const

Processes the inner bounding box rotation angle giving the reference Z Axis.

Parameters

inZAxis the reference Z Axis

Returns: The rotation angle

◆ ProcessTextNumLines()

Dtk_Int32 Dtk_Text::ProcessTextNumLines ( ) const

Processes the line feed number.

Returns: The line feed number

◆ Reverse()

Dtk_ErrorStatus Dtk_Text::Reverse ( )

Reverses the text The text anchor type is replaced by the opposed one and the text orientation is reversed.

Returns: dtkNoError if OK

◆ SetAsDeprecated()

Dtk_Text::SetAsDeprecated	(	"2020.2"	,
		"Use CreateFrameAsGeometry( Dtk_tab<Dtk_CurvePtr> &outGeoms) instead"
	)		const &

OBSOLETE Creates geometries corresponding to the text frame type.

Parameters

outGeoms the resulting geometries

Returns: dtkNoError if OK

◆ SetFrameType()

void Dtk_Text::SetFrameType	(	const Dtk_frame_type &	inFrameType,
		Dtk_tab< Dtk_CurvePtr >	inRelatedGeomElements
	)

Set the text frame information - get/set -.

Returns: The text frame type

See also: FrameType() const

◆ SetInnerAnchorPoint()

Dtk_ErrorStatus Dtk_Text::SetInnerAnchorPoint	(	const Dtk_pnt &	inNewOrigin,
		const Dtk_anchor_type &	inLocationAnchorType
	)

Set the text inner anchor point.

Deprecated:: Use SetInnerBoundingBox() const function instead.

Parameters

inNewOrigin	the new location point
inLocationAnchorType	the new location anchor type

Returns: dtkNoError if OK

◆ SetInnerAnchorPointWithTranslation()

Dtk_ErrorStatus Dtk_Text::SetInnerAnchorPointWithTranslation	(	const Dtk_pnt &	new_origin,
		const Dtk_anchor_type	location_anchor_type
	)

◆ SetInnerBoundingBox()

Dtk_ErrorStatus Dtk_Text::SetInnerBoundingBox ( const Dtk_Oriented2dBBox & innerBoundingBox )

Sets the inner bounding box.

◆ SetInnerRotationAngle()

Dtk_ErrorStatus Dtk_Text::SetInnerRotationAngle	(	const Dtk_Double64 &	inRotationAngle,
		const Dtk_dir &	inXAxis = `Dtk_dir(1, 0, 0)`,
		const Dtk_dir &	inYAxis = `Dtk_dir(0, 1, 0)`
	)

Sets the inner bounding box rotation angle giving a reference base.

Parameters

inRotationAngle	The rotation angle to be set
inXAxis	The reference X Axis - default value = (1,0,0)
inYAxis	The reference Y Axis - default value = (0,1,0)

Returns: dtkNoError if OK

See also: GetRotationAngle

◆ SetInnerXLength()

void Dtk_Text::SetInnerXLength ( const Dtk_Double64 & inXLength )

Sets the inner bounding box X length.

Parameters

inXLength The new inner bounding box X length

See also: GetInnerBoundingBox

◆ SetInnerXYAxis()

void Dtk_Text::SetInnerXYAxis	(	const Dtk_dir &	inXAxis,
		const Dtk_dir &	inYAxis
	)

Sets the inner bounding box orientation.

Parameters

inXAxis	The new inner bounding box X Axis
inYAxis	The new inner bounding box Y Axis

See also: GetInnerXYAxis

◆ SetInnerYLength()

void Dtk_Text::SetInnerYLength ( const Dtk_Double64 & inYLength )

Sets the inner bounding box Y length.

Parameters

inXLength The new inner bounding box Y length

See also: GetInnerBoundingBox

◆ SetOuterAnchorPoint()

Dtk_ErrorStatus Dtk_Text::SetOuterAnchorPoint	(	const Dtk_pnt &	inNewOrigin,
		const Dtk_anchor_type &	inLocationAnchorType
	)

Set the text outer anchor point.

Parameters

inNewOrigin	the new location point
inLocationAnchorType	the new location anchor type

Returns: dtkNoError if OK

◆ SetOuterAnchorPointWithTranslation()

Dtk_ErrorStatus Dtk_Text::SetOuterAnchorPointWithTranslation	(	const Dtk_pnt &	new_origin,
		const Dtk_anchor_type	location_anchor_type
	)

◆ SetOuterBoundingBox()

Dtk_ErrorStatus Dtk_Text::SetOuterBoundingBox ( const Dtk_Oriented2dBBox & outerBoundingBox )

Sets the outer bounding box.

◆ SetOuterRotationAngle()

Dtk_ErrorStatus Dtk_Text::SetOuterRotationAngle	(	const Dtk_Double64 &	inRotationAngle,
		const Dtk_dir &	inXAxis = `Dtk_dir(1, 0, 0)`,
		const Dtk_dir &	inYAxis = `Dtk_dir(0, 1, 0)`
	)

Sets the outer bounding box rotation angle giving a reference base.

Parameters

inRotationAngle	The rotation angle to be set
inXAxis	The reference X Axis - default value = (1,0,0)
inYAxis	The reference Y Axis - default value = (0,1,0)

Returns: dtkNoError if OK

See also: GetRotationAngle

◆ SetOuterXLength()

void Dtk_Text::SetOuterXLength ( const Dtk_Double64 & inXLength )

Sets the outer bounding box X length.

Parameters

inXLength The new outer bounding box X length

See also: GetOuterBoundingBox

◆ SetOuterXYAxis()

void Dtk_Text::SetOuterXYAxis	(	const Dtk_dir &	inXAxis,
		const Dtk_dir &	inYAxis
	)

Sets the outer bounding box orientation.

Parameters

inXAxis	The new outer bounding box X Axis
inYAxis	The new outer bounding box Y Axis

See also: GetOuterXYAxis

◆ SetOuterYLength()

void Dtk_Text::SetOuterYLength ( const Dtk_Double64 & inYLength )

Sets the outer bounding box Y length.

Parameters

inXLength The new outer bounding box Y length

See also: GetOuterBoundingBox

◆ SetVerticallyOrientedStatus()

Dtk_ErrorStatus Dtk_Text::SetVerticallyOrientedStatus ( const Dtk_bool & inVerticallyOrientedStatus )

Sets the text vertically oriented status.

Returns: The text vertically oriented status - DTK_TRUE for vertically oriented text -

See also: VerticallyOrientedStatus() const

◆ Text() [1/2]

Dtk_string& Dtk_Text::Text ( )

Retrieves the text string - get/set -.

Returns: The text string

See also: Text() const

◆ Text() [2/2]

const Dtk_string& Dtk_Text::Text ( ) const

Retrieves the text string - read only -.

Returns: The text string

See also: Text()

◆ TextStyle() [1/2]

Dtk_TextStyle& Dtk_Text::TextStyle ( )

Retrieves the text text style - get/set -.

Returns: The text text style

See also: TextStyle() const

◆ TextStyle() [2/2]

const Dtk_TextStyle& Dtk_Text::TextStyle ( ) const

Retrieves the text text style - read only -.

Returns: The text text style

See also: TextStyle()

◆ TextSubType() [1/2]

DTK_Text_subtype& Dtk_Text::TextSubType ( )

Retrieves the text subtype - get/set -.

Returns: The text subtype

See also: TextType() const

◆ TextSubType() [2/2]

const DTK_Text_subtype& Dtk_Text::TextSubType ( ) const

Retrieves the text subtype - read only -.

Returns: The text subtype

See also: TextType()

◆ TextType() [1/2]

DTK_Text_type& Dtk_Text::TextType ( )

Retrieves the text type - get/set -.

Returns: The text type

See also: TextType() const

◆ TextType() [2/2]

const DTK_Text_type& Dtk_Text::TextType ( ) const

Retrieves the text type - read only -.

Returns: The text type

See also: TextType()

◆ Transform()

Dtk_ErrorStatus Dtk_Text::Transform ( const Dtk_transfo & inTransfo )

Applies a transformation matrix to the text.

Parameters

inTransfo The transformation matrix

Returns: dtkNoError if OK

◆ Translate()

Dtk_ErrorStatus Dtk_Text::Translate ( const Dtk_dir & inTranslateDir )

Translates the text giving a translation vector.

Parameters

inTranslateDir the translation vector

Returns: dtkNoError if OK

◆ VerticallyOrientedStatus()

const Dtk_bool& Dtk_Text::VerticallyOrientedStatus ( ) const

Retrieves the text vertically oriented Status - read only -.

Returns: The text vertically oriented status - DTK_TRUE for vertically oriented text -

See also: VerticallyOrientedStatus()

Friends And Related Function Documentation

◆ operator+

Dtk_CompositeText operator+	(	const Dtk_Text &	s1,
		const Dtk_Text &	s2
	)

friend

◆ operator<<

std::ostream& operator<<	(	std::ostream &	o,
		const Dtk_Text &	d
	)

friend

Field Documentation

◆ _Private

Dtk_Handle* Dtk_Text::_Private

protected

Public Types

Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ MirroringTypeEnum

Constructor & Destructor Documentation

◆ ~Dtk_Text()

◆ Dtk_Text() [1/5]

◆ Dtk_Text() [2/5]

◆ Dtk_Text() [3/5]

◆ Dtk_Text() [4/5]

◆ Dtk_Text() [5/5]

Member Function Documentation

◆ AnchorType() [1/2]

◆ AnchorType() [2/2]

◆ ConvertToText_or_character()

◆ CreateFrameAsGeometry()

◆ ExplodeText()

◆ FrameType()

◆ GetFrame()

◆ GetInfo() [1/2]

◆ GetInfo() [2/2]

◆ GetInnerBoundingBox() [1/2]

◆ GetInnerBoundingBox() [2/2]

◆ GetInnerRotationAngle()

◆ GetInnerXYAxis()

◆ GetOuterBoundingBox() [1/2]

◆ GetOuterBoundingBox() [2/2]

◆ GetOuterRotationAngle()

◆ GetOuterXYAxis()

◆ InnerLocation() [1/2]

◆ InnerLocation() [2/2]

◆ InnerTranslate()

◆ InnerXAxis() [1/2]

◆ InnerXAxis() [2/2]

◆ InnerYAxis() [1/2]

◆ InnerYAxis() [2/2]

◆ IsEmpty()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ OuterLocation() [1/2]

◆ OuterLocation() [2/2]

◆ OuterTranslate()

◆ OuterXAxis() [1/2]

◆ OuterXAxis() [2/2]

◆ OuterYAxis() [1/2]

◆ OuterYAxis() [2/2]

◆ ProcessBottomLeftAnchorPoint()

◆ ProcessMirroringType()

◆ ProcessRotationAngle()

◆ ProcessTextNumLines()

◆ Reverse()

◆ SetAsDeprecated()

◆ SetFrameType()

◆ SetInnerAnchorPoint()

◆ SetInnerAnchorPointWithTranslation()

◆ SetInnerBoundingBox()

◆ SetInnerRotationAngle()

◆ SetInnerXLength()

◆ SetInnerXYAxis()

◆ SetInnerYLength()

◆ SetOuterAnchorPoint()

◆ SetOuterAnchorPointWithTranslation()

◆ SetOuterBoundingBox()

◆ SetOuterRotationAngle()

◆ SetOuterXLength()

◆ SetOuterXYAxis()

◆ SetOuterYLength()

◆ SetVerticallyOrientedStatus()

◆ Text() [1/2]

◆ Text() [2/2]

◆ TextStyle() [1/2]

◆ TextStyle() [2/2]

◆ TextSubType() [1/2]

◆ TextSubType() [2/2]

◆ TextType() [1/2]

◆ TextType() [2/2]

◆ Transform()