Represents temporary text strings which can be used for Temporary Display
Created in NX8.0.0. More...

Inheritance diagram for NXOpen::Display::TransientText:

Public Types
enum	StandardTextRef { StandardTextRefSystemDefault, StandardTextRefBaselineStart = 0, StandardTextRefBaselineCenter, StandardTextRefBaselineEnd, StandardTextRefTopLeft, StandardTextRefTopCenter, StandardTextRefTopRight, StandardTextRefMiddleLeft, StandardTextRefMiddleCenter, StandardTextRefMiddleRight, StandardTextRefBottomLeft, StandardTextRefBottomCenter, StandardTextRefBottomRight }
	This enumerated type specifies the type of reference point used in the text box for standard_text methods. More...

enum	TextSize { TextSizeSmall, TextSizeNormal, TextSizeMedium = 1, TextSizeLarge, TextSizeNumSizes }
	Provides a way to specify the size of the desired text, as small, medium or large (normal is a synonym for medium). More...

enum	ViewType { ViewTypeWorkViewOnly, ViewTypeAllActiveViews, ViewTypeViewOfLastCursor, ViewTypeAllViewsButDrawing, ViewTypeAllActiveMemberViews, ViewTypeFirstViewFound }
	the view or views in which the transient text is to be displayed. More...

Public Member Functions
void	AddTextString (const NXString &textString)
	Adds a text string to the TransientText object. More...

void	AddTextString (const char *textString)
	Adds a text string to the TransientText object. More...

int	Color ()
	Returns the index of the color to be used to display the transient text. More...

void	DisplayTemporaryAbsoluteGeometry (int fontIndex, NXOpen::View view, NXOpen::Display::TransientText::ViewType viewType, NXOpen::DisplayableObject object, const NXOpen::Point3d &position)
	Displays text as temporary display using absolute geometry. More...

void	DisplayTemporaryAbsRotScreenSizeGeometry (int fontIndex, NXOpen::View view, NXOpen::Display::TransientText::ViewType viewType, NXOpen::DisplayableObject object, const NXOpen::Point3d &position)
	Displays text as temporary display using screen geometry but with rotation defined in absolute space. More...

void	DisplayTemporaryScreenGeometry (int fontIndex, NXOpen::View view, NXOpen::Display::TransientText::ViewType viewType, NXOpen::DisplayableObject object, const NXOpen::Point3d &position)
	Displays text as temporary display using screen geometry. More...

NXString	FontStyle ()
	Returns the style of font to be used to display the transient text. More...

void	GetAbsoluteTextSize (double glyphWidth, double glyphHeight)
	Returns the size of the text, in absolute coordinate, in units of the displayed part. More...

NXOpen::Display::TransientText::StandardTextRef	ReferencePositionType ()
	Returns the position of the text relative to positions on the text box Created in NX8.0.0. More...

NXOpen::Display::TransientText::TextSize	ScreenTextSize ()
	Returns the approximate size of the text (small, mendium, large) as measured on the graphics screen. More...

void	SetAbsoluteTextSize (double glyphWidth, double glyphHeight)
	Sets the size of the text, in absolute coordinates, in units of the displayed part. More...

void	SetColor (int colorIndex)
	Sets the index of the color to be used to display the transient text. More...

void	SetFontStyle (const NXString &fontStyle)
	Sets the style of font to be used to display the transient text. More...

void	SetFontStyle (const char *fontStyle)
	Sets the style of font to be used to display the transient text. More...

void	SetReferencePositionType (NXOpen::Display::TransientText::StandardTextRef referencePositionType)
	Sets the position of the text relative to positions on the text box Created in NX8.0.0. More...

void	SetScreenTextSize (NXOpen::Display::TransientText::TextSize textSize)
	Sets the approximate size of the text (small, mendium, large) as measured on the graphics screen. More...

virtual	~TransientText ()
	Frees the object from memory. More...

Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object. More...

Detailed Description

Represents temporary text strings which can be used for Temporary Display
Created in NX8.0.0.

Member Enumeration Documentation

enum NXOpen::Display::TransientText::StandardTextRef

This enumerated type specifies the type of reference point used in the text box for standard_text methods.

Enumerator
StandardTextRefSystemDefault	Display the text using the system default reference point position.
StandardTextRefBaselineStart	Display the text starting on the baseline, at the left end of the text box for left-to-right text, or at the right end of the text box for right-to-left text.
StandardTextRefBaselineCenter	Display the text with the given position in the horizontal center of the text box at the baseline.
StandardTextRefBaselineEnd	Display the text starting on the baseline, at the right end of the text box for left-to-right text, or at the left end of the text box for right-to-left text.
StandardTextRefTopLeft	Display the text with the given position in the top left of the text box.
StandardTextRefTopCenter	Display the text with the given position in the top center of the text box.
StandardTextRefTopRight	Display the text with the given position in the top right of the text box.
StandardTextRefMiddleLeft	Display the text with the given position in the middle left of the text box.
StandardTextRefMiddleCenter	Display the text with the given position in middle center of text box.
StandardTextRefMiddleRight	Display the text with the given position in middle right of text box.
StandardTextRefBottomLeft	Display the text with the given position in bottom left of text box.
StandardTextRefBottomCenter	Display the text with the given position in bottom center of text box.
StandardTextRefBottomRight	Display the text with the given position in bottom right of text box.

enum NXOpen::Display::TransientText::TextSize

Provides a way to specify the size of the desired text, as small, medium or large (normal is a synonym for medium).

Enumerator
TextSizeSmall	small
TextSizeNormal	normal
TextSizeMedium	medium
TextSizeLarge	large
TextSizeNumSizes	num sizes

enum NXOpen::Display::TransientText::ViewType

the view or views in which the transient text is to be displayed.

Note that this property is only used when the view property is other than NULL.

Enumerator
ViewTypeWorkViewOnly	work view only
ViewTypeAllActiveViews	all active views
ViewTypeViewOfLastCursor	view of last cursor
ViewTypeAllViewsButDrawing	all views but drawing
ViewTypeAllActiveMemberViews	all active member views
ViewTypeFirstViewFound	first view found

Constructor & Destructor Documentation

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

virtual

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Created in NX8.0.0.

License requirements : None

Member Function Documentation

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

Adds a text string to the TransientText object.

A TransientText object may have one or more text strings. If an attempt is made to display a TransientText object with zero text strings, an error will be returned.
Created in NX8.0.0.

License requirements : None

Parameters

textString textstring

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

Adds a text string to the TransientText object.

A TransientText object may have one or more text strings. If an attempt is made to display a TransientText object with zero text strings, an error will be returned.
Created in NX8.0.0.

License requirements : None

Parameters

textString textstring

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

Returns the index of the color to be used to display the transient text.

If not specified, the System Color will be used.
Created in NX8.0.0.

License requirements : None

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

Displays text as temporary display using absolute geometry.

Insure that you have set all needed properties before using this method. Note that the text will be displayed on the Absolute XY plane.
Created in NX8.0.0.

License requirements : None

Parameters

fontIndex	The index of the font to be used. This may be 0, which means to use the default font.
view	The view in which to display the text. This may be NULL, in which case the viewType argument is used.
viewType	Used only when view is NULL.
object	May be NULL, in which case the text will be drawn at the given position. If not NULL, draw the text at the attention point of object.
position	In Absolute Coordinates

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

Displays text as temporary display using screen geometry but with rotation defined in absolute space.

The text will be displayed on the XY plane of the absolute coordinate system. Insure that you have set all needed properties before using this method. This method is not supported for 2D output such as CGM.
Created in NX8.0.0.

License requirements : None

Parameters

fontIndex	The index of the font to be used. This may be 0, which means to use the default font.
view	The view in which to display the text. This may be NULL, in which case the viewType argument is used.
viewType	Used only when view is NULL.
object	May be NULL, in which case the text will be drawn at the given position. If not NULL, draw the text at the attention point of object.
position	In Absolute Coordinates

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

Displays text as temporary display using screen geometry.

Insure that you have set all needed properties before using this method. This method is not supported for 2D output such as CGM. Note that the text will be displayed on the Absolute XY plane.
Created in NX8.0.0.

License requirements : None

Parameters

fontIndex	The index of the font to be used. This may be 0, which means to use the default font.
view	The view in which to display the text. This may be NULL, in which case the viewType argument is used.
viewType	Used only when view is NULL.
object	May be NULL, in which case the text will be drawn at the given position. If not NULL, draw the text at the attention point of object.
position	In Absolute Coordinates

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

Returns the style of font to be used to display the transient text.

Every text font has at least one style. To determine which styles a font has, use UF_UGFONT_ask_font_styles. If not specified, the default font style for the font will be used.
Created in NX8.0.0.

License requirements : None

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

Returns the size of the text, in absolute coordinate, in units of the displayed part.

These values are only only used by Display::TransientText::DisplayTemporaryAbsoluteGeometry .
Created in NX8.0.0.

License requirements : None

Parameters

glyphWidth	glyphwidth
glyphHeight	glyphheight

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

Returns the position of the text relative to positions on the text box
Created in NX8.0.0.

License requirements : None

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

Returns the approximate size of the text (small, mendium, large) as measured on the graphics screen.

This property is not used by Display::TransientText::DisplayTemporaryAbsoluteGeometry .
Created in NX8.0.0.

License requirements : None

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

Sets the size of the text, in absolute coordinates, in units of the displayed part.

These values are only used by Display::TransientText::DisplayTemporaryAbsoluteGeometry .
Created in NX8.0.0.

License requirements : None

Parameters

glyphWidth	glyphwidth
glyphHeight	glyphheight

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

Sets the index of the color to be used to display the transient text.

If not specified, the System Color will be used.
Created in NX8.0.0.

License requirements : None

Parameters

colorIndex colorindex

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

Sets the style of font to be used to display the transient text.

Every text font has at least one style. To determine which styles a font has, use UF_UGFONT_ask_font_styles. If not specified, the default font style for the font will be used.
Created in NX8.0.0.

License requirements : None

Parameters

fontStyle fontstyle

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

Sets the style of font to be used to display the transient text.

Every text font has at least one style. To determine which styles a font has, use UF_UGFONT_ask_font_styles. If not specified, the default font style for the font will be used.
Created in NX8.0.0.

License requirements : None

Parameters

fontStyle fontstyle

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

Sets the position of the text relative to positions on the text box
Created in NX8.0.0.

License requirements : None

Parameters

referencePositionType referencepositiontype

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

Sets the approximate size of the text (small, mendium, large) as measured on the graphics screen.

This property is not used by Display::TransientText::DisplayTemporaryAbsoluteGeometry .
Created in NX8.0.0.

License requirements : None

Parameters

textSize textsize

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

Display_TransientText.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation