Classes
enum	HighlightType
Public Member Functions
	ActionDrawInformation (Action parent)
Action	checkClick (float x, float y)
Action	checkClickExpand (float x, float y)
ActionDrawInformation	checkHover (float x, float y, ActionDrawInformation found)
Action	checkPosOverInboundConnector (float mouse_x, float mouse_y)
Action	checkPosOverOutboundConnector (float mouse_x, float mouse_y)
void	clearHightlight ()
void	drawExtendedBox (PApplet applet, Vector2f position, Vector2f drawOffset)
void	drawSimpleBox (PApplet applet, Vector2f position, Vector2f drawOffset, float minHeight)
void	drawSimpleBox (PApplet applet, Vector2f position, Vector2f drawOffset, float minHeight, boolean drawExpandBox)
Rectangle	getBoundingBox ()
Vector2f	getExtendedBoxDimension ()
HighlightType	getHighlight ()
Vector2f	getInboundConnectorPos ()
float	getNameBoxHeight ()
float	getNameWidth ()
Vector2f	getOutboundConnectorPos ()
Vector2f	getSimpleBoxDimension ()
float	getTextHeight ()
boolean	highlightSubsequence (String identifier, boolean expand)
boolean	highlightSubsequence (Action seq, boolean expand)
boolean	IsHover ()
void	notifyModified ()
void	recalculateDimensions (PApplet applet)
void	setHightlight (HighlightType h)
boolean	updateHover (float x, float y)
Public Attributes
Vector2f	globalPosOffset
Vector2f	localPosOffset
Vector2f	position
Static Public Attributes
static final Vector2f	CONNECTOR_DIM = new Vector2f(50f, 7f)
static final float	EXPAND_BOX_HEIGHT = 18f
static final float	INNER_CONTENT_PADDING = 10f
static final float	LINE_HEIGHT = 1.5f
static final float	MAIN_BOX_PADDING = 15f
static final float	SEQUENCE_BOX_PADDING = 10f
Private Member Functions
ActionDrawInformation	checkHoverExpand (float mouse_x, float mouse_y, boolean hasExpandButton, float sequenceBoxHeight, boolean parentExpanded)
ActionDrawInformation	checkHoverExtendedSequence (float x, float y, Action currAction, ActionDrawInformation found)
void	drawBorderAndTitle (PApplet applet, Vector2f position, Vector2f dimension)
void	drawProperties (PApplet applet, Vector2f position)
void	drawSequence (PApplet applet, Vector2f position, Vector2f drawOffset, boolean isExpandedBox)
void	notifyModifiedSubsequences (Action a)
void	setHover (boolean hover)
void	setHoverExpand (boolean hover)
Static Private Member Functions
static void	checkAndAddSizeOfExpandedSequence (PApplet applet, Vector2f currentSequenceBoxSize, Action currAction)
Private Attributes
Action	action
Rectangle	boundingBoxExtended = new Rectangle(0,0,0,0)
Rectangle	boundingBoxSimple = new Rectangle(0,0,0,0)
float	boxOffsetLeft
Color	currentBackgroundBrightColor = backgroundBrightColor
Color	currentBackgroundColor = backgroundColor
Color	currentBorderColor = borderColor
Color	currentExpandBackgroundColor = arrowExpandBackgroundColor
Color	currentExpandBorderColor = arrowExpandBorderColor
Color	currentTextColor = textColor
boolean	drawnAsSimple
boolean	hasExpandButton = false
HighlightType	highlight = HighlightType.NOT_HIGHTLIGHTED
boolean	isHover = false
float	maxKeyWidth
float	maxSubsequenceHeight = 0
float	maxValueWidth
float	nameWidth
boolean	needsRecalculation = true
float	propertiesHeight
Vector2f	sequenceBoxDimension = new Vector2f()
float	textHeight
Static Private Attributes
static final Color	arrowBackgroundColor = new Color(51,105,192,230)
static final Color	arrowBorderColor = new Color(27, 56, 102)
static final Color	arrowExpandBackgroundColor = new Color(125,67,67,230)
static final Color	arrowExpandBorderColor = new Color(94, 61, 61)
static final Color	backgroundBrightColor = new Color(50,50,50)
static final Color	backgroundColor = new Color(30,30,30)
static final Color	borderColor = new Color(100, 100, 100)
static final float	currentStroke = 1.5f
static final float	defaultStroke = 1f
static final Color	highlightBorderColor = new Color(103,134,85)
static final Color	highlightBrightBorderColor = new Color(167,217,137)
static final Color	hoverArrowExpandBackgroundColor = new Color(190,141,141,230)
static final Color	hoverArrowExpandBorderColor = new Color(190, 123, 123)
static final Color	hoverBackgroundBrightColor = new Color(100,100,100)
static final Color	hoverBackgroundColor = new Color(60,60,60)
static final Color	hoverBorderColor = new Color(200, 200, 200)
static final Color	hoverTextColor = new Color(255,255,255)
static final Color	textColor = new Color(240,240,240)

Detailed Description

This class is used in an Action class for saving parameters used during draw of the action. For example this stores the position/size of the action box.

There are two different drawing types:

Simple box: Contains only title and properties
Extended box: Parents and children of action, properties and subsequences.

Author:: Stefan Profanter

See also:: edu.tum.cs.ias.knowrob.vis.actions.Action

Definition at line 28 of file ActionDrawInformation.java.

Constructor & Destructor Documentation

edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.ActionDrawInformation ( Action parent ) [inline]

Constructor

Parameters:

parent Parent action for which this draw infos are

Definition at line 301 of file ActionDrawInformation.java.

Member Function Documentation

static void edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.checkAndAddSizeOfExpandedSequence	(	PApplet	applet,
		Vector2f	currentSequenceBoxSize,
		Action	currAction
	)		`[inline, static, private]`

Needed for calculating the total size of the sequence box. Adds the size of an expanded box to the current calculated size

Parameters:

applet	Applet to draw on
currentSequenceBoxSize	currently calculated size. If a child-sequence is expanded then it's size will be added to this.
currAction	current action for which the subsequences should be checked

Definition at line 388 of file ActionDrawInformation.java.

Action edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.checkClick	(	float	x,
		float	y
	)		`[inline]`

Check if mouse click on position x|y was intended for an action.

Parameters:

x	x coordinate of mouse
y	y coordinate of mouse

Returns:: Action which is under given coordinate of null if none

Definition at line 1133 of file ActionDrawInformation.java.

Action edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.checkClickExpand	(	float	x,
		float	y
	)		`[inline]`

Check if mouse click on position x|y was intended for an expand button.

Parameters:

x	x coordinate of mouse
y	y coordinate of mouse

Returns:: Action for which this expand button is

Definition at line 1148 of file ActionDrawInformation.java.

ActionDrawInformation edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.checkHover	(	float	x,
		float	y,
		ActionDrawInformation	found
	)		`[inline]`

Check if mouse position x|y is over this action

Parameters:

x	x coordinate of mouse
y	y coordinate of mouse
foundInParent	set to true if aleady a matching box was found, so only setHover(false) is needed to call

Returns:: the Action (its draw info) over which the mouse is hovering or null if none.

Definition at line 926 of file ActionDrawInformation.java.

ActionDrawInformation edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.checkHoverExpand	(	float	mouse_x,
		float	mouse_y,
		boolean	hasExpandButton,
		float	sequenceBoxHeight,
		boolean	parentExpanded
	)		`[inline, private]`

Check if mouse position x|y is over an expand arrow

Parameters:

mouse_x	x coordinate of mouse
mouse_y	y coordinate of mouse
sequenceExpandHeight	set to 0 for direct call. Only used for recursing

Returns:: the parent Action (it's draw info) over which's expand arrow the mouse is hovering or null if none.

Definition at line 1019 of file ActionDrawInformation.java.

ActionDrawInformation edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.checkHoverExtendedSequence	(	float	x,
		float	y,
		Action	currAction,
		ActionDrawInformation	found
	)		`[inline, private]`

Check if x|y coordinate is on a currently visible subsequence (also expanded ones)

Parameters:

x	x coordinate
y	y coordinate
currAction	current action to check
found	set to an action if already one action found and the others only need to be resetted.

Returns:: the action where the coordinate is on

Definition at line 894 of file ActionDrawInformation.java.

Action edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.checkPosOverInboundConnector	(	float	mouse_x,
		float	mouse_y
	)		`[inline]`

Check if mouse position is inside inbound connector

Parameters:

mouse_x	x coordinate of mouse
mouse_y	y coordinate of mouse

Returns:: This action (if connector was clicked on), or null if none.

Definition at line 1077 of file ActionDrawInformation.java.

Action edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.checkPosOverOutboundConnector	(	float	mouse_x,
		float	mouse_y
	)		`[inline]`

Check if mouse position is inside outbound connector

Parameters:

mouse_x	x coordinate of mouse
mouse_y	y coordinate of mouse

Returns:: This action (if connector was clicked on), or null if none.

Definition at line 1099 of file ActionDrawInformation.java.

void edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.clearHightlight ( ) [inline]

Clear the highlight status of the action (set it to NOT_HIGHLIGHTED). Also clear the hightlight on all the children.

Definition at line 1210 of file ActionDrawInformation.java.

void edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.drawBorderAndTitle	(	PApplet	applet,
		Vector2f	position,
		Vector2f	dimension
	)		`[inline, private]`

Draw border and title of the action with given dimension at given position

Parameters:

applet	Applet to draw on
position	position where to draw the box
dimension	dimension of the box to draw

Definition at line 519 of file ActionDrawInformation.java.

void edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.drawExtendedBox	(	PApplet	applet,
		Vector2f	position,
		Vector2f	drawOffset
	)		`[inline]`

Draw the extended action box which contains properties and subsequences. Also parent and child actions will be drawn.

Parameters:

applet	Applet to draw on.
position	Upper left corner where to begin to draw. If the action has parent action(s) it will be the position of the first parent box. If none parent actions are present, this will be the upper left corner of the extended box.

Definition at line 800 of file ActionDrawInformation.java.

void edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.drawProperties	(	PApplet	applet,
		Vector2f	position
	)		`[inline, private]`

Draw the action properties beginning at the given position.

Parameters:

applet	Applet to draw on
position	The upper left position to begin the drawing

Definition at line 537 of file ActionDrawInformation.java.

void edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.drawSequence	(	PApplet	applet,
		Vector2f	position,
		Vector2f	drawOffset,
		boolean	isExpandedBox
	)		`[inline, private]`

Draw the parent boxes of this action. These are located over the action box

Parameters:

applet	Applet to draw on
position	start position where to begin to draw

Returns:: ArrayList of Vector2f with the points at the center bottom for drawing connection arrows Draw the child boxes of this action. These are located under the extended action box

Parameters:

applet	Applet to draw on
position	start position where to begin to draw

Returns:: ArrayList of Vector2f with the points at the center bottom for drawing connection arrows Connect each point of parentPoints with the current action box. Do the same with child points. The target points will be calculated by this function with a homogeneous distribution over the whole with of the current action box.

Parameters:

applet	Applet to draw on
parentPoints	Connection points of parent actions
childPoints	Connection points of child actions Draw the subsequence boxes of current action.
applet	Applet to draw on
position	Start position (upper left corner)

Definition at line 712 of file ActionDrawInformation.java.

void edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.drawSimpleBox	(	PApplet	applet,
		Vector2f	position,
		Vector2f	drawOffset,
		float	minHeight
	)		`[inline]`

Draw the simple box. Contains title and properties

Parameters:

applet	Applet to draw on
position	Position where to draw the box
minHeight	minimum height of the box.

Definition at line 559 of file ActionDrawInformation.java.

void edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.drawSimpleBox	(	PApplet	applet,
		Vector2f	position,
		Vector2f	drawOffset,
		float	minHeight,
		boolean	drawExpandBox
	)		`[inline]`

Draw the simple box. Contains title and properties

Parameters:

applet	Applet to draw on
position	Position where to draw the box
minHeight	minimum height of the box.

Definition at line 570 of file ActionDrawInformation.java.

Rectangle edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.getBoundingBox ( ) [inline]

Get the bounding box of currently drawn action. If drawn as simple, the simple bounding box is returned, otherwise the extended bounding box.

Returns:: bounding box as rectangle

Definition at line 1180 of file ActionDrawInformation.java.

Vector2f edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.getExtendedBoxDimension ( ) [inline]

Get dimension of the extended box. The extended box contains title, properties and subsequences

Returns:: the dimension in pixels of the simple box

Definition at line 372 of file ActionDrawInformation.java.

HighlightType edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.getHighlight ( ) [inline]

Get the highlight status of the action

Returns:: the highlight status

Definition at line 1192 of file ActionDrawInformation.java.

Vector2f edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.getInboundConnectorPos ( ) [inline]

Definition at line 1327 of file ActionDrawInformation.java.

float edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.getNameBoxHeight ( ) [inline]

Height of title box of the action

Returns:: Height of the name box in pixels

Definition at line 335 of file ActionDrawInformation.java.

float edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.getNameWidth ( ) [inline]

Get width of name in pixels.

Returns:: Width of name in pixels

Definition at line 344 of file ActionDrawInformation.java.

Vector2f edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.getOutboundConnectorPos ( ) [inline]

Definition at line 1321 of file ActionDrawInformation.java.

Vector2f edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.getSimpleBoxDimension ( ) [inline]

Get dimension of the simple box. The simple box contains only title and properties

Returns:: the dimension in pixels of the simple box

Definition at line 354 of file ActionDrawInformation.java.

float edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.getTextHeight ( ) [inline]

Get height of drawing text

Returns:: text height

Definition at line 1161 of file ActionDrawInformation.java.

boolean edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.highlightSubsequence	(	String	identifier,
		boolean	expand
	)		`[inline]`

Search for a subsequence with the given identifier and highlight it (and also it's parents). If expand is true, all sequences will be expanded so that the highlighted sequence is visible.

Parameters:

identifier	Prolog identifier of the action to highlight
expand	expand all parent actions

Returns:: true if action found and highlighted

Definition at line 1244 of file ActionDrawInformation.java.

boolean edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.highlightSubsequence	(	Action	seq,
		boolean	expand
	)		`[inline]`

Search for the subsequence seq and highlight it (and also it's parents). If expand is true, all sequences will be expanded so that the highlighted sequence is visible.

Parameters:

seq	The action to highlight
expand	expand all parent actions

Returns:: true if action found and highlighted

Definition at line 1286 of file ActionDrawInformation.java.

boolean edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.IsHover ( ) [inline]

Get action state if mouse is hovering over this action.

Returns:: true if hovering

Definition at line 1170 of file ActionDrawInformation.java.

void edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.notifyModified ( ) [inline]

Call this if action properties/subsequences/parents/children changed. This tells the class to recalculate the dimensions of all boxes

Definition at line 325 of file ActionDrawInformation.java.

void edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.notifyModifiedSubsequences ( Action a ) [inline, private]

Notify all subsequences that something has changed and recalculation is needed

Parameters:

a

Definition at line 313 of file ActionDrawInformation.java.

void edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.recalculateDimensions ( PApplet applet ) [inline]

Recalculate the dimension of simple/extended box. Only executed if needsRecalculation is set to true (notifyModified called)

Parameters:

applet Applet used to draw the action. Only used for text calculation. Because width of text is dependent on current text setting

Definition at line 406 of file ActionDrawInformation.java.

void edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.setHightlight ( HighlightType h ) [inline]

Set the highlight status of the action

Parameters:

h	status to set

Definition at line 1201 of file ActionDrawInformation.java.

void edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.setHover ( boolean hover ) [inline, private]

Set the correct colors when hovering over action. If mouse if over action, the hover* colors will be used to draw it.

Parameters:

hover If true use hover* colors, otherwise use normal colors

Definition at line 850 of file ActionDrawInformation.java.

void edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.setHoverExpand ( boolean hover ) [inline, private]

Set the correct colors when hovering over expand arrow. If mouse if over expand arrow, the hover* colors will be used to draw it.

Parameters:

hover If true use hover* colors, otherwise use normal colors

Definition at line 873 of file ActionDrawInformation.java.

boolean edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.updateHover	(	float	x,
		float	y
	)		`[inline]`

Update color of action for current mouse position.

Parameters:

x	x coordinate of mouse
y	y coordinate of mouse

Returns:: true if hovering, false if not

Definition at line 1121 of file ActionDrawInformation.java.

Member Data Documentation

Action edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.action [private]

parent action of this draw info

Definition at line 194 of file ActionDrawInformation.java.

final Color edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.arrowBackgroundColor = new Color(51,105,192,230) [static, private]

Background color of arrow between sequence boxes

Definition at line 110 of file ActionDrawInformation.java.

final Color edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.arrowBorderColor = new Color(27, 56, 102) [static, private]

Border color of arrow between sequence boxes

Definition at line 106 of file ActionDrawInformation.java.

final Color edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.arrowExpandBackgroundColor = new Color(125,67,67,230) [static, private]

Background color of arrow expanding box

Definition at line 118 of file ActionDrawInformation.java.

final Color edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.arrowExpandBorderColor = new Color(94, 61, 61) [static, private]

Border color of arrow for expanding box

Definition at line 114 of file ActionDrawInformation.java.

final Color edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.backgroundBrightColor = new Color(50,50,50) [static, private]

Default background color for subsequence box

Definition at line 82 of file ActionDrawInformation.java.

final Color edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.backgroundColor = new Color(30,30,30) [static, private]

Default background color for boxes

Definition at line 78 of file ActionDrawInformation.java.

final Color edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.borderColor = new Color(100, 100, 100) [static, private]

Default border color for boxes

Definition at line 74 of file ActionDrawInformation.java.

Rectangle edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.boundingBoxExtended = new Rectangle(0,0,0,0) [private]

Position and dimension of Expanded and Simple box

Definition at line 292 of file ActionDrawInformation.java.

Rectangle edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.boundingBoxSimple = new Rectangle(0,0,0,0) [private]

Definition at line 293 of file ActionDrawInformation.java.

float edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.boxOffsetLeft [private]

Maximum box height over all parent actions of this action. Used to draw all parents with same height Maximum box height over all child actions of this action. Used to draw all parents with same height X position of parent boxes X position of child boxes If parent or child boxes are wider than the extended box, the extended box must be shifted a bit to the right. This shift indicates the following variable.

Definition at line 255 of file ActionDrawInformation.java.

final Vector2f edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.CONNECTOR_DIM = new Vector2f(50f, 7f) [static]

Dimensions of the box-connectors

Definition at line 55 of file ActionDrawInformation.java.

Color edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.currentBackgroundBrightColor = backgroundBrightColor [private]

Definition at line 182 of file ActionDrawInformation.java.

Color edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.currentBackgroundColor = backgroundColor [private]

Definition at line 181 of file ActionDrawInformation.java.

Color edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.currentBorderColor = borderColor [private]

Following colors are set to default colors if not hovering

Definition at line 180 of file ActionDrawInformation.java.

Color edu.tum.cs.ias.knowrob.vis.actions.ActionDrawInformation.currentExpandBackgroundColor = arrowExpandBackgroundColor [private]