agi.foundation.platforms

(agi.foundation.platforms.graphics-2024r3.jar)

Class TextGraphics

java.lang.Object

agi.foundation.platforms.TextGraphics

public class TextGraphics
extends Object

Defines the graphics properties of text over time.

Constructor Summary

Constructors

Constructor and Description
TextGraphics() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
GraphicsParameter<Boolean>	getAlignToPixel() Gets a parameter indicating whether the text should be aligned to a pixel.
GraphicsParameter<Color>	getColor() Gets a parameter indicating the color of the text over time.
DisplayParameters	getDisplayParameters() Gets the visibility of the text over time.
GraphicsParameter<Cartesian>	getEyeOffset() Gets a parameter indicating the eye offset of the text over time.
GraphicsParameter<Font>	getFont() Gets the Font (get / set) used to draw the text.
GraphicsParameter<Origin>	getOrigin() Gets a parameter indicating the Origin (get / set) of the text over time.
GraphicsParameter<Boolean>	getOutline() Gets whether or not to outline the text.
GraphicsParameter<Color>	getOutlineColor() Gets a parameter indicating the color and translucency of the text outline over time.
GraphicsParameter<PointF>	getPixelOffset() Gets a parameter indicating the pixel offset of the text over time.
GraphicsParameter<String>	getText() Gets a parameter indicating the value of the text over time.
GraphicsParameter<TextureFilter2D>	getTextureFilter() Gets a parameter indicating the TextureFilter2D of the text over time.
void	setAlignToPixel(GraphicsParameter<Boolean> value) Sets a parameter indicating whether the text should be aligned to a pixel.
void	setColor(GraphicsParameter<Color> value) Sets a parameter indicating the color of the text over time.
void	setDisplayParameters(DisplayParameters value) Sets the visibility of the text over time.
void	setEyeOffset(GraphicsParameter<Cartesian> value) Sets a parameter indicating the eye offset of the text over time.
void	setFont(GraphicsParameter<Font> value) Sets the Font (get / set) used to draw the text.
void	setOrigin(GraphicsParameter<Origin> value) Sets a parameter indicating the Origin (get / set) of the text over time.
void	setOutline(GraphicsParameter<Boolean> value) Sets whether or not to outline the text.
void	setOutlineColor(GraphicsParameter<Color> value) Sets a parameter indicating the color and translucency of the text outline over time.
void	setPixelOffset(GraphicsParameter<PointF> value) Sets a parameter indicating the pixel offset of the text over time.
void	setText(GraphicsParameter<String> value) Sets a parameter indicating the value of the text over time.
void	setTextureFilter(GraphicsParameter<TextureFilter2D> value) Sets a parameter indicating the TextureFilter2D of the text over time.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextGraphics

public TextGraphics()

Initializes a new instance.

Method Detail

getAlignToPixel

public final GraphicsParameter<Boolean> getAlignToPixel()

Gets a parameter indicating whether the text should be aligned to a pixel.

setAlignToPixel

public final void setAlignToPixel(GraphicsParameter<Boolean> value)

Sets a parameter indicating whether the text should be aligned to a pixel.

getColor

public final GraphicsParameter<Color> getColor()

Gets a parameter indicating the color of the text over time.

setColor

public final void setColor(GraphicsParameter<Color> value)

Sets a parameter indicating the color of the text over time.

getFont

public final GraphicsParameter<Font> getFont()

Gets the Font (get / set) used to draw the text.

setFont

public final void setFont(GraphicsParameter<Font> value)

Sets the Font (get / set) used to draw the text.

getEyeOffset

public final GraphicsParameter<Cartesian> getEyeOffset()

Gets a parameter indicating the eye offset of the text over time.

setEyeOffset

public final void setEyeOffset(GraphicsParameter<Cartesian> value)

Sets a parameter indicating the eye offset of the text over time.

getOutline

public final GraphicsParameter<Boolean> getOutline()

Gets whether or not to outline the text.

setOutline

public final void setOutline(GraphicsParameter<Boolean> value)

Sets whether or not to outline the text.

getOutlineColor

public final GraphicsParameter<Color> getOutlineColor()

Gets a parameter indicating the color and translucency of the text outline over time.

setOutlineColor

public final void setOutlineColor(GraphicsParameter<Color> value)

Sets a parameter indicating the color and translucency of the text outline over time.

getOrigin

public final GraphicsParameter<Origin> getOrigin()

Gets a parameter indicating the Origin (get / set) of the text over time.

setOrigin

public final void setOrigin(GraphicsParameter<Origin> value)

Sets a parameter indicating the Origin (get / set) of the text over time.

getPixelOffset

public final GraphicsParameter<PointF> getPixelOffset()

Gets a parameter indicating the pixel offset of the text over time.

setPixelOffset

public final void setPixelOffset(GraphicsParameter<PointF> value)

Sets a parameter indicating the pixel offset of the text over time.

getText

public final GraphicsParameter<String> getText()

Gets a parameter indicating the value of the text over time.

setText

public final void setText(GraphicsParameter<String> value)

Sets a parameter indicating the value of the text over time.

getTextureFilter

public final GraphicsParameter<TextureFilter2D> getTextureFilter()

Gets a parameter indicating the TextureFilter2D of the text over time.

setTextureFilter

public final void setTextureFilter(GraphicsParameter<TextureFilter2D> value)

Sets a parameter indicating the TextureFilter2D of the text over time.

getDisplayParameters

public final DisplayParameters getDisplayParameters()

Gets the visibility of the text over time.

setDisplayParameters

public final void setDisplayParameters(DisplayParameters value)

Sets the visibility of the text over time.