com.openinventor.meshviz.graph

Class PbMiscTextAttr

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.meshviz.graph.PbBase

com.openinventor.meshviz.graph.PbMiscTextAttr

All Implemented Interfaces:

java.lang.Cloneable

public class PbMiscTextAttr
extends PbBase
implements java.lang.Cloneable

Class to define a numeric display format. This class is used to define miscellaneous text attributes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PbMiscTextAttr.LineLength
static class	PbMiscTextAttr.LineLengths

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	LINE_LENGTH_MAX Deprecated. Use PbMiscTextAttr.LineLengths.LINE_LENGTH_MAX instead.
static int	LINE_LENGTH_MIN Deprecated. Use PbMiscTextAttr.LineLengths.LINE_LENGTH_MIN instead.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
PbMiscTextAttr()
PbMiscTextAttr(PbMiscTextAttr miscTextAttr)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
void	enablePredefinedProfile(boolean flag)
void	enableProfile(boolean flag)
java.lang.String	getFontName() Gets the font name for texts.
PbMiscTextAttr.LineLength	getLineLength() Gets line length attributes.
boolean	isPredefinedProfileEnabled() Enables/Disables the use of a predefined profile for 3D text if they are activated (cf enableProfile()).
boolean	isProfileEnabled() Enables/Disables the appearance of a profile for 3D Text.
void	setFontName(java.lang.String name) Sets the font name for texts.
void	setLineLength(byte endLineChar, int lineLength) Sets line length attributes.

Methods inherited from class com.openinventor.meshviz.graph.PbBase

enableConnection, isConnectionEnabled, touch

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LINE_LENGTH_MAX

@Deprecated
public static final int LINE_LENGTH_MAX

Deprecated. Use PbMiscTextAttr.LineLengths.LINE_LENGTH_MAX instead.

LINE_LENGTH_MIN

@Deprecated
public static final int LINE_LENGTH_MIN

Deprecated. Use PbMiscTextAttr.LineLengths.LINE_LENGTH_MIN instead.

Constructor Detail

PbMiscTextAttr

public PbMiscTextAttr()

PbMiscTextAttr

public PbMiscTextAttr(PbMiscTextAttr miscTextAttr)

Method Detail

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

getLineLength

public PbMiscTextAttr.LineLength getLineLength()

Gets line length attributes.

setFontName

public void setFontName(java.lang.String name)

Sets the font name for texts. The default font name is "defaultFont".

isProfileEnabled

public boolean isProfileEnabled()

Enables/Disables the appearance of a profile for 3D Text. Only SoText3 text takes into account of this option (cf PoBase.setTextType() and PoBase.setVRML2Mode()) to to select the type of text used). This option is disabled by default.

setLineLength

public void setLineLength(byte endLineChar,
                          int lineLength)

Sets line length attributes. lineLength is the max number of characters per line. If several endLineChar appear before the lineLength character, only the last endLineChar is taken into account. if lineLength = LINE_LENGTH_MAX, the lines length is not limited, and if lineLength = LINE_LENGTH_MIN, the lines are limited to one word. By default endLineChar is ' ' and lineLength is LINE_LENGTH_MAX.

Example of use with the string "United States of America" (24 characters) :

• with endLineChar = ' ' and lineLength = 15, the string is cut into two lines: "United States" and "of America".
• with endLineChar = ' ' and lineLength = 18, the string is cut into two lines: "United States of" and "America".

Be careful, words (consecutive characters delimited by endLineChar characters) are never truncated, so lines could exceed lineLength characters if the first word of the line contains more than lineLength characters.

enableProfile

public void enableProfile(boolean flag)

getFontName

public java.lang.String getFontName()

Gets the font name for texts.

isPredefinedProfileEnabled

public boolean isPredefinedProfileEnabled()

Enables/Disables the use of a predefined profile for 3D text if they are activated (cf enableProfile()). If this option is disabled, the current profile in the state is used (cf SoLinearProfile,...) This option is enabled by default.

enablePredefinedProfile

public void enablePredefinedProfile(boolean flag)