HudPrintStream (Artisynth API documentation)

java.lang.Object
- artisynth.core.modelbase.ModelComponentBase
- - artisynth.core.modelbase.RenderableComponentBase
  - - artisynth.core.renderables.TextComponentBase
    - - artisynth.core.renderables.HudPrintStream

All Implemented Interfaces:

ModelComponent, PostScannable, RenderableComponent, java.lang.Cloneable, HasProperties, HierarchyNode, HasRenderProps, IsRenderable, IsSelectable, Renderable, Scannable
```
public class HudPrintStream
extends TextComponentBase
```
Simple component to print info on the main viewer

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`	`defaultBufferSize`
`static java.lang.String`	`defaultFontName`
`static double`	`defaultLineSpacing`
`static int`	`defaultNumDisplayLines`
`static PropertyList`	`myProps`

Fields inherited from class artisynth.core.renderables.TextComponentBase
defaultFont, defaultFontSize, defaultHAlignment, defaultTextSize, 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

HudPrintStream()
Basic component, defaulting to 5 lines of 12pt monospaced font in bottom left corner

Constructors
Constructor and Description
`HudPrintStream()` Basic component, defaulting to 5 lines of 12pt monospaced font in bottom left corner

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears the buffer
`void`	`cls()` Appends blank lines to clear the screen
`void`	`fullscreen()` Makes the HUD full-screen according to the viewer's current height
`PropertyList`	`getAllPropertyInfo()` Returns a list giving static information about all properties exported by this object.
`int`	`getBufferSize()` Returns maximum size of line buffer
`double`	`getLineSpacing()` Gets the line spacing
`int`	`getNumDisplayLines()` Maximum number of lines to display
`Point2d`	`getPosition()` Gets current 2D normalized coordinates, [0 1]x[0 1]
`int`	`getRenderHints()` Returns a bit code giving rendering hints about this renderable.
`int`	`getScrollOffset()` Gets the current scroll offset
`boolean`	`isFullscreen()`
`void`	`locateBottomCentre()` Moves the HUD to the bottom-centre
`void`	`locateBottomLeft()` Moves the HUD to the bottom-left corner
`void`	`locateBottomRight()` Moves the HUD to the bottom-right
`void`	`locateTopCentre()` Moves the HUD to the top-centre
`void`	`locateTopLeft()` Moves the HUD to the top-left corner
`void`	`locateTopRight()` Moves the HUD to the top-right
`void`	`print(java.lang.String str)` Standard print functionality
`void`	`printf(java.lang.String fmt, java.lang.Object... args)` Standard printf functionality
`void`	`println(java.lang.String str)` Standard println functionality
`void`	`render(Renderer renderer, int flags)` Render this object using the functionality of the supplied `Renderer`.
`void`	`scrollDown()` Scroll down by one line
`void`	`scrollUp()` Scroll up by one line
`void`	`setBufferSize(int buffSize)` Sets maximum number of lines to store
`void`	`setFullscreen(boolean enable)`
`void`	`setLineSpacing(double sp)` Sets the line spacing, 1 for single-space
`void`	`setNumDisplayLines(int max)` Sets maximum number of lines to display
`void`	`setPosition(Point2d pos)` Sets the 2D normalized coordinates, [0 1]x[0 1]
`void`	`setScrollOffset(int offset)` Set number of lines to scroll up 0 <= offset <= # buffered lines - lines on screen
`void`	`setVerticalAlignment(TextComponentBase.VerticalAlignment vAlignment)` Sets the vertical alignment, one of `TOP, CENTRE, BOTTOM`
`void`	`toggleFullscreen()`

Methods inherited from class artisynth.core.renderables.TextComponentBase
createRenderProps, getFont, getHorizontalAlignment, getTextSize, getVerticalAlignment, isSelectable, numSelectionQueriesNeeded, setFont, setHorizontalAlignment, setTextColor, setTextSize

Methods inherited from class artisynth.core.modelbase.RenderableComponentBase
copy, defaultRenderPropsAreNull, getRenderProps, getSelection, isVisible, prerender, setRenderProps, setVisible, updateBounds, updateRenderProps

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
  - defaultFontName
```
public static java.lang.String defaultFontName
```
  - defaultNumDisplayLines
```
public static int defaultNumDisplayLines
```
  - defaultLineSpacing
```
public static double defaultLineSpacing
```
  - defaultBufferSize
```
public static int defaultBufferSize
```
  - myProps
```
public static PropertyList myProps
```
- Constructor Detail
  - HudPrintStream
```
public HudPrintStream()
```
    Basic component, defaulting to 5 lines of 12pt monospaced font in bottom left corner
- 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.
  - cls
```
public void cls()
```
    Appends blank lines to clear the screen
  - clear
```
public void clear()
```
    Clears the buffer
  - printf
```
public void printf(java.lang.String fmt,
                   java.lang.Object... args)
```
    Standard printf functionality
  - print
```
public void print(java.lang.String str)
```
    Standard print functionality
  - println
```
public void println(java.lang.String str)
```
    Standard println functionality
  - getNumDisplayLines
```
public int getNumDisplayLines()
```
    Maximum number of lines to display
  - setNumDisplayLines
```
public void setNumDisplayLines(int max)
```
    Sets maximum number of lines to display
  - setBufferSize
```
public void setBufferSize(int buffSize)
```
    Sets maximum number of lines to store
  - getBufferSize
```
public int getBufferSize()
```
    Returns maximum size of line buffer
  - setLineSpacing
```
public void setLineSpacing(double sp)
```
    Sets the line spacing, 1 for single-space
  - getLineSpacing
```
public double getLineSpacing()
```
    Gets the line spacing
  - getPosition
```
public Point2d getPosition()
```
    Gets current 2D normalized coordinates, [0 1]x[0 1]
  - setPosition
```
public void setPosition(Point2d pos)
```
    Sets the 2D normalized coordinates, [0 1]x[0 1]
  - 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.
  - locateTopLeft
```
public void locateTopLeft()
```
    Moves the HUD to the top-left corner
  - locateTopCentre
```
public void locateTopCentre()
```
    Moves the HUD to the top-centre
  - locateTopRight
```
public void locateTopRight()
```
    Moves the HUD to the top-right
  - locateBottomLeft
```
public void locateBottomLeft()
```
    Moves the HUD to the bottom-left corner
  - locateBottomCentre
```
public void locateBottomCentre()
```
    Moves the HUD to the bottom-centre
  - locateBottomRight
```
public void locateBottomRight()
```
    Moves the HUD to the bottom-right
  - fullscreen
```
public void fullscreen()
```
    Makes the HUD full-screen according to the viewer's current height
  - toggleFullscreen
```
public void toggleFullscreen()
```
  - isFullscreen
```
public boolean isFullscreen()
```
  - setFullscreen
```
public void setFullscreen(boolean enable)
```
  - setVerticalAlignment
```
public void setVerticalAlignment(TextComponentBase.VerticalAlignment vAlignment)
```
    Description copied from class: TextComponentBase
    
    Sets the vertical alignment, one of TOP, CENTRE, BOTTOM
    
    Overrides:
    
    setVerticalAlignment in class TextComponentBase
  - setScrollOffset
```
public void setScrollOffset(int offset)
```
    Set number of lines to scroll up 0 <= offset <= # buffered lines - lines on screen
  - getScrollOffset
```
public int getScrollOffset()
```
    Gets the current scroll offset
  - scrollUp
```
public void scrollUp()
```
    Scroll up by one line
  - scrollDown
```
public void scrollDown()
```
    Scroll down by one line

Class HudPrintStream

Nested Class Summary

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

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

Field Summary

Fields inherited from class artisynth.core.renderables.TextComponentBase

Fields inherited from class artisynth.core.modelbase.ModelComponentBase

Fields inherited from interface maspack.render.IsRenderable

Constructor Summary

Method Summary

Methods inherited from class artisynth.core.renderables.TextComponentBase

Methods inherited from class artisynth.core.modelbase.RenderableComponentBase

Methods inherited from class artisynth.core.modelbase.ModelComponentBase

Methods inherited from class java.lang.Object

Methods inherited from interface artisynth.core.modelbase.ModelComponent

Methods inherited from interface maspack.properties.HasProperties

Methods inherited from interface maspack.properties.HierarchyNode

Methods inherited from interface artisynth.core.modelbase.PostScannable

Methods inherited from interface maspack.util.Scannable

Field Detail

defaultFontName

defaultNumDisplayLines

defaultLineSpacing

defaultBufferSize

myProps

Constructor Detail

HudPrintStream

Method Detail

getAllPropertyInfo

render

cls

clear

printf

print

println

getNumDisplayLines

setNumDisplayLines

setBufferSize

getBufferSize

setLineSpacing

getLineSpacing

getPosition

setPosition

getRenderHints

locateTopLeft

locateTopCentre

locateTopRight

locateBottomLeft

locateBottomCentre

locateBottomRight

fullscreen

toggleFullscreen

isFullscreen

setFullscreen

setVerticalAlignment

setScrollOffset

getScrollOffset

scrollUp

scrollDown