A B C E F G H M O R S T U V W
All Classes All Packages

A

Adapter<T,V> - Interface in fold.custom

Helper interface to provide a contract to classes which can convert from T to V and back.

addEdge(Edge) - Method in class fold.model.FoldFrame

B

BORDER - fold.model.FoldEdgeAssignment

Border/boundary edge

C

convert(T, V) - Method in interface fold.custom.Adapter

Convert from type T to type V.

convertBack(V, T) - Method in interface fold.custom.Adapter

Convert from type V to type T.

CreasePatternReader - Class in fold.io

Read Crease Pattern .cp files.

CreasePatternReader(InputStream) - Constructor for class fold.io.CreasePatternReader

CreasePatternWriter - Class in fold.io

Write Crease Pattern .cp files.

CreasePatternWriter(OutputStream) - Constructor for class fold.io.CreasePatternWriter

CustomFoldReader<T extends FoldFile> - Class in fold.io

Custom fold Reader, writes a subclass of FoldFile.

CustomFoldReader(Class<T>, InputStream) - Constructor for class fold.io.CustomFoldReader

Create a new CustomFoldReader instance.

CustomFoldWriter<T extends FoldFile> - Class in fold.io

Custom fold writer, also writes subclasses of FoldFile.

CustomFoldWriter(OutputStream) - Constructor for class fold.io.CustomFoldWriter

Create a new CustomFoldWriter instance.

CustomListField<T,V extends Enum<V>> - Class in fold.custom

Use this class to define a custom list field in your extension of fold.

CustomListField(String, Class<V>, Adapter<Map<V, Object>, T>) - Constructor for class fold.custom.CustomListField

Create a new CustomFieldList instance.

E

Edge - Class in fold.model

Describes an edge between two Vertex objects.

Edge() - Constructor for class fold.model.Edge

Edge(FoldEdgeAssignment, Vertex, Vertex) - Constructor for class fold.model.Edge

EdgeOrder() - Constructor for class fold.model.FoldFrame.EdgeOrder

equals(Object) - Method in class fold.model.Edge

equals(Object) - Method in class fold.model.FoldFile

equals(Object) - Method in class fold.model.FoldFrame

equals(Object) - Method in class fold.model.Vertex

F

Face - Class in fold.model

A face consists of a list of Vertex and a list of Edge.

Face() - Constructor for class fold.model.Face

FaceOrder() - Constructor for class fold.model.FoldFrame.FaceOrder

FLAT_FOLD - fold.model.FoldEdgeAssignment

Flat (unfolded) fold

fold.custom - package fold.custom

Classes in this package can be used to create a fold parser with custom fields.

fold.io - package fold.io

Module for reading and writing fold files.

fold.model - package fold.model

Holds the object model for fold files in Java.

FoldEdgeAssignment - Enum in fold.model

For an edge, representing its fold direction assignment.

FoldFile - Class in fold.model

The Java representation of a fold file.

FoldFile() - Constructor for class fold.model.FoldFile

FoldFileFormatException - Exception in fold.io

Generic exception thrown when fold file reading or writing fails.

FoldFileFormatException(IOException) - Constructor for exception fold.io.FoldFileFormatException

Create a new FoldFileFormatException from an IOException.

FoldFileFormatException(String) - Constructor for exception fold.io.FoldFileFormatException

Create a new FoldFileFormatException.

FoldFrame - Class in fold.model

A single frame in a fold file.

FoldFrame() - Constructor for class fold.model.FoldFrame

FoldFrame.EdgeOrder - Class in fold.model

Given two edges this class defines the stacking order of these edges.

FoldFrame.FaceOrder - Class in fold.model

Given two faces this class defines the order of the two faces.

FoldReader - Class in fold.io

Default fold reader, reads an InputStream into a FoldFile.

FoldReader(InputStream) - Constructor for class fold.io.FoldReader

Create a new FoldReader from an InputStream.

FoldWriter - Class in fold.io

Default fold writer, writes a FoldFile into an OutputStream.

FoldWriter(OutputStream) - Constructor for class fold.io.FoldWriter

Create a new FoldWriter which writes to an OutputStream.

G

getAssignment() - Method in class fold.model.Edge

For each edge, a string representing its fold direction assignment: "B": border/boundary edge (only one incident face).

getAttributes() - Method in class fold.model.FoldFrame

Attributes that objectively describe properties of the folded structure being represented (array of strings).

getAuthor() - Method in class fold.model.FoldFile

The human author.

getAuthor() - Method in class fold.model.FoldFrame

The human author.

getClasses() - Method in class fold.model.FoldFile

A subjective interpretation about what the entire file represents.

getClasses() - Method in class fold.model.FoldFrame

A subjective interpretation about what the frame represents.

getCreator() - Method in class fold.model.FoldFile

The software that created the file.

getCustomProperty(String, String) - Method in class fold.model.FoldFile

Get a single custom property from the custom properties map.

getCustomPropertyMap() - Method in class fold.model.FoldFile

Custom properties.

getDescription() - Method in class fold.model.FoldFile

A description of the entire file.

getDescription() - Method in class fold.model.FoldFrame

A description of the frame.

getEdge1() - Method in class fold.model.FoldFrame.EdgeOrder

Get the first edge of this definition.

getEdge1AboveEdge2() - Method in class fold.model.FoldFrame.EdgeOrder

Get if edge1 lies above edge2.

getEdge2() - Method in class fold.model.FoldFrame.EdgeOrder

Get the second edge of this definition.

getEdgeOrders() - Method in class fold.model.FoldFrame

Get the edge orders of this frame.

getEdges() - Method in class fold.model.Face

Get the list of edges for this face.

getEdges() - Method in class fold.model.FoldFrame

Get the list of edges in this frame.

getEnd() - Method in class fold.model.Edge

Set the start vertex of this edge.

getFace1() - Method in class fold.model.FoldFrame.FaceOrder

Get the first face of this definition.

getFace1AboveFace2() - Method in class fold.model.FoldFrame.FaceOrder

Get if face1 lies above face2.

getFace2() - Method in class fold.model.FoldFrame.FaceOrder

Get the second face of this definition.

getFaceOrders() - Method in class fold.model.FoldFrame

Get the face orders of this frame.

getFaces() - Method in class fold.model.FoldFrame

Get the list of faces in this frame.

getFaces() - Method in class fold.model.Vertex

Get all the faces this vertex is part of.

getFoldAngle() - Method in class fold.model.Edge

Get the angle of this fold.

getFrames() - Method in class fold.model.FoldFile

Array of frame dictionaries.

getInherit() - Method in class fold.model.FoldFrame

Boolean.

getLength() - Method in class fold.model.Edge

Get the length of this edge.

getLetter() - Method in enum fold.model.FoldEdgeAssignment

Get the letter associated with this FoldEdgeAssignment, corresponds to the value in the actual fold file.

getParent() - Method in class fold.model.FoldFrame

Parent frame ID.

getRootFrame() - Method in class fold.model.FoldFile

Get the root frame of this file.

getSpec() - Method in class fold.model.FoldFile

The version of the FOLD specification that the file assumes.

getStart() - Method in class fold.model.Edge

Get the start vertex of this edge.

getTitle() - Method in class fold.model.FoldFile

A title for the entire file.

getTitle() - Method in class fold.model.FoldFrame

A title for the frame.

getUnit() - Method in class fold.model.FoldFrame

Physical or logical unit that all coordinates are relative to (a string).

getValue(Map<String, Object>) - Method in class fold.custom.CustomListField

Obtain a list of T from the custom properties map in a fold object.

getVertices() - Method in class fold.model.Face

Get the list of vertices in this face.

getVertices() - Method in class fold.model.FoldFrame

Get the list of vertices in this frame.

getVertices() - Method in class fold.model.Vertex

Get all vertices that are adjacent to this vertex.

getX() - Method in class fold.model.Vertex

Get the x coordinate of this vertex.

getY() - Method in class fold.model.Vertex

Get the y coordinate of this vertex.

getZ() - Method in class fold.model.Vertex

Get the z coordinate of this vertex.

H

hashCode() - Method in class fold.model.Edge

hashCode() - Method in class fold.model.FoldFile

hashCode() - Method in class fold.model.FoldFrame

hashCode() - Method in class fold.model.Vertex

M

MOUNTAIN_FOLD - fold.model.FoldEdgeAssignment

Mountain fold

O

of(String) - Static method in enum fold.model.FoldEdgeAssignment

Create a new instance using the letter saved in the fold file.

R

read() - Method in class fold.io.CreasePatternReader

Read a .cp crease pattern file.

read() - Method in class fold.io.CustomFoldReader

Read a FoldFile from the given inputStream

removeCustomProperty(String, String) - Method in class fold.model.FoldFile

Remove a single custom property from the custom properties map.

S

setAssignment(FoldEdgeAssignment) - Method in class fold.model.Edge

Set the assignment of this edge.

setAttributes(List<String>) - Method in class fold.model.FoldFrame

Set the attributes for this frame.

setAuthor(String) - Method in class fold.model.FoldFile

Set the human author.

setAuthor(String) - Method in class fold.model.FoldFrame

Set the human author for this frame.

setClasses(List<String>) - Method in class fold.model.FoldFile

Set the classes for this file.

setClasses(List<String>) - Method in class fold.model.FoldFrame

Set the classes for this frame.

setCreator(String) - Method in class fold.model.FoldFile

Set the software that created the file.

setCustomProperty(String, String, Object) - Method in class fold.model.FoldFile

Set a single custom property in the custom properties map.

setDescription(String) - Method in class fold.model.FoldFile

Set the description for the file.

setDescription(String) - Method in class fold.model.FoldFrame

Set the description for this frame.

setEdge1(Edge) - Method in class fold.model.FoldFrame.EdgeOrder

Set the first edge of this definition.

setEdge1AboveEdge2(Boolean) - Method in class fold.model.FoldFrame.EdgeOrder

Set if edge1 lies above edge2.

setEdge2(Edge) - Method in class fold.model.FoldFrame.EdgeOrder

Set the second edge of this definition.

setEdgeOrders(List<FoldFrame.EdgeOrder>) - Method in class fold.model.FoldFrame

Set the edge orders for this frame.

setEdges(List<Edge>) - Method in class fold.model.Face

Set the list of edges for this face.

setEdges(List<Edge>) - Method in class fold.model.FoldFrame

Set the list of edges for this frame.

setEnd(Vertex) - Method in class fold.model.Edge

Set the end vertex of this edge.

setFace1(Face) - Method in class fold.model.FoldFrame.FaceOrder

Set the first face of this definition.

setFace1AboveFace2(Boolean) - Method in class fold.model.FoldFrame.FaceOrder

Set if face1 lies above face2.

setFace2(Face) - Method in class fold.model.FoldFrame.FaceOrder

Set the second face of this definition.

setFaceOrders(List<FoldFrame.FaceOrder>) - Method in class fold.model.FoldFrame

Set the face orders for this frame.

setFaces(List<Face>) - Method in class fold.model.FoldFrame

Set the list of faces for this frame.

setFaces(List<Face>) - Method in class fold.model.Vertex

Set the faces this vertex is part of.

setFoldAngle(Double) - Method in class fold.model.Edge

Set the angle of this fold.

setFrames(List<FoldFrame>) - Method in class fold.model.FoldFile

Set the sub frames for this file.

setInherit(Boolean) - Method in class fold.model.FoldFrame

Set if this frame inherits any properties from the parent frame.

setLength(Double) - Method in class fold.model.Edge

Set the length of this edge.

setParent(Integer) - Method in class fold.model.FoldFrame

Set the parent id for this frame.

setRootFrame(FoldFrame) - Method in class fold.model.FoldFile

Set the root frame of this file.

setSpec(double) - Method in class fold.model.FoldFile

Set the version of the FOLD specification.

setStart(Vertex) - Method in class fold.model.Edge

Set the start vertex of this edge.

setTitle(String) - Method in class fold.model.FoldFile

Set the title for the file.

setTitle(String) - Method in class fold.model.FoldFrame

Set the title for this frame.

setUnit(String) - Method in class fold.model.FoldFrame

Set the unit for this frame.

setValue(Map<String, Object>, List<T>) - Method in class fold.custom.CustomListField

Set the value in the custom properties map of a fold file.

setVertices(List<Vertex>) - Method in class fold.model.Face

Set the list of vertices in this face.

setVertices(List<Vertex>) - Method in class fold.model.FoldFrame

Set the list of vertices for this frame.

setVertices(List<Vertex>) - Method in class fold.model.Vertex

Set the vertices that are adjacent to this vertex.

setX(Double) - Method in class fold.model.Vertex

Set the x coordinate of this vertex.

setY(Double) - Method in class fold.model.Vertex

Set the y coordinate of this vertex.

setZ(Double) - Method in class fold.model.Vertex

Set the z coordinate of this vertex.

T

toString() - Method in class fold.model.Edge

toString() - Method in class fold.model.Vertex

U

UNASSIGNED - fold.model.FoldEdgeAssignment

Unassigned/unknown

V

VALLEY_FOLD - fold.model.FoldEdgeAssignment

Valley fold

valueOf(String) - Static method in enum fold.model.FoldEdgeAssignment

Returns the enum constant of this type with the specified name.

values() - Static method in enum fold.model.FoldEdgeAssignment

Returns an array containing the constants of this enum type, in the order they are declared.

Vertex - Class in fold.model

Holds a coordinate, a vertex is part of a list of Face it is part of and a list of Vertex which are adjacent.

Vertex() - Constructor for class fold.model.Vertex

Vertex(Double, Double) - Constructor for class fold.model.Vertex

W

write(FoldFile) - Method in class fold.io.CreasePatternWriter

Write a fold file object to a crease pattern file.

write(T) - Method in class fold.io.CustomFoldWriter

Write the FoldFile to the outputStream.

A B C E F G H M O R S T U V W
All Classes All Packages