de.mcp.cutcad.printdialog

Class PrintInstance

java.lang.Object

de.mcp.cutcad.printdialog.PrintInstance

 class PrintInstance
extends java.lang.Object

Represents all the shapes of a certain material. A material is defined by its type and thickness. A printInstances has at least one subInstance, which represent a plate to be cut by a laser cutter. Main responsibilities of this class are: 1) Managing the subInstances(plates) of the material the printInstance represents. 2) Managing the unplaced shapes which have the material the printInstance represents. 3) Setting the laser cutter (laser cutter and its address) of all its subInstances. 4) Placing and unplacing a shape in a subInstance (plate). 5) Initiate SVG export of all its subInstances (plates). 6) Initiate the laser cutting of all its subInstances (plates)

Author:

Pierre

Field Summary

Fields

Modifier and Type	Field and Description
private int	instancesPrinted Stores the index of the subInstance to be printed.
private Material	material The material the printInstance represents.
private Printer	printer
private int	selected The index of the active subInstance.
private java.util.ArrayList<Shape>	shapes The list of unplaced shapes of the material represented by the printInstance
private java.util.ArrayList<PrintSubInstance>	subInstances The subInstances of the printInstance.

Constructor Summary

Constructors

Constructor and Description
PrintInstance(Shape shape, Material material) Constructs a new printInstance.

Method Summary

Methods

Modifier and Type	Method and Description
(package private) void	addShape(Shape shape) Adds a shape to the list of unplaced shapes of the printInstance
(package private) void	addSubInstance() Add a new subInstance to this printInstance.
(package private) java.lang.String	checkOverlap() This method checks whether placed shapes in its subInstances overlap.
(package private) boolean	checkPlacedShapes() This method checks whether there is a subInstances with placed shapes.
(package private) Material	getMaterial() Returns the material the printInstance represents.
(package private) int	getNumberOfSubInstances() Returns the number of subInstances the printInstance possesses.
(package private) java.util.ArrayList<Shape>	getPlacedShapes() Returns a list of shapes that have been placed in the active subInstance.
(package private) int	getSelectedSubInstance() Returns the index of the subInstance which is active.
private int	getSubInstanceIndex(PrintSubInstance selected) Returns the index of the subInstance belonging to the printInstance.
(package private) java.util.ArrayList<Shape>	getUnplacedShapes() Returns a list of shapes that not have been placed within the printInstance.
(package private) void	placeShape(Shape shape) Places a shape on the active subInstance.
(package private) void	print() Initiates the laser cutting process.
(package private) void	printNext() Initiates the cutting of the next subInstance.
(package private) void	printSVG(java.io.File thePath) Prints all the subInstances (plates) as an SVG.
(package private) void	selectSubInstance(PrintSubInstance selected) Sets which subInstance is active by its index.
(package private) void	setActiveSubInstance(int index) Sets which subInstance is active by its index.
(package private) void	setDPI(int dpi) Sets the DPI setting to be used.
(package private) void	setLaserCutter(LaserCutter cutter, java.lang.String ipAddress) Sets which laser setter to be used and its address.
void	setPrinter(Printer printer)
(package private) void	unplaceShape(Shape shape) Unplaces a shape from the active subInstance.

Methods inherited from class java.lang.Object

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

Field Detail

shapes

private java.util.ArrayList<Shape> shapes

The list of unplaced shapes of the material represented by the printInstance

subInstances

private java.util.ArrayList<PrintSubInstance> subInstances

The subInstances of the printInstance. A subInstance represent a plate to be laser cut of the material the printInstance represents.

material

private Material material

The material the printInstance represents. Entails its type and thickness, as well as the laser cutter parameters to be used for this material.

selected

private int selected

The index of the active subInstance. When a shape is placed it is added to the subInstance with this index. The printDialogWindow shows the placed shapes of subInstance with this index.

instancesPrinted

private int instancesPrinted

Stores the index of the subInstance to be printed.

printer

private Printer printer

Constructor Detail

PrintInstance

PrintInstance(Shape shape,
             Material material)

Constructs a new printInstance. A printInstance represents a material of a certain type and thickness. It is initialised with one empty subInstance, which is the initial active subInstance. Furthermore the material it represents is set and the shapes it manages as well.

Parameters:

shape - The shapes belonging to the printInstance. The shapes have the material and thickness the printInstance represents.

material - The material the printInstance represents. The type of the material and the thickness are entailed in this parameter.

Method Detail

addShape

void addShape(Shape shape)

Adds a shape to the list of unplaced shapes of the printInstance

Parameters:

shape - The shape to be added as unplaced shape

getUnplacedShapes

java.util.ArrayList<Shape> getUnplacedShapes()

Returns a list of shapes that not have been placed within the printInstance.

Returns:

The list of unplaced shapes

getPlacedShapes

java.util.ArrayList<Shape> getPlacedShapes()

Returns a list of shapes that have been placed in the active subInstance. A placed shape is a shape that is placed on a plate and will be cut when the job belonging to the subInstance is send to the laser cutter.

Returns:

The list of placed shapes of the active subInstance.

getMaterial

Material getMaterial()

Returns the material the printInstance represents. It containts information about the type of material, thickness and laser settings which should be used for cutting this material.

Returns:

The material the printInstance represents.

placeShape

void placeShape(Shape shape)

Places a shape on the active subInstance. The shape to be placed is removed from the unplaced shapes of the printInstance and added to the placed shapes of the active subInstance. It is then drawn of the plate which is visible in the printDialogWindow.

Parameters:

shape - Shape to be placed

unplaceShape

void unplaceShape(Shape shape)

Unplaces a shape from the active subInstance. The shape to be removed is removed from the placed shapes of the active subInstance and added to the unplaced shapes of the printInstance. The shapes which was unplaced will ' not be drawn anymore on the plate visible in printDialogWindow.

Parameters:

shape - The shape to be unplaced.

selectSubInstance

void selectSubInstance(PrintSubInstance selected)

Sets which subInstance is active by its index. When a shape is placed, it is added to the active subInstance. The placed Shapes of the active subInstance is shown in the printDialogWindow.

Parameters:

selected - The subInstance to be active

getSubInstanceIndex

private int getSubInstanceIndex(PrintSubInstance selected)

Returns the index of the subInstance belonging to the printInstance. When the subInstance is not found within the printInstance, -1 is returned. Else the index of the printInstance is returned.

Parameters:

selected - The subInstance from which the index is to be returned. The subInstance should belong to the printInstance.

Returns:

The index of the subInstance. This is the index of the subInstance, when the subInstance belongs to the printInstance. Else -1 is returned.

print

void print()

Initiates the laser cutting process. This method calls the print method of the first (subInstance with index 0) subInstance of the printInstance.

printNext

void printNext()

Initiates the cutting of the next subInstance. This method is called by a subInstance of the printInstance and should not be called by any other class. When this method is called, the subInstance signals that it is done with cutting. The method will signal the next subInstance to start the cutting process. When all subInstances are done with cutting, this method signals the (controller?) that the printInstance is done with the cutting process.

printSVG

void printSVG(java.io.File thePath)

Prints all the subInstances (plates) as an SVG. Drawn will be the placed shapes of an subInstance. The SVGs will be exported to the path specified in the parameter. The name of the SVG files are the material type and thickness and the number of the subInstance. This method calls the printSVG method of all its subInstances.

Parameters:

thePath - The path to where the SVG files should be stored.

setPrinter

public void setPrinter(Printer printer)

getNumberOfSubInstances

int getNumberOfSubInstances()

Returns the number of subInstances the printInstance possesses.

Returns:

Number of subInstances in possession

addSubInstance

void addSubInstance()

Add a new subInstance to this printInstance. A subInstance represents a plate to be lasercut. The active subInstance is set to the new subInstance.

setActiveSubInstance

void setActiveSubInstance(int index)

Sets which subInstance is active by its index. When a shape is placed, it is added to the active subInstance. The placed Shapes of the active subInstance is shown in the printDialogWindow.

Parameters:

index - The index of the to be active subInstance

getSelectedSubInstance

int getSelectedSubInstance()

Returns the index of the subInstance which is active. The methods to place and unplace shapes have effect on the subInstance with this index. The placed shapes of the subInstance with this index is shown in the PrintDialogWindow.

Returns:

the index of the active subInstance

checkPlacedShapes

boolean checkPlacedShapes()

This method checks whether there is a subInstances with placed shapes. Returns true when there is at least one subInstance with a least one placed shape. Returns false otherwise.

Returns:

true when there is a subIstance with a placed shape. false otherwise

checkOverlap

java.lang.String checkOverlap()

This method checks whether placed shapes in its subInstances overlap. When there are overlapping shapes, the name of the subInstance where the overlap occured is returned. When there was no overlap, "no overlap" is returned.

Returns:

A string containing the name of subclasses where overlap(s) occurred. When no overlap occurred, then "no overlap" is returned.

setLaserCutter

void setLaserCutter(LaserCutter cutter,
                  java.lang.String ipAddress)

Sets which laser setter to be used and its address. This method passes the laser cutter to be used and its address to all its subInstances.

Parameters:

cutter - The laser cutter to be used for laser cutting.

ipAddress - The address of the laser cutter to be used for laser cutting. Can be an IP address or a port.

setDPI

void setDPI(int dpi)

Sets the DPI setting to be used. This method passes the selected DPI setting to all its subInstances.

Parameters:

dpi - The DPI setting to be used for laser cutting.