net.sf.latexdraw.glib.models.interfaces
Interface IDot

All Superinterfaces:
Dottable, IArrowable, IPositionShape, IShape, Modifiable
All Known Implementing Classes:
LDot

public interface IDot
extends IPositionShape, Dottable

Defines an interface that classes defining a dot should implement.

This file is part of LaTeXDraw.
Copyright (c) 2005-2012 Arnaud BLOUIN

LaTeXDraw is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
LaTeXDraw is distributed without any warranty; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

07/03/2009

Since:
3.0
Version:
3.0
Author:
Arnaud BLOUIN

Nested Class Summary
static class IDot.DotStyle
          The different styles of dot.
 
Nested classes/interfaces inherited from interface net.sf.latexdraw.glib.models.interfaces.IShape
IShape.BorderPos, IShape.FillingStyle, IShape.LineStyle, IShape.Position
 
Field Summary
static double PLUS_COEFF_WIDTH
          The thickness of the plus shape is computed with that coefficient.
static double THICKNESS_O_STYLE_FACTOR
          Useful to calculate the thickness of dot with the o style.
 
Fields inherited from interface net.sf.latexdraw.glib.models.interfaces.IShape
GOLDEN_ANGLE, PPC
 
Method Summary
 IDot duplicate()
          Creates a duplicate of the shape (however id are not the same).
 double getBarGap()
           
 double getBarThickness()
           
 double getCrossGap()
           
 double getGeneralGap()
           
 IPoint getLazyBottomRightPoint()
          While getBottomRightPoint takes care about the current shape of the dot to compute the bottom right point, this function computes the bottom right point only using the centre and the width of the dot which are the same for all the dot styles
 IPoint getLazyTopLeftPoint()
          While getTopLeftPoint takes care about the current shape of the dot to compute the top left point, this function computes the top left point only using the centre and the width of the dot which are the same for all the dot styles
 double getOGap()
           
 double getPlusGap()
           
 
Methods inherited from interface net.sf.latexdraw.glib.models.interfaces.IPositionShape
getPosition, getX, getY, setPosition, setPosition, setX, setY
 
Methods inherited from interface net.sf.latexdraw.glib.models.interfaces.IShape
addToRotationAngle, copy, getArrowAt, getArrowLine, getArrows, getArrowStyle, getBorderGap, getBordersPosition, getBottomLeftPoint, getBottomRightPoint, getDashSepBlack, getDashSepWhite, getDbleBordCol, getDbleBordSep, getDotSep, getFillingCol, getFillingStyle, getFullBottomRightPoint, getFullTopLeftPoint, getGradAngle, getGradColEnd, getGradColStart, getGradMidPt, getGravityCentre, getHatchingsAngle, getHatchingsCol, getHatchingsSep, getHatchingsWidth, getId, getLineColour, getLineStyle, getNbPoints, getOpacity, getPoints, getPtAt, getRotationAngle, getShadowAngle, getShadowCol, getShadowGap, getShadowSize, getThickness, getTopLeftPoint, getTopRightPoint, hasDbleBord, hasGradient, hasHatchings, hasShadow, isArrowable, isBordersMovable, isColourable, isDbleBorderable, isFillable, isFilled, isInteriorStylable, isLineStylable, isParametersEquals, isShadowable, isShowPts, isShowPtsable, isThicknessable, mirrorHorizontal, mirrorVertical, rotate, scale, setArrowStyle, setBordersPosition, setDashSepBlack, setDashSepWhite, setDbleBordCol, setDbleBordSep, setDotSep, setFilled, setFillingCol, setFillingStyle, setGradAngle, setGradColEnd, setGradColStart, setGradMidPt, setHasDbleBord, setHasShadow, setHatchingsAngle, setHatchingsCol, setHatchingsSep, setHatchingsWidth, setId, setLineColour, setLineStyle, setNewId, setOpacity, setRotationAngle, setShadowAngle, setShadowCol, setShadowSize, setShowPts, setThickness, shadowFillsShape, translate
 
Methods inherited from interface org.malai.properties.Modifiable
isModified, setModified
 
Methods inherited from interface net.sf.latexdraw.glib.models.interfaces.IArrowable
getArrowInset, getArrowLength, getArrowSizeDim, getArrowSizeNum, getBracketNum, getDotSizeDim, getDotSizeNum, getRBracketNum, getTBarSizeDim, getTBarSizeNum, setArrowInset, setArrowLength, setArrowSizeDim, setArrowSizeNum, setBracketNum, setDotSizeDim, setDotSizeNum, setRBracketNum, setTBarSizeDim, setTBarSizeNum
 
Methods inherited from interface net.sf.latexdraw.glib.models.interfaces.Dottable
getDotFillingCol, getDotStyle, getRadius, hasDot, isFillable, setDotFillingCol, setDotStyle, setRadius
 

Field Detail

THICKNESS_O_STYLE_FACTOR

static final double THICKNESS_O_STYLE_FACTOR
Useful to calculate the thickness of dot with the o style.

See Also:
Constant Field Values

PLUS_COEFF_WIDTH

static final double PLUS_COEFF_WIDTH
The thickness of the plus shape is computed with that coefficient.

See Also:
Constant Field Values
Method Detail

duplicate

IDot duplicate()
Description copied from interface: IShape
Creates a duplicate of the shape (however id are not the same).

Specified by:
duplicate in interface IShape
Returns:
The duplicata.

getLazyTopLeftPoint

IPoint getLazyTopLeftPoint()
While getTopLeftPoint takes care about the current shape of the dot to compute the top left point, this function computes the top left point only using the centre and the width of the dot which are the same for all the dot styles

Returns:
The top left point of the dot.
Since:
3.0

getLazyBottomRightPoint

IPoint getLazyBottomRightPoint()
While getBottomRightPoint takes care about the current shape of the dot to compute the bottom right point, this function computes the bottom right point only using the centre and the width of the dot which are the same for all the dot styles

Returns:
The top bottom right of the dot.
Since:
3.0

getPlusGap

double getPlusGap()
Returns:
The gap used to create plus-shaped dots.
Since:
3.0

getCrossGap

double getCrossGap()
Returns:
The gap used to create cross-shaped dots.
Since:
3.0

getBarGap

double getBarGap()
Returns:
The gap used to create bar-shaped dots.
Since:
3.0

getBarThickness

double getBarThickness()
Returns:
The thickness used to create bar-shaped dots.
Since:
3.0

getGeneralGap

double getGeneralGap()
Returns:
The gap used to compute the shape of several kinds of dot.
Since:
3.0

getOGap

double getOGap()
Returns:
The gap used to create O-shaped dots.
Since:
3.0