artisynth.core.renderables

Class TextComponent2d

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.RenderableComponentBase

artisynth.core.renderables.TextComponentBase

artisynth.core.renderables.TextComponent2d

All Implemented Interfaces:

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

public class TextComponent2d
extends TextComponentBase

Allows adding 2D text to a root model

Author:

Antonio, July 7, 2013

Nested Class Summary

Nested classes/interfaces inherited from class artisynth.core.renderables.TextComponentBase

TextComponentBase.HorizontalAlignment, TextComponentBase.VerticalAlignment

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

ModelComponent.NavpanelVisibility

Field Summary

Fields

Modifier and Type	Field and Description
static int	defaultFontSize
static Point2d	defaultPos
static double	defaultTextSize
static PropertyList	myProps

Fields inherited from class artisynth.core.renderables.TextComponentBase

defaultFont, defaultFontName, defaultHAlignment, defaultVAlignment

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
TextComponent2d()
TextComponent2d(java.lang.String str) Sets both name and text to the provided string
TextComponent2d(java.lang.String text, Point2d pos) Sets both name (if valid) and text to provided string.
TextComponent2d(java.lang.String name, java.lang.String text, Point2d pos) Main constructor, setting name, text and screen position;

Method Summary

Modifier and Type	Method and Description
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
Point2d	getPosition() Returns position by reference
int	getRenderHints() Returns a bit code giving rendering hints about this renderable.
double	getRotation() Gets the text angle
java.lang.String	getText()
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	render(Renderer renderer, int flags) Render this object using the functionality of the supplied Renderer.
void	setPosition(Point2d pos) Sets world position to display text.
void	setRotation(double deg) Sets the text angle, in degrees
void	setText(java.lang.String text) Sets the text to display

Methods inherited from class artisynth.core.renderables.TextComponentBase

createRenderProps, getFont, getHorizontalAlignment, getTextSize, getVerticalAlignment, setFont, setHorizontalAlignment, setTextColor, setTextSize, setVerticalAlignment

Methods inherited from class artisynth.core.modelbase.RenderableComponentBase

copy, defaultRenderPropsAreNull, getRenderProps, getSelection, isVisible, prerender, setRenderProps, setVisible, 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, isFixed, isMarked, isScanning, isSelected, isWritable, makeValidName, makeValidName, notifyParentOfChange, postscan, printReferences, recursivelyContained, recursivelyContains, removeTempFlag, scan, setFixed, setFlag, setMarked, setName, setNavpanelVisibility, setNavpanelVisibility, setNumber, setParent, setScanning, setSelected, setWritable, 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, scan, setFixed, setMarked, setName, setNumber, setParent, setSelected, setWritable, updateReferences

Methods inherited from interface maspack.properties.HasProperties

getProperty

Methods inherited from interface maspack.properties.HierarchyNode

getChildren, hasChildren

Methods inherited from interface artisynth.core.modelbase.PostScannable

postscan

Methods inherited from interface maspack.util.Scannable

isWritable, write

Field Detail

defaultFontSize

public static int defaultFontSize

defaultTextSize

public static double defaultTextSize

defaultPos

public static Point2d defaultPos

myProps

public static PropertyList myProps

Constructor Detail

TextComponent2d

public TextComponent2d()

TextComponent2d

public TextComponent2d(java.lang.String str)

Sets both name and text to the provided string

Parameters:

str - name and text string

TextComponent2d

public TextComponent2d(java.lang.String text,
                       Point2d pos)

Sets both name (if valid) and text to provided string.

TextComponent2d

public TextComponent2d(java.lang.String name,
                       java.lang.String text,
                       Point2d pos)

Main constructor, setting name, text and screen position;

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 TextComponentBase

Returns:

static information for all exported properties

setText

public void setText(java.lang.String text)

Sets the text to display

getText

public java.lang.String getText()

setPosition

public void setPosition(Point2d pos)

Sets world position to display text. If a coordinate has a value in [0, 1], then it is assumed to be normalized, with (0,0) in the bottom-left corner, and (1,1) the top-right.

getPosition

public Point2d getPosition()

Returns position by reference

getRotation

public double getRotation()

Gets the text angle

setRotation

public void setRotation(double deg)

Sets the text angle, in degrees

getRenderHints

public int getRenderHints()

Description copied from interface: IsRenderable

Returns a bit code giving rendering hints about this renderable. Current bit codes include TRANSPARENT and TWO_DIMENSIONAL.

Specified by:

getRenderHints in interface IsRenderable

Overrides:

getRenderHints in class RenderableComponentBase

Returns:

bit code of rendering hints.

render

public void render(Renderer renderer,
                   int flags)

Description copied from interface: IsRenderable

Render this object using the functionality of the supplied Renderer.

Specified by:

render in interface IsRenderable

Specified by:

render in class RenderableComponentBase

Parameters:

renderer - provides the functionality used to perform the rendering.

flags - flags that may be used to control different aspects of the rendering. Flags are defined in Renderer and currently include Renderer.HIGHLIGHT and Renderer.SORT_FACES.

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 TextComponentBase

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 TextComponentBase

Returns:

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