Class ScaleByPixels

java.lang.Object

is.galia.operation.Scale

is.galia.operation.ScaleByPixels

All Implemented Interfaces:

Operation

public class ScaleByPixels
extends Scale
implements Operation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ScaleByPixels.Mode

Nested classes/interfaces inherited from class is.galia.operation.Scale

Scale.Filter

Constructor Summary

Constructors

Constructor	Description
ScaleByPixels()	No-op constructor.
ScaleByPixels(Integer width, Integer height, ScaleByPixels.Mode mode)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Integer	getHeight()	This should not be used when figuring out how to apply an instance to an image.
ScaleByPixels.Mode	getMode()
ReductionFactor	getReductionFactor(Size reducedSize, ScaleConstraint scaleConstraint, int maxFactor)
double[]	getResultingScales(Size fullSize, ScaleConstraint scaleConstraint)
Size	getResultingSize(Size imageSize, ReductionFactor reductionFactor, ScaleConstraint scaleConstraint)
Integer	getWidth()	This should not be used when figuring out how to apply an instance to an image.
boolean	hasEffect()	Simpler but less-accurate counterpart of Operation.hasEffect(Size, OperationList).
boolean	hasEffect(Size fullSize, OperationList opList)	Context-aware counterpart to Operation.hasEffect().
int	hashCode()
void	setHeight(Integer height)
void	setMode(ScaleByPixels.Mode scaleMode)
void	setWidth(Integer width)
String	toString()	Returns a string representation of the instance, guaranteed to uniquely represent the instance.

Methods inherited from class is.galia.operation.Scale

freeze, getFilter, getResultingSize, isHeightUp, isLinear, isUp, isWidthUp, setFilter, setLinear, toMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface is.galia.operation.Operation

freeze, getResultingSize, toMap, validate

Constructor Details

ScaleByPixels

public ScaleByPixels()

No-op constructor.

ScaleByPixels

public ScaleByPixels(Integer width,
 Integer height,
 ScaleByPixels.Mode mode)

Parameters:

width - May be null if mode is ScaleByPixels.Mode.ASPECT_FIT_HEIGHT.

height - May be null if mode is ScaleByPixels.Mode.ASPECT_FIT_WIDTH.

mode - Scale mode.

Method Details

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getHeight

public Integer getHeight()

This should not be used when figuring out how to apply an instance to an image. For that, getResultingSize(is.galia.image.Size, is.galia.image.ReductionFactor, is.galia.image.ScaleConstraint) and getResultingScales(is.galia.image.Size, is.galia.image.ScaleConstraint) should be used instead.

Returns:

Absolute pixel height. May be null.

getMode

public ScaleByPixels.Mode getMode()

getReductionFactor

public ReductionFactor getReductionFactor(Size reducedSize,
 ScaleConstraint scaleConstraint,
 int maxFactor)

Specified by:

getReductionFactor in class Scale

Parameters:

reducedSize - Size of an image that has been halved n times.

scaleConstraint - Ignored.

maxFactor - Maximum factor to return.

Returns:

Reduction factor appropriate for the instance.

getResultingScales

public double[] getResultingScales(Size fullSize,
 ScaleConstraint scaleConstraint)

Specified by:

getResultingScales in class Scale

Parameters:

fullSize - Full source image dimensions.

scaleConstraint - Scale constraint relative to the full source image dimensions. The instance is expressed relative to the constrained fullSize.

Returns:

Two-element array containing the resulting X and Y scales when the instance is applied to the given full size.

getResultingSize

public Size getResultingSize(Size imageSize,
 ReductionFactor reductionFactor,
 ScaleConstraint scaleConstraint)

Specified by:

getResultingSize in class Scale

Parameters:

imageSize - Image whose dimensions have been halved ReductionFactor.factor times.

reductionFactor - Number of times the given dimensions have been halved.

scaleConstraint - Scale constraint relative to the full source image dimensions.

Returns:

Resulting dimensions when the scale is applied to the constrained view of the given full size.

getWidth

public Integer getWidth()

This should not be used when figuring out how to apply an instance to an image. For that, getResultingSize(is.galia.image.Size, is.galia.image.ReductionFactor, is.galia.image.ScaleConstraint) and getResultingScales(is.galia.image.Size, is.galia.image.ScaleConstraint) should be used instead.

Returns:

Absolute pixel width. May be null.

hasEffect

public boolean hasEffect()

Description copied from interface: Operation

Simpler but less-accurate counterpart of Operation.hasEffect(Size, OperationList).

Specified by:

hasEffect in interface Operation

Returns:

Whether applying the operation on its own would result in a changed image.

hasEffect

public boolean hasEffect(Size fullSize,
 OperationList opList)

Description copied from interface: Operation

Context-aware counterpart to Operation.hasEffect(). For example, a scale operation specifying a scale to 300×200, when the given operation list contains a crop of 300×200, would return false.

Specified by:

hasEffect in interface Operation

Parameters:

fullSize - Full size of the source image.

opList - Operation list of which the operation may or may not be a member.

Returns:

Whether applying the operation in the context of the given full size and operation list would result in a changed image.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setHeight

public void setHeight(Integer height)

Parameters:

height - Integer greater than 0. May be null.

Throws:

IllegalArgumentException - if the given height is invalid.

IllegalStateException - if the instance is frozen.

setMode

public void setMode(ScaleByPixels.Mode scaleMode)

Parameters:

scaleMode - Scale mode to set.

Throws:

IllegalStateException - If the instance is frozen.

setWidth

public void setWidth(Integer width)

Parameters:

width - Integer greater than 0. May be null.

Throws:

IllegalArgumentException - If the given width is invalid.

IllegalStateException - If the instance is frozen.

toString

public String toString()

Returns a string representation of the instance, guaranteed to uniquely represent the instance. The format is:

No-op

none

Aspect-fit-inside

!w,h(,filter)

Other

w,h(,filter)

Overrides:

toString in class Object

Returns:

String representation of the instance.