com.yworks.yfiles.geometry

Class SizeD

java.lang.Object

com.yworks.yfiles.geometry.SizeD

All Implemented Interfaces:

ISize, com.yworks.yfiles.utils.IStruct, Cloneable

public final class SizeD
extends Object
implements com.yworks.yfiles.utils.IStruct, ISize

An immutable ISize implementation to describe a size in two-dimensional space.

Field Summary

Fields

Modifier and Type	Field and Description
static SizeD	EMPTY The "empty" size that has width and height set to -1.0d.
double	height Gets the height.
static SizeD	INFINITE The "infinite" size that has width and height set to Double.POSITIVE_INFINITY.
double	width Gets the width.
static SizeD	ZERO The "zero" size that has width and height set to 0.0d.

Constructor Summary

Constructors

Constructor and Description
SizeD()
SizeD(double width, double height) Creates a new size using the provided width and height.
SizeD(ISize size) Initializes a new instance of the SizeD struct using the values of the provided ISize.

Method Summary

Modifier and Type	Method and Description
static SizeD	convertFrom(MutableSize size) Performs an implicit conversion from MutableSize to SizeD.
static MutableSize	convertToMutableSize(SizeD size) Performs an explicit conversion from SizeD to MutableSize.
boolean	equals(Object other)
static boolean	equals(SizeD size1, SizeD size2) Implements the operator ==.
double	getArea() Gets the area of this instance which is the product of width and height.
double	getHeight() Gets the height.
double	getWidth() Gets or sets the width.
int	hashCode()
boolean	isEmpty() Gets a value indicating whether this instance is deemed empty.
boolean	isFinite() Gets a value indicating whether this instance is finite.
MutableSize	toMutableSize() Converts this instance to an MutableSize instance.
SizeD	toSizeD() Converts the ISize to a SizeD struct.
String	toString() Returns a human readable string that contains information about the values of this instance.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY

public static final SizeD EMPTY

The "empty" size that has width and height set to -1.0d.

height

public final double height

Gets the height.

Negative values for the height indicate an empty size.

INFINITE

public static final SizeD INFINITE

The "infinite" size that has width and height set to Double.POSITIVE_INFINITY.

width

public final double width

Gets the width.

Negative values for the width indicate an empty size.

ZERO

public static final SizeD ZERO

The "zero" size that has width and height set to 0.0d.

This size is not treated as IsEmpty.

Constructor Detail

SizeD

public SizeD()

SizeD

public SizeD(double width,
             double height)

Creates a new size using the provided width and height.

Parameters:

width - The new width.

height - The new height.

SizeD

public SizeD(ISize size)

Initializes a new instance of the SizeD struct using the values of the provided ISize.

Parameters:

size - The size to get the initial values from.

Method Detail

convertFrom

public static final SizeD convertFrom(MutableSize size)

Performs an implicit conversion from MutableSize to SizeD.

Parameters:

size - The size.

Returns:

The result of the conversion.

convertToMutableSize

public static final MutableSize convertToMutableSize(SizeD size)

Performs an explicit conversion from SizeD to MutableSize.

Parameters:

size - The size.

Returns:

The result of the conversion.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

equals

public static final boolean equals(SizeD size1,
                                   SizeD size2)

Implements the operator ==.

Parameters:

size1 - The first size.

size2 - The second size.

Returns:

The result of the operator, which is true iff the width and height of the two structs are identical.

getArea

public final double getArea()

Gets the area of this instance which is the product of width and height.

Returns:

The area.

getHeight

public final double getHeight()

Gets the height. Negative values for the height indicate an empty size.

Specified by:

getHeight in interface ISize

Returns:

The height.

getWidth

public final double getWidth()

Gets or sets the width. Negative values for the width indicate an empty size.

Specified by:

getWidth in interface ISize

Returns:

The width.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isEmpty

public final boolean isEmpty()

Gets a value indicating whether this instance is deemed empty.

Returns:

true if this at least one of width or height is negative; false otherwise.

isFinite

public final boolean isFinite()

Gets a value indicating whether this instance is finite.

This means that neither width nor height are infinite.

Returns:

true if this instance is finite; false otherwise.

toMutableSize

public final MutableSize toMutableSize()

Converts this instance to an MutableSize instance.

Returns:

The MutableSize instance, whose attributes have been initialized with the values of this instance.

toSizeD

public SizeD toSizeD()

Description copied from interface: ISize

Converts the ISize to a SizeD struct.

Specified by:

toSizeD in interface ISize

Returns:

A SizeD struct that has been initialized with the current values of size.

toString

public String toString()

Returns a human readable string that contains information about the values of this instance.

Overrides:

toString in class Object

Returns:

A String containing the width and height.