临时文本类更多...

#include <Display_TransientText.hxx>

类 NXOpen::Display::TransientText 继承关系图:

Public 成员函数
void	AddTextString (const char *textString)
void	AddTextString (const NXString &textString)
int	Color ()
void	DisplayTemporaryAbsoluteGeometry (int fontIndex, NXOpen::View view, NXOpen::Display::TransientText::ViewType viewType, NXOpen::DisplayableObject object, const NXOpen::Point3d &position)
void	DisplayTemporaryAbsRotScreenSizeGeometry (int fontIndex, NXOpen::View view, NXOpen::Display::TransientText::ViewType viewType, NXOpen::DisplayableObject object, const NXOpen::Point3d &position)
void	DisplayTemporaryScreenGeometry (int fontIndex, NXOpen::View view, NXOpen::Display::TransientText::ViewType viewType, NXOpen::DisplayableObject object, const NXOpen::Point3d &position)
NXString	FontStyle ()
void	GetAbsoluteTextSize (double glyphWidth, double glyphHeight)
NXOpen::Display::TransientText::StandardTextRef	ReferencePositionType ()
NXOpen::Display::TransientText::TextSize	ScreenTextSize ()
void	SetAbsoluteTextSize (double glyphWidth, double glyphHeight)
void	SetColor (int colorIndex)
void	SetFontStyle (const char *fontStyle)
void	SetFontStyle (const NXString &fontStyle)
void	SetReferencePositionType (NXOpen::Display::TransientText::StandardTextRef referencePositionType)
void	SetScreenTextSize (NXOpen::Display::TransientText::TextSize textSize)
virtual	~TransientText ()
Public 成员函数继承自 NXOpen::TransientObject
void *	GetHandle ()

详细描述

临时文本类

表示可用于临时显示的临时文本字符串
创建于NX8.0.0。

成员枚举类型说明

◆ StandardTextRef

enum NXOpen::Display::TransientText::StandardTextRef

此枚举类型指定standard_text方法中文本框使用的参考点类型。

枚举值
StandardTextRefSystemDefault	使用系统默认参考点位置显示文本
StandardTextRefBaselineStart	文本从基线开始显示，左右文本在文本框左端，右左文本在文本框右端
StandardTextRefBaselineCenter	给定位置位于文本框水平中心的基线处来显示文本
StandardTextRefBaselineEnd	文本从基线开始显示，左右文本在文本框右端，右左文本在文本框左端
StandardTextRefTopLeft	给定位置位于文本框左上角来显示文本
StandardTextRefTopCenter	给定位置位于文本框顶部中心来显示文本
StandardTextRefTopRight	给定位置位于文本框右上角来显示文本
StandardTextRefMiddleLeft	给定位置位于文本框左侧中部来显示文本
StandardTextRefMiddleCenter	给定位置位于文本框中心来显示文本
StandardTextRefMiddleRight	给定位置位于文本框右侧中部来显示文本
StandardTextRefBottomLeft	给定位置位于文本框左下角来显示文本
StandardTextRefBottomCenter	给定位置位于文本框底部中心来显示文本
StandardTextRefBottomRight	给定位置位于文本框右下角来显示文本

◆ TextSize

enum NXOpen::Display::TransientText::TextSize

用于指定所需文本的大小：小、中或大（normal是medium的同义词）。

枚举值
TextSizeSmall	小
TextSizeNormal	常规
TextSizeMedium	中等
TextSizeLarge	大
TextSizeNumSizes	尺寸数量

◆ ViewType

enum NXOpen::Display::TransientText::ViewType

要显示临时文本的一个或多个视图。注意仅当视图属性非空时，此属性才会被使用。

枚举值
ViewTypeWorkViewOnly	仅工作视图
ViewTypeAllActiveViews	所有活动视图
ViewTypeViewOfLastCursor	最后光标所在视图
ViewTypeAllViewsButDrawing	除工程图外的所有视图
ViewTypeAllActiveMemberViews	所有活动成员视图
ViewTypeFirstViewFound	第一个找到的视图

构造及析构函数说明

◆ ~TransientText()

virtual NXOpen::Display::TransientText::~TransientText ( )

virtual

从内存中释放对象。调用此方法后，该对象将不可再使用。在.NET中，当垃圾回收器删除对象时会自动调用此方法。
创建于NX8.0.0。

许可要求 : 无

成员函数说明

◆ AddTextString() [1/2]

void NXOpen::Display::TransientText::AddTextString ( const char * textString )

向TransientText对象添加文本字符串。一个TransientText对象可包含一个或多个文本字符串。如果尝试显示不包含任何文本字符串的TransientText对象，将返回错误。
创建于NX8.0.0。

许可要求 : 无

参数

textString 文本字符串

◆ AddTextString() [2/2]

void NXOpen::Display::TransientText::AddTextString ( const NXString & textString )

向TransientText对象添加文本字符串。一个TransientText对象可包含一个或多个文本字符串。如果尝试显示不包含任何文本字符串的TransientText对象，将返回错误。
创建于NX8.0.0。

许可要求 : 无

参数

textString 文本字符串

◆ Color()

int NXOpen::Display::TransientText::Color ( )

获取用于显示临时文本的颜色索引。若未指定，将使用系统颜色。
创建于NX8.0.0。

许可要求：无

◆ DisplayTemporaryAbsoluteGeometry()

void NXOpen::Display::TransientText::DisplayTemporaryAbsoluteGeometry	(	int	fontIndex,
		NXOpen::View *	view,
		NXOpen::Display::TransientText::ViewType	viewType,
		NXOpen::DisplayableObject *	object,
		const NXOpen::Point3d &	position )

使用绝对坐标系临时显示文本。调用此方法前请确保已设置所有必要属性。注意文本将显示在绝对XY平面上，因此会随视图方向变化而旋转。在某些视图方向下，文本可能会显示为倒置或反向。尺寸以显示部件的单位表示。请参考Display::TransientText::SetAbsoluteTextSize 了解如何设置文本尺寸。注意文本的显示大小取决于视图比例，因此修改视图比例时，文本在屏幕上会显示得更大或更小。
创建于NX8.0.0。

许可要求 : 无

参数

fontIndex	要使用的字体索引。可以为0，表示使用默认字体。
view	用于显示文本的视图。可以为NULL，此时将使用viewType参数。
viewType	仅当view为NULL时使用。
object	可以为NULL，此时将在指定位置绘制文本。不为NULL时，将在对象的关注点绘制文本。
position	绝对坐标系下的位置

◆ DisplayTemporaryAbsRotScreenSizeGeometry()

void NXOpen::Display::TransientText::DisplayTemporaryAbsRotScreenSizeGeometry	(	int	fontIndex,
		NXOpen::View *	view,
		NXOpen::Display::TransientText::ViewType	viewType,
		NXOpen::DisplayableObject *	object,
		const NXOpen::Point3d &	position )

使用屏幕坐标系临时显示文本。文本将显示在绝对坐标系的XY平面上。调用此方法前请确保已设置所有必要属性。此方法不支持CGM等2D输出。注意文本大小固定，不会随视图缩放而变化。请参考 Display::TransientText::set_ScreenTextSize 了解如何设置所需尺寸。另外需要注意，默认情况下，如果有必要，此屏幕尺寸的文本会在其边界框内"翻转"，以确保文本保持可读（面向前方且大致直立）。
创建于NX8.0.0。

许可要求 : 无

参数

fontIndex	要使用的字体索引。可以为0，表示使用默认字体。
view	用于显示文本的视图。可以为NULL，此时将使用viewType参数。
viewType	仅当view为NULL时使用。
object	可以为NULL，此时将在指定位置绘制文本。不为NULL时，将在对象的关注点绘制文本。
position	绝对坐标系下的位置

◆ DisplayTemporaryScreenGeometry()

void NXOpen::Display::TransientText::DisplayTemporaryScreenGeometry	(	int	fontIndex,
		NXOpen::View *	view,
		NXOpen::Display::TransientText::ViewType	viewType,
		NXOpen::DisplayableObject *	object,
		const NXOpen::Point3d &	position )

使用屏幕坐标系临时显示文本。调用此方法前请确保已设置所有必要属性。此方法不支持CGM等2D输出。请参考 Display::TransientText::set_ScreenTextSize 了解如何调整文本尺寸。注意显示的文本始终与屏幕平行且面向前方，无论视图方向或比例如何变化，显示大小保持不变。
创建于NX8.0.0。

许可要求 : 无

参数

fontIndex	要使用的字体索引。可以为0，表示使用默认字体。
view	用于显示文本的视图。可以为NULL，此时将使用viewType参数。
viewType	仅当view为NULL时使用。
object	可以为NULL，此时将在指定位置绘制文本。不为NULL时，将在对象的关注点绘制文本。
position	绝对坐标系下的位置

◆ FontStyle()

NXString NXOpen::Display::TransientText::FontStyle ( )

获取用于显示临时文本的字体样式。每种字体至少有一种样式。要确定某字体有哪些样式，请使用UF_UGFONT_ask_font_styles。如果未指定，将使用该字体的默认样式。
创建于NX8.0.0。

许可要求 : 无

◆ GetAbsoluteTextSize()

void NXOpen::Display::TransientText::GetAbsoluteTextSize	(	double *	glyphWidth,
		double *	glyphHeight )

获取文本的绝对坐标尺寸，单位为显示零件的单位。该值仅被Display::TransientText::DisplayTemporaryAbsoluteGeometry 使用。
创建于NX8.0.0。

许可要求：无

参数

glyphWidth	字符宽度
glyphHeight	字符高度

◆ ReferencePositionType()

NXOpen::Display::TransientText::StandardTextRef NXOpen::Display::TransientText::ReferencePositionType ( )

获取文本相对于文本框的位置
创建于NX8.0.0。

许可要求：无

◆ ScreenTextSize()

NXOpen::Display::TransientText::TextSize NXOpen::Display::TransientText::ScreenTextSize ( )

获取文本在图形屏幕上的近似尺寸（小、中、大）。此属性不被Display::TransientText::DisplayTemporaryAbsoluteGeometry 使用。
创建于NX8.0.0。

许可要求：无

◆ SetAbsoluteTextSize()

void NXOpen::Display::TransientText::SetAbsoluteTextSize	(	double	glyphWidth,
		double	glyphHeight )

设置文本的绝对坐标尺寸，单位为显示零件的单位。该值仅被Display::TransientText::DisplayTemporaryAbsoluteGeometry 使用。
创建于NX8.0.0。

许可要求：无

参数

glyphWidth	字符宽度
glyphHeight	字符高度

◆ SetColor()

void NXOpen::Display::TransientText::SetColor ( int colorIndex )

设置用于显示临时文本的颜色索引。若未指定，将使用系统颜色。
创建于NX8.0.0。

许可要求：无

参数

colorIndex 颜色索引

◆ SetFontStyle() [1/2]

void NXOpen::Display::TransientText::SetFontStyle ( const char * fontStyle )

设置用于显示临时文本的字体样式。每种字体至少有一种样式。可使用UF_UGFONT_ask_font_styles查询字体支持的样式。若未指定，将使用该字体的默认样式。
创建于NX8.0.0。

许可要求：无

参数

fontStyle 字体样式

◆ SetFontStyle() [2/2]

void NXOpen::Display::TransientText::SetFontStyle ( const NXString & fontStyle )

设置用于显示临时文本的字体样式。每种字体至少有一种样式。可使用UF_UGFONT_ask_font_styles查询字体支持的样式。若未指定，将使用该字体的默认样式。
创建于NX8.0.0。

许可要求：无

参数

fontStyle 字体样式

◆ SetReferencePositionType()

void NXOpen::Display::TransientText::SetReferencePositionType ( NXOpen::Display::TransientText::StandardTextRef referencePositionType )

设置文本相对于文本框的位置
创建于NX8.0.0。

许可要求：无

参数

referencePositionType 参考位置类型

◆ SetScreenTextSize()

void NXOpen::Display::TransientText::SetScreenTextSize ( NXOpen::Display::TransientText::TextSize textSize )

设置文本在图形屏幕上的近似尺寸（小、中、大）。此属性不被Display::TransientText::DisplayTemporaryAbsoluteGeometry 使用。
创建于NX8.0.0。

许可要求：无

参数

textSize 文本尺寸

Public 类型
enum	StandardTextRef { StandardTextRefSystemDefault , StandardTextRefBaselineStart = 0 , StandardTextRefBaselineCenter , StandardTextRefBaselineEnd , StandardTextRefTopLeft , StandardTextRefTopCenter , StandardTextRefTopRight , StandardTextRefMiddleLeft , StandardTextRefMiddleCenter , StandardTextRefMiddleRight , StandardTextRefBottomLeft , StandardTextRefBottomCenter , StandardTextRefBottomRight }
enum	TextSize { TextSizeSmall , TextSizeNormal , TextSizeMedium = 1 , TextSizeLarge , TextSizeNumSizes }
enum	ViewType { ViewTypeWorkViewOnly , ViewTypeAllActiveViews , ViewTypeViewOfLastCursor , ViewTypeAllViewsButDrawing , ViewTypeAllActiveMemberViews , ViewTypeFirstViewFound }

Public 类型

Public 成员函数

详细描述

成员枚举类型说明

◆ StandardTextRef

◆ TextSize

◆ ViewType

构造及析构函数说明

◆ ~TransientText()

成员函数说明

◆ AddTextString() [1/2]

◆ AddTextString() [2/2]

◆ Color()

◆ DisplayTemporaryAbsoluteGeometry()

◆ DisplayTemporaryAbsRotScreenSizeGeometry()

◆ DisplayTemporaryScreenGeometry()

◆ FontStyle()

◆ GetAbsoluteTextSize()

◆ ReferencePositionType()

◆ ScreenTextSize()

◆ SetAbsoluteTextSize()

◆ SetColor()

◆ SetFontStyle() [1/2]

◆ SetFontStyle() [2/2]

◆ SetReferencePositionType()

◆ SetScreenTextSize()