artisynth.core.renderables

Class TextLabeller3d

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.RenderableComponentBase

artisynth.core.renderables.TextComponentBase

artisynth.core.renderables.TextLabeller3d

All Implemented Interfaces:

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

public class TextLabeller3d
extends TextComponentBase

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.FilePathSaveType, ModelComponent.NavpanelVisibility

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	defaultByReference
static Point2d	defaultTextOffset
static double	defaultTextSize
static PropertyList	myProps

Fields inherited from class artisynth.core.renderables.TextComponentBase

defaultFont, defaultFontName, defaultFontSize, 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
TextLabeller3d()
TextLabeller3d(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
int	addItem(java.lang.String text, Point3d pos, AffineTransform3dBase trans, boolean byRef) Adds a label to draw
int	addItem(java.lang.String text, Point3d pos, boolean byRef) Adds a label to draw
void	clearItems() Clears all text items
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
int	getRenderHints() Returns a bit code giving rendering hints about this renderable.
Point2d	getTextOffset() Sets space to add to the left/bottom
double	getTextSize() Returns the text scaling
boolean	isSelectable() Returns true if this object is in fact selectable.
void	labelPoints(java.util.List<? extends Point> pnts)
void	labelPoints(PointList<? extends Point> pnts)
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.
boolean	removeItem(int id) Removes a label based on its ID number
void	render(Renderer renderer, int flags) Render this object using the functionality of the supplied Renderer.
void	setTextOffset(double xOffset, double yOffset)
void	setTextOffset(Point2d offset) Sets space to add to the left/bottom

Methods inherited from class artisynth.core.renderables.TextComponentBase

createRenderProps, getFont, getHorizontalAlignment, 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

defaultTextSize

public static double defaultTextSize

defaultTextOffset

public static Point2d defaultTextOffset

defaultByReference

public static boolean defaultByReference

myProps

public static PropertyList myProps

Constructor Detail

TextLabeller3d

public TextLabeller3d()

TextLabeller3d

public TextLabeller3d(java.lang.String name)

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

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.

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.

getTextSize

public double getTextSize()

Returns the text scaling

Overrides:

getTextSize in class TextComponentBase

setTextOffset

public void setTextOffset(Point2d offset)

Sets space to add to the left/bottom

setTextOffset

public void setTextOffset(double xOffset,
                          double yOffset)

getTextOffset

public Point2d getTextOffset()

Sets space to add to the left/bottom

addItem

public int addItem(java.lang.String text,
                   Point3d pos,
                   boolean byRef)

Adds a label to draw

Parameters:

text - text to display

pos - position of text in 3D world

byRef - if true, sets the point by reference

Returns:

in ID number which can be used to remove the label

addItem

public int addItem(java.lang.String text,
                   Point3d pos,
                   AffineTransform3dBase trans,
                   boolean byRef)

Adds a label to draw

Parameters:

text - text to display

pos - position of text in 3D world

trans - transform to apply to position when rendering

byRef - if true, sets the point/transform by reference

Returns:

in ID number which can be used to remove the label

removeItem

public boolean removeItem(int id)

Removes a label based on its ID number

clearItems

public void clearItems()

Clears all text items

labelPoints

public void labelPoints(java.util.List<? extends Point> pnts)

labelPoints

public void labelPoints(PointList<? extends Point> pnts)

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.