com.nutiteq.styles

Class TextStyle

java.lang.Object

com.nutiteq.styles.Style

com.nutiteq.styles.BillboardStyle

com.nutiteq.styles.LabelStyle

com.nutiteq.styles.TextStyle

public class TextStyle
extends LabelStyle

A style for text labels. Contains attributes for configuring how the text label is drawn on the screen.

Field Summary

Fields inherited from class com.nutiteq.styles.Style

swigCMemOwn

Constructor Summary

Constructors

Constructor and Description
TextStyle(Color color, float attachAnchorPointX, float attachAnchorPointY, boolean causesOverlap, boolean hideIfOverlapped, float horizontalOffset, float verticalOffset, int placementPriority, boolean scaleWithDPI, float anchorPointX, float anchorPointY, boolean flippable, BillboardOrientation orientationMode, BillboardScaling scalingMode, java.lang.String fontName, java.lang.String textField, int fontSize, Color strokeColor, float strokeWidth) Constructs a TextStyle object from various parameters.
TextStyle(long cPtr, boolean cMemoryOwn)

Method Summary

Modifier and Type	Method and Description
void	delete()
protected void	finalize()
static long	getCPtr(TextStyle obj)
Color	getFontColor() Returns the font's color.
java.lang.String	getFontName() Returns the font's name.
int	getFontSize() Returns the font's size.
Color	getStrokeColor() Returns the color of the stroke.
float	getStrokeWidth() Returns the width of the stroke.
java.lang.String	getTextField() Returns the text field variable to use.
static TextStyle	swigCreatePolymorphicInstance(long cPtr, boolean cMemoryOwn) Creates a polymorphic instance of the given native object.
java.lang.String	swigGetClassName() Returns the actual class name of this object.
java.lang.Object	swigGetDirectorObject() Returns the connected director object.

Methods inherited from class com.nutiteq.styles.LabelStyle

getAnchorPointX, getAnchorPointY, getCPtr, getOrientationMode, getScalingMode, isFlippable

Methods inherited from class com.nutiteq.styles.BillboardStyle

getAttachAnchorPointX, getAttachAnchorPointY, getCPtr, getHorizontalOffset, getPlacementPriority, getVerticalOffset, isCausesOverlap, isHideIfOverlapped, isScaleWithDPI

Methods inherited from class com.nutiteq.styles.Style

equals, getColor, getCPtr, hashCode

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextStyle

public TextStyle(long cPtr,
                 boolean cMemoryOwn)

TextStyle

public TextStyle(Color color,
                 float attachAnchorPointX,
                 float attachAnchorPointY,
                 boolean causesOverlap,
                 boolean hideIfOverlapped,
                 float horizontalOffset,
                 float verticalOffset,
                 int placementPriority,
                 boolean scaleWithDPI,
                 float anchorPointX,
                 float anchorPointY,
                 boolean flippable,
                 BillboardOrientation orientationMode,
                 BillboardScaling scalingMode,
                 java.lang.String fontName,
                 java.lang.String textField,
                 int fontSize,
                 Color strokeColor,
                 float strokeWidth)

Constructs a TextStyle object from various parameters. Instantiating the object directly is
not recommended, TextStyleBuilder should be used instead.

Parameters:

color - The color for the text.

attachAnchorPointX - The horizontal attaching anchor point.

attachAnchorPointY - The vertical attaching anchor point.

causesOverlap - The causes overlap flag for the billboard.

hideIfOverlapped - The hide if overlapped flag for the billboard.

horizontalOffset - The horizontal offset.

verticalOffset - The vertical offset.

placementPriority - The placement priority.

scaleWithDPI - The scale with DPI flag for the label.

anchorPointX - The horizontal anchor point.

anchorPointY - The vertical anchor point.

flippable - The fliappble flag.

orientationMode - The orientation mode.

scalingMode - The scaling mode.

fontName - The font's name.

textField - The text field variable to use.

fontSize - The font's size.

strokeColor - The width of the color.

strokeWidth - The width of the stroke.

Method Detail

getCPtr

public static long getCPtr(TextStyle obj)

finalize

protected void finalize()

Overrides:

finalize in class LabelStyle

delete

public void delete()

Overrides:

delete in class LabelStyle

swigCreatePolymorphicInstance

public static TextStyle swigCreatePolymorphicInstance(long cPtr,
                                                      boolean cMemoryOwn)

Creates a polymorphic instance of the given native object. This is used internally by the SDK.

getFontColor

public Color getFontColor()

Returns the font's color.

Returns:

The color of the font.

getFontName

public java.lang.String getFontName()

Returns the font's name.

Returns:

The platform dependent name of the font.

getTextField

public java.lang.String getTextField()

Returns the text field variable to use.

Returns:

The text field variable.

getFontSize

public int getFontSize()

Returns the font's size.

Returns:

The size of the font in points.

getStrokeColor

public Color getStrokeColor()

Returns the color of the stroke.

Returns:

The color of the stroke around the text.

getStrokeWidth

public float getStrokeWidth()

Returns the width of the stroke.

Returns:

The width of the stroke around the text.

swigGetClassName

public java.lang.String swigGetClassName()

Returns the actual class name of this object. This is used internally by the SDK.

Overrides:

swigGetClassName in class LabelStyle

Returns:

The class name of this object.

swigGetDirectorObject

public java.lang.Object swigGetDirectorObject()

Returns the connected director object. This is used internally by the SDK.

Overrides:

swigGetDirectorObject in class LabelStyle

Returns:

The connected director object or null if director is not connected.