org.apache.commons.geometry.examples.tutorials.bsp

Class BSPTreeSVGWriter

java.lang.Object

org.apache.commons.geometry.examples.tutorials.bsp.BSPTreeSVGWriter

public class BSPTreeSVGWriter
extends Object

Class for writing SVG visualizations of 2D BSP trees.

Constructor Summary

Constructors

Constructor and Description
BSPTreeSVGWriter(Bounds2D bounds) Construct a new instance that will render regions within the given bounds.

Method Summary

Modifier and Type	Method and Description
void	setTreeParentOffsetFactor(double treeParentOffsetFactor) Set the offset factor determining how much of the available horizontal width for a node should be used to offset it from its parent.
void	setTreeParentXOffsetMin(double treeParentXOffsetMin) Set the minimum horizontal offset for tree nodes from their parents.
void	write(RegionBSPTree2D tree, File file) Write an SVG visualization of the given BSP tree.
void	write(RegionBSPTree2D tree, Map<RegionBSPTree2D.RegionNode2D,String> nodeNames, File file) Write an SVG visualization of the given BSP tree.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BSPTreeSVGWriter

public BSPTreeSVGWriter(Bounds2D bounds)

Construct a new instance that will render regions within the given bounds.

Parameters:

bounds - bounds used to determine what output

Method Detail

setTreeParentOffsetFactor

public void setTreeParentOffsetFactor(double treeParentOffsetFactor)

Set the offset factor determining how much of the available horizontal width for a node should be used to offset it from its parent.

Parameters:

treeParentOffsetFactor - offset factor

setTreeParentXOffsetMin

public void setTreeParentXOffsetMin(double treeParentXOffsetMin)

Set the minimum horizontal offset for tree nodes from their parents.

Parameters:

treeParentXOffsetMin - minimum offset

write

public void write(RegionBSPTree2D tree,
                  File file)

Write an SVG visualization of the given BSP tree. Default names are assigned to the tree nodes.

Parameters:

tree - tree to output

file - path of the svg file to write

write

public void write(RegionBSPTree2D tree,
                  Map<RegionBSPTree2D.RegionNode2D,String> nodeNames,
                  File file)

Write an SVG visualization of the given BSP tree.

Parameters:

tree - tree to output

nodeNames - map of node instances to the names that should be used for them in the svg

file - path of the svg file to write