artisynth.core.renderables

Class TextComponentBase

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.RenderableComponentBase

artisynth.core.renderables.TextComponentBase

All Implemented Interfaces:

ModelComponent, RenderableComponent, java.lang.Cloneable, HasProperties, HierarchyNode, HasRenderProps, IsRenderable, IsSelectable, Renderable, Scannable

Direct Known Subclasses:

ColorBar, HudPrintStream, TextComponent2d, TextComponent3d, TextLabeller3d

public abstract class TextComponentBase
extends RenderableComponentBase

Base class for text components, setting font/alignment

Author:

Antonio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextComponentBase.HorizontalAlignment
static class	TextComponentBase.VerticalAlignment

Nested classes/interfaces inherited from interface artisynth.core.modelbase.ModelComponent

ModelComponent.NavpanelVisibility

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.Font	defaultFont
static java.lang.String	defaultFontName
static int	defaultFontSize
static TextComponentBase.HorizontalAlignment	defaultHAlignment
static double	defaultTextSize
static TextComponentBase.VerticalAlignment	defaultVAlignment
static PropertyList	myProps

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Fields inherited from interface maspack.render.IsRenderable

TRANSPARENT, TWO_DIMENSIONAL

Constructor Summary

Constructors

Constructor and Description
TextComponentBase()

Method Summary

Modifier and Type	Method and Description
static RenderProps	createDefaultRenderProps()
RenderProps	createRenderProps() Factory method to create render properties appropriate to this object.
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
java.awt.Font	getFont()
double	getFontSize() Gets the size of the font
TextComponentBase.HorizontalAlignment	getHorizontalAlignment() Gets the horizontal alignment
double	getTextSize() Gets the size of the text
TextComponentBase.VerticalAlignment	getVerticalAlignment() Gets the vertical alignment
boolean	isSelectable() Returns true if this object is in fact selectable.
int	numSelectionQueriesNeeded() If this selectable manages its own selection (by issuing selection queries within its render method), then this method should return the maximum number of selection queries that will be required.
void	setFont(java.awt.Font font) Explicitly set the font for this text component
void	setFontSize(double size) Sets the size of the font
void	setHorizontalAlignment(TextComponentBase.HorizontalAlignment hAlignment) Sets the horizontal alignment, one of LEFT, CENTRE, RIGHT
void	setTextColor(java.awt.Color c)
void	setTextSize(double size) Sets the size of the text
void	setVerticalAlignment(TextComponentBase.VerticalAlignment vAlignment) Sets the vertical alignment, one of TOP, CENTRE, BOTTOM

Methods inherited from class artisynth.core.modelbase.RenderableComponentBase

copy, getRenderHints, getRenderProps, getSelection, prerender, render, setRenderProps, updateBounds, updateRenderProps

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

checkFlag, checkName, checkNameUniqueness, clearFlag, clone, connectToHierarchy, createTempFlag, disconnectFromHierarchy, getChildren, getGrandParent, getHardReferences, getName, getNameRange, getNavpanelVisibility, getNavpanelVisibility, getNumber, getParent, getProperty, getSoftReferences, hasChildren, hasState, isConnectedToHierarchy, isFixed, isMarked, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, postscan, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, scan, setFixed, setFlag, setMarked, setName, setNavpanelVisibility, setNavpanelVisibility, setNumber, setParent, setSelected, updateReferences, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface artisynth.core.modelbase.ModelComponent

connectToHierarchy, disconnectFromHierarchy, getHardReferences, getName, getNavpanelVisibility, getNumber, getParent, getSoftReferences, hasState, isFixed, isMarked, isSelected, notifyParentOfChange, postscan, scan, setFixed, setMarked, setName, setNumber, setParent, setSelected, updateReferences

Methods inherited from interface maspack.properties.HasProperties

getProperty

Methods inherited from interface maspack.properties.HierarchyNode

getChildren, hasChildren

Methods inherited from interface maspack.util.Scannable

isWritable, write

Field Detail

defaultFontSize

public static int defaultFontSize

defaultTextSize

public static double defaultTextSize

defaultFontName

public static java.lang.String defaultFontName

defaultFont

public static java.awt.Font defaultFont

defaultHAlignment

public static TextComponentBase.HorizontalAlignment defaultHAlignment

defaultVAlignment

public static TextComponentBase.VerticalAlignment defaultVAlignment

myProps

public static PropertyList myProps

Constructor Detail

TextComponentBase

public TextComponentBase()

Method Detail

getAllPropertyInfo

public PropertyList getAllPropertyInfo()

Description copied from interface: HasProperties

Returns a list giving static information about all properties exported by this object.

Specified by:

getAllPropertyInfo in interface HasProperties

Overrides:

getAllPropertyInfo in class ModelComponentBase

Returns:

static information for all exported properties

createDefaultRenderProps

public static RenderProps createDefaultRenderProps()

createRenderProps

public RenderProps createRenderProps()

Description copied from interface: HasRenderProps

Factory method to create render properties appropriate to this object.

Specified by:

createRenderProps in interface HasRenderProps

Overrides:

createRenderProps in class RenderableComponentBase

Returns:

new render properties for this object

getFont

public java.awt.Font getFont()

setFont

public void setFont(java.awt.Font font)

Explicitly set the font for this text component

Parameters:

font - the base font. The font size affects the resolution of the displayed text. It should be at least 32pt.

setFontSize

public void setFontSize(double size)

Sets the size of the font

getFontSize

public double getFontSize()

Gets the size of the font

setTextSize

public void setTextSize(double size)

Sets the size of the text

getTextSize

public double getTextSize()

Gets the size of the text

getHorizontalAlignment

public TextComponentBase.HorizontalAlignment getHorizontalAlignment()

Gets the horizontal alignment

setHorizontalAlignment

public void setHorizontalAlignment(TextComponentBase.HorizontalAlignment hAlignment)

Sets the horizontal alignment, one of LEFT, CENTRE, RIGHT

getVerticalAlignment

public TextComponentBase.VerticalAlignment getVerticalAlignment()

Gets the vertical alignment

setVerticalAlignment

public void setVerticalAlignment(TextComponentBase.VerticalAlignment vAlignment)

Sets the vertical alignment, one of TOP, CENTRE, BOTTOM

isSelectable

public boolean isSelectable()

Description copied from class: RenderableComponentBase

Returns true if this object is in fact selectable.

Specified by:

isSelectable in interface IsSelectable

Overrides:

isSelectable in class RenderableComponentBase

Returns:

true if this object is selectable

numSelectionQueriesNeeded

public int numSelectionQueriesNeeded()

Description copied from interface: IsSelectable

If this selectable manages its own selection (by issuing selection queries within its render method), then this method should return the maximum number of selection queries that will be required. Otherwise, this method should return -1.

Specified by:

numSelectionQueriesNeeded in interface IsSelectable

Overrides:

numSelectionQueriesNeeded in class RenderableComponentBase

Returns:

maximum number of selection queries needed by this component, or -1 if this component does not manage its own selection.

setTextColor

public void setTextColor(java.awt.Color c)