artisynth.core.renderables

Class ColorBar

java.lang.Object

artisynth.core.modelbase.ModelComponentBase

artisynth.core.modelbase.RenderableComponentBase

artisynth.core.renderables.TextComponentBase

artisynth.core.renderables.ColorBar

All Implemented Interfaces:

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

public class ColorBar
extends TextComponentBase

Color bar implementation, as a 2D renderable component. Allow you to draw labels/tick marks and adjust the color scheme.

Author:

Antonio

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 int	defaultBarDivisions
static ColorMapBase	defaultColorMap
static TextComponentBase.HorizontalAlignment	defaultHAlignment
static boolean	defaultHorizontal
static DoubleInterval	defaultInterval
static Rectangle2d	defaultLoc
static java.lang.String	defaultNumberFormat
static Vector2d	defaultTextOffset
static double	defaultTextSize
static Vector2d	defaultTickFraction
static TextComponentBase.VerticalAlignment	defaultVAlignment
static PropertyList	myProps
static AxisAngle	ROT_Z_270

Fields inherited from class artisynth.core.renderables.TextComponentBase

defaultFont, defaultFontName, defaultFontSize

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
ColorBar()
ColorBar(ColorMapBase cmap)

Method Summary

Modifier and Type	Method and Description
RenderObject	buildRenderObject(int divisions, ColorMap cmap, VectorNd labelPos, Vector2d tickWidths)
RenderProps	createRenderProps() Factory method to create render properties appropriate to this object.
static RenderProps	defaultRenderProps(HasProperties host)
PropertyList	getAllPropertyInfo() Returns a list giving static information about all properties exported by this object.
void	getColor(double value, double[] rgb)
ColorMapBase	getColorMap()
PropertyMode	getColorMapMode()
VectorNd	getLabelPositions()
java.util.ArrayList<java.lang.String>	getLabels()
java.lang.String	getLabelSet()
Rectangle2d	getLocation() Rectangular location (x,y,width,height) of color bar.
NumberFormat	getNumberFormat()
java.lang.String	getNumberFormatString()
int	getRenderHints() Returns a bit code giving rendering hints about this renderable.
Vector2d	getTextOffset()
Vector2d	getTickFraction()
DoubleInterval	getValueRange()
boolean	isHorizontal()
void	parseLabelSet(java.lang.String str)
int	parseNext(char[] carray, int idx, java.util.ArrayList<java.lang.String> parsed)
void	populateLabels(double minVal, double maxVal, int nSections)
void	populateLabels(double minVal, double maxVal, int nSections, NumberFormat fmt)
void	prerender(RenderList list) Called prior to rendering to allow this object to update the internal state required for rendering (such as by caching rendering coordinates).
void	render(Renderer renderer, int flags) Render this object using the functionality of the supplied Renderer.
void	setColorMap(ColorMapBase colorMap)
void	setColorMapMode(PropertyMode mode)
void	setHorizontal(boolean set)
void	setHorizontalAlignment(TextComponentBase.HorizontalAlignment hAlignment) Sets the horizontal alignment, one of LEFT, CENTRE, RIGHT
void	setLabel(int idx, java.lang.String text)
void	setLabelPositions(VectorNd pos)
void	setLabels(java.util.ArrayList<java.lang.String> text)
void	setLabels(VectorNd tickLocs, java.util.ArrayList<java.lang.String> labels)
void	setLocation(double x, double y, double w, double h) Rectangular location (x,y,width,height) of color bar.
void	setLocation(Rectangle2d pos) Rectangular location (x,y,width,height) of color bar.
void	setNumberFormat(NumberFormat fmt)
void	setNumberFormat(java.lang.String fmtStr)
void	setNumberFormatString(java.lang.String fmt)
void	setTextOffset(Vector2d offset)
void	setTickFraction(Vector2d frac)
void	setValueRange(double min, double max)
void	setValueRange(DoubleInterval range)
void	setVerticalAlignment(TextComponentBase.VerticalAlignment vAlignment) If bar is horizontal, then places text at supplied alignment location.
void	updateLabels()
void	updateLabels(double minVal, double maxVal)
void	updateLabels(double minVal, double maxVal, NumberFormat fmt)
void	updateLabels(NumberFormat fmt)

Methods inherited from class artisynth.core.renderables.TextComponentBase

getFont, getHorizontalAlignment, getTextSize, getVerticalAlignment, isSelectable, numSelectionQueriesNeeded, setFont, setTextColor, setTextSize

Methods inherited from class artisynth.core.modelbase.RenderableComponentBase

copy, defaultRenderPropsAreNull, getRenderProps, getSelection, isVisible, 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

ROT_Z_270

public static final AxisAngle ROT_Z_270

defaultLoc

public static Rectangle2d defaultLoc

defaultTickFraction

public static Vector2d defaultTickFraction

defaultTextSize

public static double defaultTextSize

defaultTextOffset

public static Vector2d defaultTextOffset

defaultNumberFormat

public static java.lang.String defaultNumberFormat

defaultVAlignment

public static TextComponentBase.VerticalAlignment defaultVAlignment

defaultHAlignment

public static TextComponentBase.HorizontalAlignment defaultHAlignment

defaultInterval

public static DoubleInterval defaultInterval

defaultColorMap

public static ColorMapBase defaultColorMap

defaultBarDivisions

public static int defaultBarDivisions

defaultHorizontal

public static boolean defaultHorizontal

myProps

public static PropertyList myProps

Constructor Detail

ColorBar

public ColorBar()

ColorBar

public ColorBar(ColorMapBase cmap)

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

defaultRenderProps

public static RenderProps defaultRenderProps(HasProperties host)

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 TextComponentBase

Returns:

new render properties for this object

buildRenderObject

public RenderObject buildRenderObject(int divisions,
                                      ColorMap cmap,
                                      VectorNd labelPos,
                                      Vector2d tickWidths)

prerender

public void prerender(RenderList list)

Description copied from interface: IsRenderable

Called prior to rendering to allow this object to update the internal state required for rendering (such as by caching rendering coordinates). The object may add internal objects to the list of objects being rendered, by calling

list.addIfVisible (obj);

for each of the objects in question.

Specified by:

prerender in interface IsRenderable

Overrides:

prerender in class RenderableComponentBase

Parameters:

list - list of objects to be rendered

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.

getLocation

public Rectangle2d getLocation()

Rectangular location (x,y,width,height) of color bar. If values are in the range [0,1], then they are taken to be relative to the screen size. If values are negative, they are taken to be offsets from the right/top

Returns:

location parameters

setLocation

public void setLocation(double x,
                        double y,
                        double w,
                        double h)

Rectangular location (x,y,width,height) of color bar. If values are in the range [0,1], then they are taken to be relative to the screen size. If values are negative, they are taken to be offsets from the right/top

Parameters:

x - left

y - bottom

w - width

h - height

setLocation

public void setLocation(Rectangle2d pos)

Rectangular location (x,y,width,height) of color bar. If values are in the range [0,1], then they are taken to be relative to the screen size. If values are negative, they are taken to be offsets from the right/top

Parameters:

pos - location

isHorizontal

public boolean isHorizontal()

setHorizontal

public void setHorizontal(boolean set)

getColorMap

public ColorMapBase getColorMap()

setColorMap

public void setColorMap(ColorMapBase colorMap)

getColorMapMode

public PropertyMode getColorMapMode()

setColorMapMode

public void setColorMapMode(PropertyMode mode)

getLabelPositions

public VectorNd getLabelPositions()

setLabelPositions

public void setLabelPositions(VectorNd pos)

setLabels

public void setLabels(java.util.ArrayList<java.lang.String> text)

getLabels

public java.util.ArrayList<java.lang.String> getLabels()

setLabel

public void setLabel(int idx,
                     java.lang.String text)

parseLabelSet

public void parseLabelSet(java.lang.String str)

parseNext

public int parseNext(char[] carray,
                     int idx,
                     java.util.ArrayList<java.lang.String> parsed)

getLabelSet

public java.lang.String getLabelSet()

setTickFraction

public void setTickFraction(Vector2d frac)

getTickFraction

public Vector2d getTickFraction()

getTextOffset

public Vector2d getTextOffset()

setTextOffset

public void setTextOffset(Vector2d offset)

setLabels

public void setLabels(VectorNd tickLocs,
                      java.util.ArrayList<java.lang.String> labels)

populateLabels

public void populateLabels(double minVal,
                           double maxVal,
                           int nSections,
                           NumberFormat fmt)

updateLabels

public void updateLabels(NumberFormat fmt)

updateLabels

public void updateLabels()

getColor

public void getColor(double value,
                     double[] rgb)

updateLabels

public void updateLabels(double minVal,
                         double maxVal,
                         NumberFormat fmt)

updateLabels

public void updateLabels(double minVal,
                         double maxVal)

populateLabels

public void populateLabels(double minVal,
                           double maxVal,
                           int nSections)

setValueRange

public void setValueRange(DoubleInterval range)

setValueRange

public void setValueRange(double min,
                          double max)

getValueRange

public DoubleInterval getValueRange()

setHorizontalAlignment

public void setHorizontalAlignment(TextComponentBase.HorizontalAlignment hAlignment)

Description copied from class: TextComponentBase

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

Overrides:

setHorizontalAlignment in class TextComponentBase

setVerticalAlignment

public void setVerticalAlignment(TextComponentBase.VerticalAlignment vAlignment)

If bar is horizontal, then places text at supplied alignment location. If vertical, sets alignment of text.

Overrides:

setVerticalAlignment in class TextComponentBase

setNumberFormatString

public void setNumberFormatString(java.lang.String fmt)

getNumberFormatString

public java.lang.String getNumberFormatString()

setNumberFormat

public void setNumberFormat(NumberFormat fmt)

setNumberFormat

public void setNumberFormat(java.lang.String fmtStr)

getNumberFormat

public NumberFormat getNumberFormat()