artisynth.core.renderables

Class TextComponent3d

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.RenderableComponentBase

artisynth.core.renderables.TextComponentBase

artisynth.core.renderables.TextComponent3d

All Implemented Interfaces:

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

public class TextComponent3d
extends TextComponentBase
implements TransformableGeometry

Allows adding text to a root model, with the option of having the text follow the viewer.

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 boolean	defaultByReference
static PropertyList	myProps

Fields inherited from class artisynth.core.renderables.TextComponentBase

defaultFont, defaultFontName, defaultFontSize, defaultHAlignment, defaultTextSize, defaultVAlignment

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

enforceUniqueCompositeNames, enforceUniqueNames, myNumber, NULL_OBJ, useCompactPathNames

Fields inherited from interface artisynth.core.modelbase.TransformableGeometry

TG_ARTICULATED, TG_DRAGGER, TG_PRESERVE_ORIENTATION, TG_SIMULATING

Fields inherited from interface maspack.render.IsRenderable

TRANSPARENT, TWO_DIMENSIONAL

Constructor Summary

Constructors

Constructor and Description
TextComponent3d()
TextComponent3d(java.lang.String str) Sets both name and text to the provided string
TextComponent3d(java.lang.String text, Point3d pos) Sets both name (if valid) and text to provided string
TextComponent3d(java.lang.String name, java.lang.String text, Point3d pos) Main constructor

Method Summary

Modifier and Type	Method and Description
void	addTransformableDependencies(TransformGeometryContext context, int flags) Adds to context any transformable components which should be transformed as the same time as this component.
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
AxisAngle	getOrientation()
Point3d	getPosition() Returns position by reference
int	getRenderHints() Returns a bit code giving rendering hints about this renderable.
java.lang.String	getText()
boolean	isFollowingEye() Checks whether the text is following the viewer's eye
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	setFollowEye(boolean set) Sets whether to have the text follow the user's eye
void	setOrientation(AxisAngle orient) Orientation w.r.t.
void	setPosition(Point3d pos) Sets the position to display text
void	setPosition(Point3d pos, boolean byRef) Sets world position to display text.
void	setText(java.lang.String text) Sets the text to display
void	transformGeometry(AffineTransform3dBase X) Applies an affine transformation to the geometry of this component.
void	transformGeometry(GeometryTransformer gtr, TransformGeometryContext context, int flags) Transforms the geometry of this component, using the geometry transformer gtr to transform its individual attributes.
void	updateBounds(Vector3d pmin, Vector3d pmax) Update the minimum and maximum points for this object.

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, 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.TransformableGeometry

transformPriority

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

defaultByReference

public static boolean defaultByReference

myProps

public static PropertyList myProps

Constructor Detail

TextComponent3d

public TextComponent3d()

TextComponent3d

public TextComponent3d(java.lang.String str)

Sets both name and text to the provided string

Parameters:

str - name and text string

TextComponent3d

public TextComponent3d(java.lang.String text,
                       Point3d pos)

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

TextComponent3d

public TextComponent3d(java.lang.String name,
                       java.lang.String text,
                       Point3d pos)

Main constructor

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(Point3d pos)

Sets the position to display text

setPosition

public void setPosition(Point3d pos,
                        boolean byRef)

Sets world position to display text. If byRef is true, then sets position by reference.

getPosition

public Point3d getPosition()

Returns position by reference

setOrientation

public void setOrientation(AxisAngle orient)

Orientation w.r.t. world. If we are following the viewer, this is usually the identity.

getOrientation

public AxisAngle getOrientation()

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.

isFollowingEye

public boolean isFollowingEye()

Checks whether the text is following the viewer's eye

setFollowEye

public void setFollowEye(boolean set)

Sets whether to have the text follow the user's eye

updateBounds

public void updateBounds(Vector3d pmin,
                         Vector3d pmax)

Description copied from interface: IsRenderable

Update the minimum and maximum points for this object. In an x-y-z coordinate system with x directed to the right and y directed upwards, the minimum and maximum points can be thought of as defining the left-lower-far and right-upper-near corners of a bounding cube. This method should only reduce the elements of the minimum point and increase the elements of the maximum point, since it may be used as part of an iteration to determine the bounding cube for several different objects.

Specified by:

updateBounds in interface IsRenderable

Overrides:

updateBounds in class RenderableComponentBase

Parameters:

pmin - minimum point

pmax - maximum point

transformGeometry

public void transformGeometry(AffineTransform3dBase X)

Description copied from interface: TransformableGeometry

Applies an affine transformation to the geometry of this component. This method should be equivalent to

 TransformGeometryContext.transform (this, X, 0);
 

Specified by:

transformGeometry in interface TransformableGeometry

Parameters:

X - affine transformation to apply to the component

transformGeometry

public void transformGeometry(GeometryTransformer gtr,
                              TransformGeometryContext context,
                              int flags)

Description copied from interface: TransformableGeometry

Transforms the geometry of this component, using the geometry transformer gtr to transform its individual attributes. The context argument supplies information about what other components are currently being transformed, and also allows the requesting of update actions to be performed after all transform called have completed. The context is also the usual entity that calls this method, from within its TransformGeometryContext.apply(maspack.geometry.GeometryTransformer, int) method. The argument flags provides flags to specify various conditions associated with the the transformation. At present, the available flags are TransformableGeometry.TG_SIMULATING and TransformableGeometry.TG_ARTICULATED.

This method is not usually called directly by applications. Instead, it is typically called from within the TransformGeometryContext.apply(maspack.geometry.GeometryTransformer, int) method of the context, which takes care of the various operations needed for a complete transform operation, including calling TransformableGeometry.addTransformableDependencies(artisynth.core.modelbase.TransformGeometryContext, int) to collect other components that should be transformed, calling TransformableGeometry.transformGeometry(maspack.matrix.AffineTransform3dBase) for each component, notifying component parents that the geometry has changed, and calling any requested TransformGeometryActions. More details are given in the documentation for TransformGeometryContext.apply(maspack.geometry.GeometryTransformer, int).

TransformGeometryContext provides a number of static convenience transform methods which take care of building the context and calling apply() for a specified set of components.

This method should not generally call transformGeometry() for its descendant components. Instead, descendants needing transformation should be specified by adding them to the context in the method TransformableGeometry.addTransformableDependencies(artisynth.core.modelbase.TransformGeometryContext, int).

Specified by:

transformGeometry in interface TransformableGeometry

Parameters:

gtr - transformer implementing the transform

context - context information, including what other components are being transformed

flags - specifies conditions associated with the transformation

addTransformableDependencies

public void addTransformableDependencies(TransformGeometryContext context,
                                         int flags)

Description copied from interface: TransformableGeometry

Adds to context any transformable components which should be transformed as the same time as this component. This will generally include descendant components, and may also include other components to which this component is connected in some way.

This method is generally called from with the TransformGeometryContext.apply(maspack.geometry.GeometryTransformer, int) method of a TransformGeometryContext.

Specified by:

addTransformableDependencies in interface TransformableGeometry

Parameters:

context - context information, to which the dependent components are added.

flags - specifies conditions associated with the transformation

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.