ilog.views.dxf

Interface IlvDXFGraphicFactory

All Known Implementing Classes:

IlvDefaultDXFGraphicFactory

public interface IlvDXFGraphicFactory

This factory is in charge with the creation of the graphic objects for the DXF reader.

Since:

JViews 8.0

See Also:

IlvDXFReader, IlvDXFReaderConfigurator

Method Summary

Modifier and Type	Method and Description
void	addObject(IlvGraphic obj, IlvGraphicBag bag) Adds a graphic object to a given graphic bag.
void	addObject(IlvGraphic obj, IlvManager manager, int layerIndex) Adds a graphic object to a given layer of a manager.
IlvGraphic	create3DFace(IlvPoint[] points, Color color) Creates a graphic object for the DXF entity 3DFACE (rendered in 2D).
IlvGraphic	createArc(IlvPoint center, double radius, double startAngle, double angleRange, double thickness, Color color) Creates a graphic object for the DXF entity ARC.
IlvGraphic	createCircle(IlvPoint center, double radius, double thickness, Color color) Creates a graphic object for the DXF entity CIRCLE.
IlvGraphic	createDimension(String text, short type, IlvPoint p0, IlvPoint p1, IlvPoint p2, IlvPoint p3, IlvPoint p4, IlvPoint p5, IlvPoint p6) Creates a graphic object for the DXF entity DIMENSION.
IlvGraphic	createInsert(IlvGraphicVector children, String blockName, Color color) Creates a graphic object containing a set of graphic objects, for the DXF entity INSERT.
IlvGraphic	createLine(IlvPoint from, IlvPoint to, double thickness, Color color) Creates a graphic object for the DXF entity LINE.
IlvGraphic	createPoint(IlvPoint point, double thickness, Color color) Creates a graphic object for the DXF entity POINT.
IlvGraphic	createPolyline(IlvPoint[] points, boolean closed, boolean filled, double thickness, Color color) Creates a graphic object for the DXF entities POLYLINE, LWPOLYLINE, SOLID, 3DFACE.
IlvGraphic	createSolid(IlvPoint[] points, double thickness, Color color) Creates a graphic object for the DXF entity SOLID.
IlvGraphic	createSpline(IlvPoint[] points, boolean closed, double thickness, Color color) Creates a graphic object for the DXF entity SPLINE.
IlvGraphic	createText(IlvPoint location, String text, boolean underlined, boolean antialiased, Font font, Color color) Creates a graphic object for the DXF entities TEXT and MTEXT.
IlvGraphic	createTrace(IlvPoint[] points, double thickness, Color color) Creates a graphic object for the DXF entity TRACE.
IlvManagerLayer	prepareLayer(IlvManager manager, String layerName) Prepares a manager layer.

Method Detail

addObject

void addObject(IlvGraphic obj,
               IlvManager manager,
               int layerIndex)

Adds a graphic object to a given layer of a manager.

The DXF reader calls this method if the contents of the DXF file is read into an IlvManager or a subclass. Otherwise, if the read is done in another type of IlvGraphicBag, for instance in an IlvGraphicSet, the reader calls the method addObject(IlvGraphic, IlvGraphicBag) instead.

Parameters:

obj - The graphic object to be added to the manager.

manager - The manager into which the contents of the DXF file is read.

layerIndex - The index of the manager layer where the object must be added.

addObject

void addObject(IlvGraphic obj,
               IlvGraphicBag bag)

Adds a graphic object to a given graphic bag.

The DXF reader calls this method if the contents of the DXF file is read into a IlvGraphicBag which is not an IlvManager or a subclass, for instance an IlvGraphicSet. Otherwise, if the read is done in an IlvManager or a subclass, the reader calls the method addObject(IlvGraphic, IlvManager, int) instead.

Parameters:

obj - The graphic object to be added to the bag.

bag - The bag where the graphic object must be added.

prepareLayer

IlvManagerLayer prepareLayer(IlvManager manager,
                             String layerName)

Prepares a manager layer.

The implementation is free to either create a new layer on top of the existing ones, or return an existing layer. It must also set the name of this layer (see IlvManager.setLayerName(int, String)).

Notice the following:

• The method is called once for each layer described by the DXF file, in the order of the layer table in the DXF file.
• For adding to the manager the objects which belong to a given layer, the reader passes as layerIndex argument of the method addObject(IlvGraphic, IlvManager, int) the index of the layer (see IlvManagerLayer.getIndex()) returned by the method prepareLayer for the corresponding layer.

Parameters:

manager - The manager into which the contents of the DXF file is read.

layerName - The name of the layer as read in the DXF file.

Returns:

The layer of the manager where the entities of the DXF file that belong to the layer named layerName must be added.

createPoint

IlvGraphic createPoint(IlvPoint point,
                       double thickness,
                       Color color)

Creates a graphic object for the DXF entity POINT.

Parameters:

point - The location of the point.

thickness - The thickness of the point.

color - The color of the point.

Returns:

The created graphic object. The method can return null if no graphic object should be created for the corresponding DXF entity.

createLine

IlvGraphic createLine(IlvPoint from,
                      IlvPoint to,
                      double thickness,
                      Color color)

Creates a graphic object for the DXF entity LINE.

Parameters:

from - The starting point of the line.

to - The ending point of the line.

thickness - The thickness of the line.

color - The color of the line.

Returns:

The created graphic object. The method can return null if no graphic object should be created for the corresponding DXF entity.

createArc

IlvGraphic createArc(IlvPoint center,
                     double radius,
                     double startAngle,
                     double angleRange,
                     double thickness,
                     Color color)

Creates a graphic object for the DXF entity ARC.

Parameters:

center - The center of the arc.

radius - The radius of the arc.

startAngle - The start angle of the arc in degrees.

angleRange - The angle range of the arc in degrees.

thickness - The thickness of the arc.

color - The color of the arc.

Returns:

The created graphic object.

createCircle

IlvGraphic createCircle(IlvPoint center,
                        double radius,
                        double thickness,
                        Color color)

Creates a graphic object for the DXF entity CIRCLE.

Parameters:

center - The center of the circle.

radius - The radius of the circle.

thickness - The thickness of the circle.

color - The color of the circle.

Returns:

The created graphic object. The method can return null if no graphic object should be created for the corresponding DXF entity.

createPolyline

IlvGraphic createPolyline(IlvPoint[] points,
                          boolean closed,
                          boolean filled,
                          double thickness,
                          Color color)

Creates a graphic object for the DXF entities POLYLINE, LWPOLYLINE, SOLID, 3DFACE.

Parameters:

points - The array of points defining the polyline.

closed - Indicates whether the polyline is closed (in this case, the first and last points in the array of points have equal coordinates).

filled - Indicates whether the interior of the polyline is filled.

thickness - The thickness of the polyline.

color - The color of the polyline.

Returns:

The created graphic object. The method can return null if no graphic object should be created for the corresponding DXF entity.

createTrace

IlvGraphic createTrace(IlvPoint[] points,
                       double thickness,
                       Color color)

Creates a graphic object for the DXF entity TRACE.

Parameters:

points - The array of points defining the trace.

thickness - The thickness of the trace.

color - The color of the trace.

Returns:

The created graphic object. The method can return null if no graphic object should be created for the corresponding DXF entity.

createSolid

IlvGraphic createSolid(IlvPoint[] points,
                       double thickness,
                       Color color)

Creates a graphic object for the DXF entity SOLID.

Parameters:

points - The array of points defining the solid.

thickness - The thickness of the solid.

color - The color of the solid.

Returns:

The created graphic object. The method can return null if no graphic object should be created for the corresponding DXF entity.

create3DFace

IlvGraphic create3DFace(IlvPoint[] points,
                        Color color)

Creates a graphic object for the DXF entity 3DFACE (rendered in 2D).

Parameters:

points - The array of points defining the 3D face.

color - The color of the 3D face.

Returns:

The created graphic object. The method can return null if no graphic object should be created for the corresponding DXF entity.

createSpline

IlvGraphic createSpline(IlvPoint[] points,
                        boolean closed,
                        double thickness,
                        Color color)

Creates a graphic object for the DXF entity SPLINE.

Parameters:

points - The array of points defining the control points of the spline.

closed - Indicates whether the spline is closed.

thickness - The thickness of the spline.

color - The color of the spline.

Returns:

The created graphic object. The method can return null if no graphic object should be created for the corresponding DXF entity.

createText

IlvGraphic createText(IlvPoint location,
                      String text,
                      boolean underlined,
                      boolean antialiased,
                      Font font,
                      Color color)

Creates a graphic object for the DXF entities TEXT and MTEXT.

Parameters:

location - The location of the text.

text - The text to be shown.

underlined - Tells whether the text must be underlined.

antialiased - Tells whether the text must be antialiased.

font - The font of the text.

color - The color of the text.

Returns:

The created graphic object. The method can return null if no graphic object should be created for the corresponding DXF entity.

createDimension

IlvGraphic createDimension(String text,
                           short type,
                           IlvPoint p0,
                           IlvPoint p1,
                           IlvPoint p2,
                           IlvPoint p3,
                           IlvPoint p4,
                           IlvPoint p5,
                           IlvPoint p6)

Creates a graphic object for the DXF entity DIMENSION.

Parameters:

text - The text of the dimension.

type - The dimension type. See the Autodesk documentation of the DXF format: Values 0-6 are integer values that represent the dimension type. Values 32, 64, and 128 are bit values, which are added to the integer values (value 32 is always set in R13 and later releases).
0 = Rotated, horizontal, or vertical; 1 = Aligned
2 = Angular; 3 = Diameter; 4 = Radius
5 = Angular 3 point; 6 = Ordinate
32 = Indicates that the block reference (group code 2) is referenced by this dimension only
64 = Ordinate type. This is a bit value (bit 7) used only with integer value 6. If set, ordinate is X-type; if not set, ordinate is Y-type
128 = This is a bit value (bit 8) added to the other group 70 values if the dimension text has been positioned at a user-defined location rather than at the default location

p0 - Definition point.

p1 - Middle point.

p2 - Insertion point.

p3 - Definition point for linear and angular dimensions.

p4 - Definition point for linear and angular dimensions.

p5 - Definition point for diameter, radius, and angular dimensions.

p6 - Point defining dimension arc for angular dimensions.

Returns:

The created graphic object. The method can return null if no graphic object should be created for the corresponding DXF entity.

createInsert

IlvGraphic createInsert(IlvGraphicVector children,
                        String blockName,
                        Color color)

Creates a graphic object containing a set of graphic objects, for the DXF entity INSERT.

Parameters:

children - The graphic objects contained in the insert.

blockName - The name of the DXF BLOCK, as read in the DXF file.

color - The color of the insert.

Returns:

The created graphic object. The method can return null if no graphic object should be created for the corresponding DXF entity.