org.girod.javafx.svgimage

Class Viewport

java.lang.Object

org.girod.javafx.svgimage.Viewbox

org.girod.javafx.svgimage.Viewport

public class Viewport
extends Viewbox

Represents the viewport.

Field Summary

Fields inherited from class org.girod.javafx.svgimage.Viewbox

hasWidthAndHeight, height, preserveAspectRatio, viewboxHeight, viewboxWidth, viewboxX, viewboxY, width

Constructor Summary

Constructors

Constructor and Description
Viewport() Create a viewport without explicit width or height.
Viewport(double width, double height) Create a viewport with explicit width and height.

Method Summary

Modifier and Type	Method and Description
double	getBestHeight() Return the height.
double	getBestWidth() Return the "best" width.
double	getDefaultPosition(double defaultValue, boolean isWidth) Return a default position.
javafx.geometry.Rectangle2D	getRectangle2D() Return the Rectangle2D associated with the Viewport.
double	getScale() Return the scale.
boolean	isScaled() Return true if lengths must be scaled.
boolean	isScalingLineWidth() Return true if line widths must be scaled.
double	scaleLength(double length) Scale a length value.
double	scaleLineWidth(double width) Scale a line width.
double	scalePosition(double value, boolean isWidth) Scale a position value.
void	scaleShape(javafx.scene.shape.Shape shape) Scale a shape.
void	setScale(double scale, boolean scaleLineWidth) Set the scale value.

Methods inherited from class org.girod.javafx.svgimage.Viewbox

getHeight, getViewboxHeight, getViewboxWidth, getViewboxX, getViewboxY, getWidth, hasWidthAndHeight, isPreservingAspectRatio, scaleNode, scaleValue, setPreserveAspectRatio, setViewbox

Methods inherited from class java.lang.Object

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

Constructor Detail

Viewport

public Viewport(double width,
                double height)

Create a viewport with explicit width and height.

Parameters:

width - the width

height - the height

Viewport

public Viewport()

Create a viewport without explicit width or height.

Method Detail

getBestWidth

public double getBestWidth()

Return the "best" width. It will return the width if it exists, else it will be the viewBox width.

Returns:

the width

getBestHeight

public double getBestHeight()

Return the height. It will return the height if it exists, else it will be the viewBox height.

Returns:

the height

getRectangle2D

public javafx.geometry.Rectangle2D getRectangle2D()

Return the Rectangle2D associated with the Viewport.

Returns:

the Rectangle2D

scaleShape

public void scaleShape(javafx.scene.shape.Shape shape)

Scale a shape.

Parameters:

shape - the shape

getDefaultPosition

public double getDefaultPosition(double defaultValue,
                                 boolean isWidth)

Return a default position. Note that for the moment, this method returns the input value.

Parameters:

defaultValue - the default position value

isWidth - true for a width

Returns:

the default position

scalePosition

public double scalePosition(double value,
                            boolean isWidth)

Scale a position value.

Parameters:

value - the position

isWidth - true for a widgdth coordinate

Returns:

the scaled position

scaleLength

public double scaleLength(double length)

Scale a length value.

Parameters:

length - the length

Returns:

the scaled length

scaleLineWidth

public double scaleLineWidth(double width)

Scale a line width.

Parameters:

width - the line width.

Returns:

the scaled line width

setScale

public void setScale(double scale,
                     boolean scaleLineWidth)

Set the scale value.

Parameters:

scale - the scale

scaleLineWidth - true if line widths must also be scaled

getScale

public double getScale()

Return the scale.

Returns:

the scale

isScaled

public boolean isScaled()

Return true if lengths must be scaled.

Returns:

true if lengths must be scaled

isScalingLineWidth

public boolean isScalingLineWidth()

Return true if line widths must be scaled.

Returns:

true if line widths must be scaled