org.hkijena.jipipe.extensions.parameters.library.roi

Class Margin

java.lang.Object

org.hkijena.jipipe.extensions.parameters.library.roi.Margin

All Implemented Interfaces:

JIPipeParameterCollection

public class Margin
extends Object
implements JIPipeParameterCollection

Parameter that allows users to define a rectangle ROI. Users can define a rectangle the classical way (x, y, width, height), but also other ways.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Margin.List List parameter of Margin

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent

Field Summary

Fields

Modifier and Type	Field and Description
static int	PARAM_BOTTOM
static int	PARAM_HEIGHT
static int	PARAM_LEFT
static int	PARAM_RIGHT
static int	PARAM_TOP
static int	PARAM_WIDTH

Constructor Summary

Constructors

Constructor and Description
Margin() Creates a new instance
Margin(Anchor anchor)
Margin(Margin other) Creates a copy
Margin(Rectangle rectangle) Creates a margin from a rectangle

Method Summary

Modifier and Type	Method and Description
Anchor	getAnchor()
NumericFunctionExpression	getBottom()
EventBus	getEventBus() Gets the event bus that posts events about the parameters
NumericFunctionExpression	getHeight()
Rectangle	getInsideArea(Rectangle availableArea, ExpressionVariables parameters) Generates the rectangle defined by the definition.
NumericFunctionExpression	getLeft()
Set<String>	getRelevantParameterKeys() Finds the parameter keys that are relevant according to the current anchor setting The anchor key 'anchor' is not part of the result.
NumericFunctionExpression	getRight()
NumericFunctionExpression	getTop()
NumericFunctionExpression	getWidth()
void	setAnchor(Anchor anchor)
void	setBottom(NumericFunctionExpression bottom)
void	setHeight(NumericFunctionExpression height)
void	setLeft(NumericFunctionExpression left)
void	setRight(NumericFunctionExpression right)
void	setTop(NumericFunctionExpression top)
void	setWidth(NumericFunctionExpression width)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

addParameterChangeListener, addParameterChangeListener, getContextActions, getParameter, getParameterAccess, isParameterUIVisible, isParameterUIVisible, setParameter, triggerParameterChange, triggerParameterStructureChange, triggerParameterUIChange

Field Detail

PARAM_LEFT

public static final int PARAM_LEFT

See Also:

Constant Field Values

PARAM_TOP

public static final int PARAM_TOP

See Also:

Constant Field Values

PARAM_RIGHT

public static final int PARAM_RIGHT

See Also:

Constant Field Values

PARAM_BOTTOM

public static final int PARAM_BOTTOM

See Also:

Constant Field Values

PARAM_WIDTH

public static final int PARAM_WIDTH

See Also:

Constant Field Values

PARAM_HEIGHT

public static final int PARAM_HEIGHT

See Also:

Constant Field Values

Constructor Detail

Margin

public Margin()

Creates a new instance

Margin

public Margin(Rectangle rectangle)

Creates a margin from a rectangle

Parameters:

rectangle - the rectangle

Margin

public Margin(Margin other)

Creates a copy

Parameters:

other - the original

Margin

public Margin(Anchor anchor)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getRelevantParameterKeys

public Set<String> getRelevantParameterKeys()

Finds the parameter keys that are relevant according to the current anchor setting The anchor key 'anchor' is not part of the result.

Returns:

the keys

getLeft

public NumericFunctionExpression getLeft()

setLeft

public void setLeft(NumericFunctionExpression left)

getTop

public NumericFunctionExpression getTop()

setTop

public void setTop(NumericFunctionExpression top)

getRight

public NumericFunctionExpression getRight()

setRight

public void setRight(NumericFunctionExpression right)

getBottom

public NumericFunctionExpression getBottom()

setBottom

public void setBottom(NumericFunctionExpression bottom)

getWidth

public NumericFunctionExpression getWidth()

setWidth

public void setWidth(NumericFunctionExpression width)

getHeight

public NumericFunctionExpression getHeight()

setHeight

public void setHeight(NumericFunctionExpression height)

getAnchor

public Anchor getAnchor()

setAnchor

public void setAnchor(Anchor anchor)

getInsideArea

public Rectangle getInsideArea(Rectangle availableArea,
                               ExpressionVariables parameters)

Generates the rectangle defined by the definition. If the rectangle is invalid, null is returned

Parameters:

availableArea - rectangle describing the available area.

parameters - additional expression variables

Returns:

Rectangle within the area

getEventBus

public EventBus getEventBus()

Description copied from interface: JIPipeParameterCollection

Gets the event bus that posts events about the parameters

Specified by:

getEventBus in interface JIPipeParameterCollection

Returns:

The event bus triggering JIPipeParameterCollection.ParameterChangedEvent and JIPipeParameterCollection.ParameterStructureChangedEvent