Module omix.api

Package omix.plugin.motifstamp.writable

Interface EffectorEdge

All Superinterfaces:

AbstractEdge, AbstractEdge, AbstractItem, AbstractItem, EffectorEdge

public interface EffectorEdge
extends EffectorEdge, AbstractEdge

Method Summary

Modifier and Type	Method	Description
MarkerShape	activationArrowShape()	The shape of the edge's arrow when it shows activation.
Brush	activationBrush()	The paint brush of the edge's arrow when it shows activation.
double	arrowSize()	The size of the edge's arrow given as multiple of the edge width.
double	effect()	This field defines the regulatory strength represented by the edge.
MarkerShape	inhibitionArrowShape()	The shape of the edge's arrow when it shows inhibition.
Brush	inhibitionBrush()	The paint brush of the edge's arrow when it shows inhibition.
void	setActivationBrush(Brush value)	Changes the paint brush that the effector edge shows as activation.
void	setArrowSize(double arrowSize)	Changes the arrow size.
void	setDefaultActivationBrush()	Changes the paint brush that the effector edge shows as activation to default.
void	setDefaultArrowSize()	Changes the arrow size to default.
void	setDefaultInhibitionBrush()	Changes the paint brush that the effector edge shows as inhibition to default.
void	setDefaultLineStyle()	Changes the line style of the edge to default.
void	setDefaultLineWidth()	Changes the line width of the edge to default.
void	setDefaultShadow()	Sets the shadow of the edge to default.
void	setDefaultStrokeColor()	Sets the color for the stroke of the item's shape to default.
void	setDefaultStrokeStyle()	Changes the paint style for the stroke of the item's shape to default.
void	setDefaultStrokeWidth()	Changes the stroke width of the item's shape to default.
void	setDefaultTransparency()	Changes the transparency of the item's shape to default.
void	setDefaultUnknownEffectBrush()	Changes the paint brush that the effector edge shows as unknown effect to default.
void	setEffect(double effect)	Changes the edge's effect value.
void	setInhibitionBrush(Brush value)	Changes the paint brush that the effector edge shows as inhibition.
void	setUnknownEffectBrush(Brush value)	Changes the paint brush that the effector edge shows as unknown effect.
MarkerShape	unknownEffectArrowShape()	The shape of the edge's arrow when it shows unknown effect.
Brush	unknownEffectBrush()	The paint brush of the edge's arrow when it shows unknown effect.

Methods inherited from interface omix.plugin.motifstamp.writable.AbstractEdge

blur, lineStyle, lineWidth, setDockingPositions, setLineStyle, setLineWidth, setShadow, setStrokeColor, setStrokeStyle, setStrokeWidth, setTransparency, shadow, strokeColor, strokeStyle, strokeWidth, transparency

Method Details

setEffect

void setEffect(double effect) throws IllegalChangeException

Changes the edge's effect value.

Parameters:

effect -

Throws:

IllegalChangeException

See Also:

EffectorEdge.effect()

setArrowSize

void setArrowSize(double arrowSize) throws IllegalChangeException

Changes the arrow size.

Parameters:

arrowSize -

Throws:

IllegalChangeException

See Also:

EffectorEdge.arrowSize()

setActivationBrush

void setActivationBrush(@NonNull Brush value) throws IllegalChangeException

Changes the paint brush that the effector edge shows as activation.

Parameters:

value -

Throws:

IllegalChangeException

See Also:

EffectorEdge.activationBrush()

setInhibitionBrush

void setInhibitionBrush(@NonNull Brush value) throws IllegalChangeException

Changes the paint brush that the effector edge shows as inhibition.

Parameters:

value -

Throws:

IllegalChangeException

See Also:

EffectorEdge.inhibitionBrush()

setUnknownEffectBrush

void setUnknownEffectBrush(@NonNull Brush value) throws IllegalChangeException

Changes the paint brush that the effector edge shows as unknown effect.

Parameters:

value -

Throws:

IllegalChangeException

See Also:

EffectorEdge.unknownEffectBrush()

setDefaultStrokeWidth

void setDefaultStrokeWidth() throws IllegalChangeException

Changes the stroke width of the item's shape to default.

Throws:

IllegalChangeException

See Also:

EffectorEdge.strokeWidth()

setDefaultLineWidth

void setDefaultLineWidth() throws IllegalChangeException

Changes the line width of the edge to default.

Throws:

IllegalChangeException

See Also:

EffectorEdge.lineWidth()

setDefaultStrokeStyle

void setDefaultStrokeStyle() throws IllegalChangeException

Changes the paint style for the stroke of the item's shape to default.

Throws:

IllegalChangeException

See Also:

Edge.strokeStyle()

setDefaultLineStyle

void setDefaultLineStyle() throws IllegalChangeException

Changes the line style of the edge to default.

Throws:

IllegalChangeException

See Also:

Edge.lineStyle()

setDefaultStrokeColor

void setDefaultStrokeColor() throws IllegalChangeException

Sets the color for the stroke of the item's shape to default.

Throws:

IllegalChangeException

See Also:

Edge.strokeColor()

setDefaultShadow

void setDefaultShadow() throws IllegalChangeException

Sets the shadow of the edge to default.

Throws:

IllegalChangeException

See Also:

Edge.shadow()

setDefaultArrowSize

void setDefaultArrowSize() throws IllegalChangeException

Changes the arrow size to default.

Throws:

IllegalChangeException

See Also:

EffectorEdge.arrowSize()

setDefaultActivationBrush

void setDefaultActivationBrush() throws IllegalChangeException

Changes the paint brush that the effector edge shows as activation to default.

Throws:

IllegalChangeException

See Also:

EffectorEdge.activationBrush()

setDefaultInhibitionBrush

void setDefaultInhibitionBrush() throws IllegalChangeException

Changes the paint brush that the effector edge shows as inhibition to default.

Throws:

IllegalChangeException

See Also:

EffectorEdge.inhibitionBrush()

setDefaultUnknownEffectBrush

void setDefaultUnknownEffectBrush() throws IllegalChangeException

Changes the paint brush that the effector edge shows as unknown effect to default.

Throws:

IllegalChangeException

See Also:

EffectorEdge.unknownEffectBrush()

setDefaultTransparency

void setDefaultTransparency() throws IllegalChangeException

Changes the transparency of the item's shape to default.

Throws:

IllegalChangeException

See Also:

EffectorEdge.transparency()

arrowSize

double arrowSize()

The size of the edge's arrow given as multiple of the edge width. Minimal value is 1.0.

activationArrowShape

MarkerShape activationArrowShape()

The shape of the edge's arrow when it shows activation.

inhibitionArrowShape

MarkerShape inhibitionArrowShape()

The shape of the edge's arrow when it shows inhibition.

unknownEffectArrowShape

MarkerShape unknownEffectArrowShape()

The shape of the edge's arrow when it shows unknown effect.

activationBrush

Brush activationBrush()

The paint brush of the edge's arrow when it shows activation.

inhibitionBrush

Brush inhibitionBrush()

The paint brush of the edge's arrow when it shows inhibition.

unknownEffectBrush

Brush unknownEffectBrush()

The paint brush of the edge's arrow when it shows unknown effect.

effect

double effect()

This field defines the regulatory strength represented by the edge. A value greater 0.0 is interpreted as activation, a value less than 0.0 as inhibition and the 0.0 marks an unknown effect. The effect property is directly visualized by color of the edge (green, yellow, red) and sign of the arrow (+, ?, ‒). When the effect value is between 0.0 and -1.0/1.0 the edge color is interpolated between yellow and red/green.