Turtle (API V2.11)

repast.simphony.relogo.ReLogoAgent

All Superinterfaces:

OutOfContextSubject, OutOfContextSubscriber, ReLogoAgent

ReLogo Turtle interface.
Authors:
jozik

Properties Summary

Properties
Type	Name and description
`Number`	`color`
`double`	`heading`
`boolean`	`hiddenQ`
`Object`	`label`
`double`	`labelColor`
`double`	`pcolor`
`int`	`penMode`
`int`	`penSize`
`String`	`shape`
`boolean`	`shapeChanged`
`double`	`size`
`boolean`	`visibilityChanged`
`double`	`xcor`
`double`	`ycor`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addToFixedLeaves(Turtle t)`
	`void`	`addToFreeLeaves(Turtle o)`
	`AgentSet<Link>`	`allLinks()` Returns the agentset of all links.
	`AgentSet<Link>`	`allMyInLinks()` Returns an agentset of all directed links from other turtles to the caller.
	`AgentSet<Link>`	`allMyLinks()` Returns an agentset of all the caller's undirected links.
	`AgentSet<Link>`	`allMyOutLinks()` Returns an agentset of all directed links from the caller to other turtles.
	`boolean`	`allQ(Collection a, Closure closure)` Queries if all agents in a collection are true for a boolean closure.
	`void`	`ask(AgentSet<? extends ReLogoAgent> a, Closure askBlock)` Executes a set of commands for an agentset in random order.
	`void`	`ask(Collection<? extends ReLogoAgent> c, Closure askBlock)` Executes a set of commands for a collection of agents.
	`void`	`ask(Turtle t, Closure askBlock)` Executes a set of commands for a turtle.
	`void`	`ask(Patch p, Closure askBlock)` Executes a set of commands for a patch.
	`void`	`ask(Link l, Closure askBlock)` Executes a set of commands for a link.
	`void`	`askTurtle(Closure cl)` @exclude
	`void`	`back(Number num)` Steps turtle backwards by a distance.
	`void`	`bk(Number num)` Steps turtle backwards by a distance.
	`boolean`	`canMoveQ(Number dist)` Queries if turtle can move a distance.
	`Link`	`createLinkFrom(Turtle t)` Makes a directed link from a turtle to the caller.
	`Link`	`createLinkFrom(Turtle t, Closure closure)` Makes a directed link from a turtle to the caller then executes a set of commands on the created link.
	`Link`	`createLinkTo(Turtle t)` Makes a directed link from the caller to a turtle.
	`Link`	`createLinkTo(Turtle t, Closure closure)` Makes a directed link from the caller to a turtle then executes a set of commands on the created link.
	`Link`	`createLinkWith(Turtle t)` Makes a undirected link between the caller and a turtle.
	`Link`	`createLinkWith(Turtle t, Closure closure)` Makes an undirected link between the caller and a turtle then executes a set of commands on the created link.
	`AgentSet<Link>`	`createLinksFrom(Collection<? extends Turtle> a)` Makes directed links from a collection of agents to the caller.
	`AgentSet<Link>`	`createLinksFrom(Collection<? extends Turtle> a, Closure closure)` Makes directed links from a collection of agents to the caller then executes a set of commands on the created links.
	`AgentSet<Link>`	`createLinksTo(Collection<? extends Turtle> a)` Makes directed links from the caller to a collection of agents.
	`AgentSet<Link>`	`createLinksTo(Collection<? extends Turtle> a, Closure closure)` Makes directed links from the caller to a collection of agents then executes a set of commands on the created links.
	`AgentSet<Link>`	`createLinksWith(Collection<? extends Turtle> a, Closure closure)` Makes undirected links between the caller and a collection of agents then executes a set of commands on the created links.
	`AgentSet<Link>`	`createLinksWith(Collection<? extends Turtle> a)` Makes undirected links between the caller and a collection of agents.
	`void`	`die()` Removes the turtle.
	`double`	`distance(Turtle t)` Returns the distance from the caller to a turtle.
	`double`	`distance(Patch p)` Returns the distance from the caller to a patch.
	`double`	`distancexy(Number nx, Number ny)` Returns the distance from the caller to a point.
	`void`	`downhill(String patchVariable)` Moves the turtle to the lowest value of a patch variable of eight neighboring patches.
	`void`	`downhill4(String patchVariable)` Moves the turtle to the lowest value of a patch variable of four neighboring patches.
	`double`	`dx()` Returns the turtle's x increment for one step.
	`double`	`dy()` Returns the turtle's y increment for one step.
	`void`	`face(Turtle t)` Faces the caller towards a turtle.
	`void`	`face(Patch p)` Faces the caller towards a patch.
	`void`	`facexy(Number nX, Number nY)` Faces the caller towards a point.
	`void`	`fd(Number num)` Steps turtle forward by a distance.
	`void`	`fileShow(Object value)` Prints value with agent identifier to current file with a newline.
	`boolean`	`fixedLeavesContains(Turtle t)`
	`void`	`forward(Number num)` Steps turtle forward by a distance.
	`boolean`	`freeLeavesContains(Object o)`
	`double`	`getColor()` Returns the color of a turtle.
	`double`	`getHeading()` Returns the heading of the turtle.
	`double`	`getHeadingInRads()`
	`Object`	`getLabel()` Returns the label.
	`double`	`getLabelColor()` Returns the label color for a turtle or link.
	`int`	`getMaxPxcor()` Returns the maximum x coordinate for all patches.
	`int`	`getMaxPycor()` Returns the maximum y coordinate for all patches.
	`int`	`getMinPxcor()` Returns the minimum x coordinate for all patches.
	`int`	`getMinPycor()` Returns the minimum y coordinate for all patches.
	`double`	`getPcolor()` Returns the color of patch here.
	`int`	`getPenMode()` Returns the pen setting of a turtle.
	`int`	`getPenSize()` Returns the pen width of a turtle.
	`int`	`getPxcor()` Returns the x coordinate of patch here.
	`int`	`getPycor()` Returns the y coordinate of patch here.
	`String`	`getShape()` Returns the shape of a turtle.
	`double`	`getSize()` Returns the size of a turtle.
	`NdPoint`	`getTurtleLocation()`
	`int`	`getWho()` Returns the id number of a turtle.
	`double`	`getXcor()` Returns the x coordinate of a turtle.
	`double`	`getYcor()` Returns the y coordinate of a turtle.
	`AgentSet<Turtle>`	`hatch(Number number)` Makes a number of new turtles.
	`AgentSet<Turtle>`	`hatch(Number number, Closure closure)` Makes a number of new turtles and then executes a set of commands on the created turtles.
	`AgentSet<Turtle>`	`hatch(Number number, Closure closure, String childType)` Makes a number of new turtles of a specific type and then executes a set of commands on the created turtles.
	`AgentSet<Turtle>`	`hatch(Number number, Closure closure, Class childType)` Makes a number of new turtles of a specific type and then executes a set of commands on the created turtles.
	`void`	`hideTurtle()` Turtle appears hidden.
	`void`	`home()` Turtle goes to (0,0).
	`void`	`ht()` Turtle appears hidden.
	`AgentSet`	`inCone(Collection a, Number num, Number angle)` Returns an agentset within a distance and heading cone of the caller.
	`Link`	`inLinkFrom(Turtle t)` Returns the directed link from a turtle to the caller.
	`boolean`	`inLinkNeighborQ(Turtle t)` Queries if there is a directed link from a turtle to the caller.
	`AgentSet<Turtle>`	`inLinkNeighbors()` Returns the agentset with directed links to the caller.
	`AgentSet`	`inRadius(Collection a, Number num)` Returns an agentset within a distance of the caller.
	`boolean`	`isHiddenQ()` Queries if caller is hidden.
	`boolean`	`isShapeChanged()`
	`boolean`	`isVisibilityChanged()`
	`void`	`jump(Number num)` Moves turtle forward num units.
	`void`	`left(Number num)` Rotates the turtle to the left num degrees.
	`Link`	`link(Number oneEnd, Number otherEnd)` Returns the link between two turtles.
	`Link`	`link(Turtle oneEnd, Turtle otherEnd)` Returns the link between two turtles.
	`boolean`	`linkNeighborQ(Turtle t)` Reports true if there is an undirected link connecting t and the caller.
	`AgentSet<Turtle>`	`linkNeighbors()` Reports the agentset of all turtles found at the other end of undirected links connected to the calling turtle.
	`Link`	`linkWith(Turtle t)` Report the link between t and the caller.
	`AgentSet<Link>`	`links()` Returns the agentset of all generic links.
	`void`	`lt(Number num)` Rotates the turtle to the left num degrees.
	`AgentSet`	`maxNOf(int number, Collection<? extends ReLogoAgent> a, Closure closure)` Returns an agentset consisting of a specified number of agents which have the greatest value when operated on by a set of commands.
	`ReLogoAgent`	`maxOneOf(Collection<? extends ReLogoAgent> a, Closure closure)` Returns the ReLogoAgent with the largest value when operated on by a set of commands.
	`AgentSet`	`minNOf(int number, Collection<? extends ReLogoAgent> a, Closure closure)` Returns an agentset consisting of a specified number of agents which have the lowest value when operated on by a set of commands.
	`ReLogoAgent`	`minOneOf(Collection<? extends ReLogoAgent> a, Closure closure)` Returns the ReLogoAgent with the smallest value when operated on by a set of commands.
	`void`	`moveTo(Turtle t)` Moves a turtle to the same location as turtle t.
	`void`	`moveTo(Patch p)` Moves a turtle to the same location as patch p.
	`void`	`mv(Number number)`
	`AgentSet<Link>`	`myInLinks()` Returns an agentset of generic directed links from other turtles to the caller.
	`AgentSet<Link>`	`myLinks()` Returns an agentset of the caller's generic undirected links.
	`AgentSet<Link>`	`myOutLinks()` Returns an agentset of generic directed links from the caller to other turtles.
	`Object`	`myself()` The agent that initiated the asking.
	`AgentSet<Patch>`	`neighbors()` Returns the agentset of the eight neighboring patches (Moore neighborhood).
	`AgentSet<Patch>`	`neighbors(int extent)` Returns the agentset of patches making up the Moore neighborhood of this turtle (excluding the patch under this turtle) of extent.
	`AgentSet<Patch>`	`neighbors(int extentX, int extentY)` Returns the agentset of patches making up the Moore neighborhood of this turtle (excluding the patch under this turtle) of extents.
	`AgentSet<Patch>`	`neighbors4()` Returns the agentset of the four neighboring patches (von Neumann neighborhood).
	`AgentSet<Patch>`	`neighbors4(int extent)` Returns the agentset of patches making up the von Neumann neighborhood of this turtle (excluding the patch under this turtle) of extent.
	`AgentSet<Patch>`	`neighbors4(int extentX, int extentY)` Returns the agentset of patches making up the von Neumann neighborhood of this turtle (excluding the patch under this turtle) of extents.
	`Stop`	`oldStop()` Stops a turtle executing within a command closure.
	`AgentSet`	`other(Collection a)` Returns an agentset minus the caller.
	`Turtle`	`otherEnd()` Returns the turtle opposite the asking link.
	`boolean`	`outLinkNeighborQ(Turtle t)` Queries if there is a directed link from the caller to the turtle.
	`AgentSet<Turtle>`	`outLinkNeighbors()` Returns the agentset of the caller's out link neighbor turtles.
	`Link`	`outLinkTo(Turtle t)` Returns the caller's directed link to a turtle.
	`Patch`	`patch(Number nX, Number nY)` Returns the patch containing a point.
	`Patch`	`patchAhead(Number distance)` Returns the patch that is at a distance ahead of a turtle.
	`Patch`	`patchAt(Number nX, Number xY)` Returns the patch at a direction (nX, nY) from the caller.
	`Patch`	`patchAtHeadingAndDistance(Number heading, Number distance)` Returns the patch that is at a direction and distance from the caller.
	`Patch`	`patchHere()` Returns the patch where the turtle is located.
	`Patch`	`patchLeftAndAhead(Number angle, Number distance)` Returns the patch that is at a distance and degrees left from the caller.
	`Patch`	`patchRightAndAhead(Number angle, Number distance)` Returns the patch that is at a distance and degrees right from the caller.
	`AgentSet<Patch>`	`patches()` Returns an agentset containing all patches.
	`void`	`pd()` Sets the turtle's pen to draw lines.
	`void`	`pe()` Does nothing, included for translation compatibility.
	`void`	`penDown()` Sets the turtle's pen to draw lines.
	`void`	`penErase()` Does nothing, included for translation compatibility.
	`void`	`penUp()` Sets the turtle's pen to stop drawing lines.
	`void`	`pu()` Sets the turtle's pen to stop drawing lines.
	`int`	`randomPxcor()` Returns a random x coordinate for patches.
	`int`	`randomPycor()` Returns a random y coordinate for patches.
	`double`	`randomXcor()` Returns a random x coordinate for turtles.
	`double`	`randomYcor()` Returns a random y coordinate for turtles.
	`void`	`removeFromFixedLeaves(OutOfContextSubject t)`
	`void`	`removeFromFreeLeaves(Turtle o)`
	`void`	`right(Number num)` Rotates the turtle to the right num degrees.
	`void`	`rt(Number num)` Rotates the turtle to the right num degrees.
	`void`	`run(String string)` Interprets a string as commands then runs the commands.
	`Object`	`runresult(String string)` Interprets a string as a command then returns the result.
	`Turtle`	`self()` Returns this turtle, patch, or link.
	`void`	`setColor(Number color)` Sets the color of a turtle to the value color.
	`void`	`setHeading(Number num)` Sets the heading of the turtle to nNum.
	`void`	`setHiddenQ(boolean hidden)` Sets turtle visibility.
	`void`	`setLabel(Object label)` Sets the label.
	`void`	`setLabelColor(Number labelColor)` Sets the label color for a turtle to labelColor.
	`void`	`setPcolor(Number pcolor)` Sets the color of a patch here to pcolor.
	`void`	`setPenMode(Number penMode)` Sets the pen setting of a turtle to penMode.
	`void`	`setPenSize(Number penSize)` Sets the pen width of a turtle to penSize.
	`void`	`setShape(String shape)` Sets the shape of a turtle to shape.
	`void`	`setShapeChanged(boolean changed)`
	`void`	`setSize(Number size)` Sets the size of a turtle to size.
	`void`	`setVisibilityChanged(boolean b)`
	`void`	`setXcor(Number number)` Sets the x coordinate of a turtle to number.
	`void`	`setYcor(Number number)` Sets the y coordinate of a turtle to number.
	`void`	`setxy(Number x, Number y)` Sets the x-y coordinates of a turtle to (nX, nY).
	`void`	`show(Object value)` Prints value with agent identifier to the console.
	`void`	`showTurtle()` Makes turtle visible.
	`void`	`st()` Makes turtle visible.
	`String`	`toString()` This method provides a human-readable name for the agent.
	`double`	`towards(Turtle t)` Returns the direction to turtle t.
	`double`	`towards(Patch p)` Returns the direction to patch p.
	`double`	`towardsxy(Number x, Number y)` Returns the direction from a turtle or patch to a point.
	`Turtle`	`turtle(Number number)` Returns the turtle of the given number.
	`AgentSet<Turtle>`	`turtles()` Returns an agentset containing all turtles.
	`AgentSet<Turtle>`	`turtlesAt(Number ndx, Number ndy)` Returns the agentset on the patch at the direction (ndx, ndy) from the caller.
	`AgentSet<Turtle>`	`turtlesHere()` Returns an agentset of turtles from the patch of the caller.
	`AgentSet<Turtle>`	`turtlesOn(Patch p)` Returns an agentset of turtles on a given patch.
	`AgentSet<Turtle>`	`turtlesOn(Turtle t)` Returns an agentset of turtles on the same patch as a turtle.
	`AgentSet<Turtle>`	`turtlesOn(Collection a)` Returns an agentset of turtles on the patches in a collection or on the patches that a collection of turtles are.
	`void`	`uphill(String patchVariable)` Moves the turtle to the highest valued patch of patchVariable in the eight neighboring patches plus the current patch.
	`void`	`uphill4(String patchVariable)` Moves the turtle to the highest valued patch of patchVariable in the four neighboring patches plus the current patch.
	`void`	`watchMe()` Does nothing, included for translation compatibility.
	`int`	`worldHeight()` Returns the height of the world.
	`int`	`worldWidth()` Returns the width of the world.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface Comparable`	`compareTo`
`interface OutOfContextSubject`	`notifySubscribers, registerSubscriber, removeSubscriber`
`interface OutOfContextSubscriber`	`update`
`interface ReLogoAgent`	`setMyself`

- Property Detail
  - Number color
  - double heading
  - boolean hiddenQ
  - Object label
  - double labelColor
  - double pcolor
  - int penMode
  - int penSize
  - String shape
  - boolean shapeChanged
  - double size
  - boolean visibilityChanged
  - double xcor
  - double ycor
- Method Detail
  - public void addToFixedLeaves(Turtle t)
  - public void addToFreeLeaves(Turtle o)
  - public AgentSet<Link> allLinks()
    
    Returns the agentset of all links.
    Returns:
    agentset of all links
  - public AgentSet<Link> allMyInLinks()
    
    Returns an agentset of all directed links from other turtles to the caller.
    Returns:
    agentset of directed links from other turtles to the caller
  - public AgentSet<Link> allMyLinks()
    
    Returns an agentset of all the caller's undirected links.
    Returns:
    agentset of the caller's undirected links
  - public AgentSet<Link> allMyOutLinks()
    
    Returns an agentset of all directed links from the caller to other turtles.
    Returns:
    agentset of directed links from the caller to other turtles
  - public boolean allQ(Collection a, Closure closure)
    
    Queries if all agents in a collection are true for a boolean closure.
    Parameters:
    a - a collection of ReLogoAgents
    closure - a boolean closure
    Returns:
    true or false based on whether all agents in a collection are true for closure
  - public void ask(AgentSet<? extends ReLogoAgent> a, Closure askBlock)
    
    Executes a set of commands for an agentset in random order.
    Parameters:
    a - an agentset
    askBlock - a set of commands
  - public void ask(Collection<? extends ReLogoAgent> c, Closure askBlock)
    
    Executes a set of commands for a collection of agents.
    Parameters:
    c - a collection of agents
    askBlock - a set of commands
  - public void ask(Turtle t, Closure askBlock)
    
    Executes a set of commands for a turtle.
    Parameters:
    t - a turtle
    askBlock - a set of commands
  - public void ask(Patch p, Closure askBlock)
    
    Executes a set of commands for a patch.
    Parameters:
    p - a patch
    askBlock - a set of commands
  - public void ask(Link l, Closure askBlock)
    
    Executes a set of commands for a link.
    Parameters:
    l - a link
    askBlock - a set of commands
  - public void askTurtle(Closure cl)
    
    exclude:
  - public void back(Number num)
    
    Steps turtle backwards by a distance.
    Parameters:
    num - a distance
  - public void bk(Number num)
    
    Steps turtle backwards by a distance.
    Parameters:
    num - a distance
  - public boolean canMoveQ(Number dist)
    
    Queries if turtle can move a distance.
    Parameters:
    dist - a distance
    Returns:
    true or false based on whether turtle can move distance
  - public Link createLinkFrom(Turtle t)
    
    Makes a directed link from a turtle to the caller.
    Parameters:
    t - a turtle
    Returns:
    created link
  - public Link createLinkFrom(Turtle t, Closure closure)
    
    Makes a directed link from a turtle to the caller then executes a set of commands on the created link.
    Parameters:
    t - a turtle
    closure - a set of commands
    Returns:
    created link
  - public Link createLinkTo(Turtle t)
    
    Makes a directed link from the caller to a turtle.
    Parameters:
    t - a turtle
    Returns:
    created link
  - public Link createLinkTo(Turtle t, Closure closure)
    
    Makes a directed link from the caller to a turtle then executes a set of commands on the created link.
    Parameters:
    t - a turtle
    closure - a set of commands
    Returns:
    created link
  - public Link createLinkWith(Turtle t)
    
    Makes a undirected link between the caller and a turtle.
    Parameters:
    t - a turtle
    Returns:
    created link
  - public Link createLinkWith(Turtle t, Closure closure)
    
    Makes an undirected link between the caller and a turtle then executes a set of commands on the created link.
    Parameters:
    t - a turtle
    closure - a set of commands
    Returns:
    created link
  - public AgentSet<Link> createLinksFrom(Collection<? extends Turtle> a)
    
    Makes directed links from a collection of agents to the caller.
    Parameters:
    a - a collection of agents
    Returns:
    created links
  - public AgentSet<Link> createLinksFrom(Collection<? extends Turtle> a, Closure closure)
    
    Makes directed links from a collection of agents to the caller then executes a set of commands on the created links.
    Parameters:
    a - a collection of agents
    closure - a set of commands
    Returns:
    created links
  - public AgentSet<Link> createLinksTo(Collection<? extends Turtle> a)
    
    Makes directed links from the caller to a collection of agents.
    Parameters:
    a - a collection of agents
    Returns:
    created links
  - public AgentSet<Link> createLinksTo(Collection<? extends Turtle> a, Closure closure)
    
    Makes directed links from the caller to a collection of agents then executes a set of commands on the created links.
    Parameters:
    a - a collection of agents
    closure - a set of commands
    Returns:
    created links
  - public AgentSet<Link> createLinksWith(Collection<? extends Turtle> a, Closure closure)
    
    Makes undirected links between the caller and a collection of agents then executes a set of commands on the created links.
    Parameters:
    a - a collection of agents
    closure - a set of commands
    Returns:
    created links
  - public AgentSet<Link> createLinksWith(Collection<? extends Turtle> a)
    
    Makes undirected links between the caller and a collection of agents.
    Parameters:
    a - an collection of agents
    Returns:
    created links
  - public void die()
    
    Removes the turtle.
  - public double distance(Turtle t)
    
    Returns the distance from the caller to a turtle.
    returns:
    distance from turtle t to the caller
    
    Parameters:
    t - a turtle
  - public double distance(Patch p)
    
    Returns the distance from the caller to a patch.
    returns:
    distance from patch p to the caller
    
    Parameters:
    p - a patch
  - public double distancexy(Number nx, Number ny)
    
    Returns the distance from the caller to a point.
    returns:
    distance from the caller to the point (nx,ny)
    
    Parameters:
    nx - a number
    ny - a number
  - public void downhill(String patchVariable)
    
    Moves the turtle to the lowest value of a patch variable of eight neighboring patches.
    Parameters:
    patchVariable - a string
  - public void downhill4(String patchVariable)
    
    Moves the turtle to the lowest value of a patch variable of four neighboring patches.
    Parameters:
    patchVariable - a string
  - public double dx()
    
    Returns the turtle's x increment for one step.
    returns:
    turtle's x increment for one step
  - public double dy()
    
    Returns the turtle's y increment for one step.
    returns:
    turtle's y increment for one step
  - public void face(Turtle t)
    
    Faces the caller towards a turtle.
    Parameters:
    t - a turtle
  - public void face(Patch p)
    
    Faces the caller towards a patch.
    Parameters:
    p - a patch
  - public void facexy(Number nX, Number nY)
    
    Faces the caller towards a point.
    Parameters:
    nX - x coordinate
    nY - y coordinate
  - public void fd(Number num)
    
    Steps turtle forward by a distance.
    Parameters:
    num - a distance
  - public void fileShow(Object value)
    
    Prints value with agent identifier to current file with a newline.
    Parameters:
    value - any object
  - public boolean fixedLeavesContains(Turtle t)
  - public void forward(Number num)
    
    Steps turtle forward by a distance.
    Parameters:
    num - a distance
  - public boolean freeLeavesContains(Object o)
  - public double getColor()
    
    Returns the color of a turtle. @ returns color of a turtle in the range [0, 140)
  - public double getHeading()
    
    Returns the heading of the turtle. @ return heading of the turtle in the range [0, 360)
  - public double getHeadingInRads()
  - public Object getLabel()
    
    Returns the label.
    Returns:
    the turtle label
  - public double getLabelColor()
    
    Returns the label color for a turtle or link. @ returns label color in the range [0, 140)
  - public int getMaxPxcor()
    
    Returns the maximum x coordinate for all patches.
    Returns:
    maximum x coordinate for all patches
  - public int getMaxPycor()
    
    Returns the maximum y coordinate for all patches.
    Returns:
    maximum y coordinate for all patches
  - public int getMinPxcor()
    
    Returns the minimum x coordinate for all patches.
    Returns:
    maximum x coordinate for patches
  - public int getMinPycor()
    
    Returns the minimum y coordinate for all patches.
    Returns:
    maximum y coordinate for patches
  - public double getPcolor()
    
    Returns the color of patch here.
    Returns:
    color of patch here in the range [0, 140)
  - public int getPenMode()
    
    Returns the pen setting of a turtle.
    Returns:
    pen setting of a turtle
  - public int getPenSize()
    
    Returns the pen width of a turtle.
    Returns:
    pen width of a turtle
  - public int getPxcor()
    
    Returns the x coordinate of patch here.
    Returns:
    x coordinate of patch here
  - public int getPycor()
    
    Returns the y coordinate of patch here.
    Returns:
    y coordinate of patch here
  - public String getShape()
    
    Returns the shape of a turtle.
    Returns:
    shape of a turtle
  - public double getSize()
    
    Returns the size of a turtle.
    Returns:
    size of a turtle
  - public NdPoint getTurtleLocation()
  - public int getWho()
    
    Returns the id number of a turtle.
    Returns:
    id number of a turtle
  - public double getXcor()
    
    Returns the x coordinate of a turtle.
    Returns:
    present x coordinate of the turtle
  - public double getYcor()
    
    Returns the y coordinate of a turtle.
    Returns:
    y coordinate of a turtle
  - public AgentSet<Turtle> hatch(Number number)
    
    Makes a number of new turtles.
    Parameters:
    number - a number
    Returns:
    created turtles
  - public AgentSet<Turtle> hatch(Number number, Closure closure)
    
    Makes a number of new turtles and then executes a set of commands on the created turtles.
    Parameters:
    number - a number
    closure - a set of commands
    Returns:
    created turtles
  - public AgentSet<Turtle> hatch(Number number, Closure closure, String childType)
    
    Makes a number of new turtles of a specific type and then executes a set of commands on the created turtles.
    Parameters:
    number - a number
    closure - a set of commands
    childType - a string
    number
    closure
    childType
    Returns:
    created turtles
  - public AgentSet<Turtle> hatch(Number number, Closure closure, Class childType)
    
    Makes a number of new turtles of a specific type and then executes a set of commands on the created turtles.
    Parameters:
    number - a number
    closure - a set of commands
    childType - a turtle class
    number
    closure
    childType
    Returns:
    created turtles
  - public void hideTurtle()
    
    Turtle appears hidden.
  - public void home()
    
    Turtle goes to (0,0).
  - public void ht()
    
    Turtle appears hidden.
  - public AgentSet inCone(Collection a, Number num, Number angle)
    
    Returns an agentset within a distance and heading cone of the caller.
    Parameters:
    a - a collection of agents
    num - a distance
    anlge - the cone angle centered on caller's heading
    Returns:
    agentset subset of collection a within a distance num and within cone angle of the caller
  - public Link inLinkFrom(Turtle t)
    
    Returns the directed link from a turtle to the caller.
    Parameters:
    t - a turtle
    Returns:
    directed link from turtle t to the caller
  - public boolean inLinkNeighborQ(Turtle t)
    
    Queries if there is a directed link from a turtle to the caller.
    Parameters:
    t - a turtle
    Returns:
    true or false based on whether there is a directed link from turtle t to the caller
  - public AgentSet<Turtle> inLinkNeighbors()
    
    Returns the agentset with directed links to the caller.
    Returns:
    agentset with directed links to the caller
  - public AgentSet inRadius(Collection a, Number num)
    
    Returns an agentset within a distance of the caller.
    Parameters:
    a - a collection of agents
    num - a distance
    Returns:
    agentset subset of collection a within a distance num of the caller
  - public boolean isHiddenQ()
    
    Queries if caller is hidden.
    Returns:
    true or false based on whether caller is hidden
  - public boolean isShapeChanged()
  - public boolean isVisibilityChanged()
  - public void jump(Number num)
    
    Moves turtle forward num units.
    Parameters:
    num - a number
  - public void left(Number num)
    
    Rotates the turtle to the left num degrees.
    Parameters:
    num - an angle in degrees in the range [0, 360]
  - public Link link(Number oneEnd, Number otherEnd)
    
    Returns the link between two turtles.
    Parameters:
    oneEnd - an integer
    otherEnd - an integer
    Returns:
    link between two turtles
  - public Link link(Turtle oneEnd, Turtle otherEnd)
    
    Returns the link between two turtles.
    Parameters:
    oneEnd - a turtle
    otherEnd - a turtle
    Returns:
    link between two turtles
  - public boolean linkNeighborQ(Turtle t)
    
    Reports true if there is an undirected link connecting t and the caller.
  - public AgentSet<Turtle> linkNeighbors()
    
    Reports the agentset of all turtles found at the other end of undirected links connected to the calling turtle.
  - public Link linkWith(Turtle t)
    
    Report the link between t and the caller. If no link exists then it reports null.
  - public AgentSet<Link> links()
    
    Returns the agentset of all generic links.
    Returns:
    agentset of all links
  - public void lt(Number num)
    
    Rotates the turtle to the left num degrees.
    Parameters:
    num - an angle in degrees in the range [0, 360]
  - public AgentSet maxNOf(int number, Collection<? extends ReLogoAgent> a, Closure closure)
    
    Returns an agentset consisting of a specified number of agents which have the greatest value when operated on by a set of commands.
    Parameters:
    number - an integer
    a - a collection
    closure - a set of commands
    Returns:
    agentset containing number agents with largest values when operated on by closure
  - public ReLogoAgent maxOneOf(Collection<? extends ReLogoAgent> a, Closure closure)
    
    Returns the ReLogoAgent with the largest value when operated on by a set of commands.
    Parameters:
    a - a collection
    closure - a set of commands
    Returns:
    ReLogoAgent with the largest value when operated on by closure
  - public AgentSet minNOf(int number, Collection<? extends ReLogoAgent> a, Closure closure)
    
    Returns an agentset consisting of a specified number of agents which have the lowest value when operated on by a set of commands.
    Parameters:
    number - an integer
    a - a collection
    closure - a set of commands
    Returns:
    agentset containing number agents with smallest values when operated on by closure
  - public ReLogoAgent minOneOf(Collection<? extends ReLogoAgent> a, Closure closure)
    
    Returns the ReLogoAgent with the smallest value when operated on by a set of commands.
    Parameters:
    a - a collection
    closure - a set of commands
    Returns:
    ReLogoAgent with the smallest value when operated on by closure
  - public void moveTo(Turtle t)
    
    Moves a turtle to the same location as turtle t.
    Parameters:
    t - a turtle
  - public void moveTo(Patch p)
    
    Moves a turtle to the same location as patch p.
    Parameters:
    p - a patch
  - public void mv(Number number)
  - public AgentSet<Link> myInLinks()
    
    Returns an agentset of generic directed links from other turtles to the caller.
    Returns:
    agentset of directed links from other turtles to the caller
  - public AgentSet<Link> myLinks()
    
    Returns an agentset of the caller's generic undirected links.
    Returns:
    agentset of the caller's undirected links
  - public AgentSet<Link> myOutLinks()
    
    Returns an agentset of generic directed links from the caller to other turtles.
    Returns:
    agentset of directed links from the caller to other turtles
  - public Object myself()
    
    The agent that initiated the asking.
    Returns:
    the agent that initiated the asking
  - public AgentSet<Patch> neighbors()
    
    Returns the agentset of the eight neighboring patches (Moore neighborhood).
    Returns:
    agentset of the eight neighboring patches
  - public AgentSet<Patch> neighbors(int extent)
    
    Returns the agentset of patches making up the Moore neighborhood of this turtle (excluding the patch under this turtle) of extent.
    Parameters:
    extent - the x and y Moore extents
    Returns:
    Moore agentset of patches with extent
  - public AgentSet<Patch> neighbors(int extentX, int extentY)
    
    Returns the agentset of patches making up the Moore neighborhood of this turtle (excluding the patch under this turtle) of extents.
    Parameters:
    extentX - the x Moore extent
    extentY - the y Moore extent
    Returns:
    Moore agentset of patches with extents
  - public AgentSet<Patch> neighbors4()
    
    Returns the agentset of the four neighboring patches (von Neumann neighborhood).
    Returns:
    agentset of the four neighboring patches
  - public AgentSet<Patch> neighbors4(int extent)
    
    Returns the agentset of patches making up the von Neumann neighborhood of this turtle (excluding the patch under this turtle) of extent.
    Parameters:
    extent - the x and y von Neumann extents
    Returns:
    von Neumann agentset of patches with extent
  - public AgentSet<Patch> neighbors4(int extentX, int extentY)
    
    Returns the agentset of patches making up the von Neumann neighborhood of this turtle (excluding the patch under this turtle) of extents.
    Parameters:
    extentX - the x von Neumann extent
    extentY - the y von Neumann extent
    Returns:
    von Neumann agentset of patches with extents
  - @Deprecatedated public public Stop oldStop()
    
    Stops a turtle executing within a command closure.
    deprecated:
    use the Utility.stop method instead.
  - public AgentSet other(Collection a)
    
    Returns an agentset minus the caller.
    Parameters:
    a - an agentset
    Returns:
    agentset a minus the caller
  - public Turtle otherEnd()
    
    Returns the turtle opposite the asking link.
    Returns:
    turtle opposite the asking link
  - public boolean outLinkNeighborQ(Turtle t)
    
    Queries if there is a directed link from the caller to the turtle.
    Parameters:
    t - a turtle
    Returns:
    true or false based on whether there is a directed link from the caller to the turtle.
  - public AgentSet<Turtle> outLinkNeighbors()
    
    Returns the agentset of the caller's out link neighbor turtles.
    Returns:
    agentset of the caller's out link neighbor turtles
  - public Link outLinkTo(Turtle t)
    
    Returns the caller's directed link to a turtle.
    Parameters:
    t - a turtle
    Returns:
    the caller's directed link to turtle t
  - public Patch patch(Number nX, Number nY)
    
    Returns the patch containing a point.
    Parameters:
    nX - x coordinate
    nY - y coordinate
    Returns:
    patch that contains the point (nX, nY)
  - public Patch patchAhead(Number distance)
    
    Returns the patch that is at a distance ahead of a turtle.
    Parameters:
    distance - a number
    Returns:
    patch that is at distance from the calling turtle
  - public Patch patchAt(Number nX, Number xY)
    
    Returns the patch at a direction (nX, nY) from the caller.
    Parameters:
    nX - a number
    nY - a number
    Returns:
    patch at a direction (nX, nY) from the caller
  - public Patch patchAtHeadingAndDistance(Number heading, Number distance)
    
    Returns the patch that is at a direction and distance from the caller.
    Parameters:
    heading - a number
    distance - a number
    Returns:
    patch that is at heading and distance from the caller
  - public Patch patchHere()
    
    Returns the patch where the turtle is located.
    Returns:
    patch where the turtle is located
  - public Patch patchLeftAndAhead(Number angle, Number distance)
    
    Returns the patch that is at a distance and degrees left from the caller.
    Parameters:
    nAngle - an angle in degrees
    nDistance - a number
    Returns:
    patch that is at nDistance and nAngle left from the caller
  - public Patch patchRightAndAhead(Number angle, Number distance)
    
    Returns the patch that is at a distance and degrees right from the caller.
    Parameters:
    nAngle - an angle in degrees
    nDistance - a number
    Returns:
    patch that is at nDistance and nAngle right from the caller
  - public AgentSet<Patch> patches()
    
    Returns an agentset containing all patches.
    Returns:
    agentset containing all patches
  - public void pd()
    
    Sets the turtle's pen to draw lines.
  - public void pe()
    
    Does nothing, included for translation compatibility.
  - public void penDown()
    
    Sets the turtle's pen to draw lines.
  - public void penErase()
    
    Does nothing, included for translation compatibility.
  - public void penUp()
    
    Sets the turtle's pen to stop drawing lines.
  - public void pu()
    
    Sets the turtle's pen to stop drawing lines.
  - public int randomPxcor()
    
    Returns a random x coordinate for patches.
    Returns:
    random x coordinate for patches
  - public int randomPycor()
    
    Returns a random y coordinate for patches.
    Returns:
    random y coordinate for patches
  - public double randomXcor()
    
    Returns a random x coordinate for turtles.
    Returns:
    random x coordinate for turtles
  - public double randomYcor()
    
    Returns a random y coordinate for turtles.
    Returns:
    random y coordinate for turtles
  - public void removeFromFixedLeaves(OutOfContextSubject t)
  - public void removeFromFreeLeaves(Turtle o)
  - public void right(Number num)
    
    Rotates the turtle to the right num degrees.
    Parameters:
    num - an angle in degrees in the range [0, 360]
  - public void rt(Number num)
    
    Rotates the turtle to the right num degrees.
    Parameters:
    num - an angle in degrees in the range [0, 360]
  - public void run(String string)
    
    Interprets a string as commands then runs the commands.
    Parameters:
    string - a string
  - public Object runresult(String string)
    
    Interprets a string as a command then returns the result.
    Parameters:
    string - a string
    Returns:
    result of interpreting string
  - public Turtle self()
    
    Returns this turtle, patch, or link.
    Returns:
    this turtle, patch, or link.
  - public void setColor(Number color)
    
    Sets the color of a turtle to the value color.
    Parameters:
    color - a number
  - public void setHeading(Number num)
    
    Sets the heading of the turtle to nNum.
    Parameters:
    nNum - a number in degrees
  - public void setHiddenQ(boolean hidden)
    
    Sets turtle visibility.
    Parameters:
    hidden - boolean visibility
  - public void setLabel(Object label)
    
    Sets the label.
    Parameters:
    label - a label
  - public void setLabelColor(Number labelColor)
    
    Sets the label color for a turtle to labelColor.
    Parameters:
    labelColor - a number in range [0, 140)
  - public void setPcolor(Number pcolor)
    
    Sets the color of a patch here to pcolor.
    Parameters:
    pcolor - a number in range [0,140)
  - public void setPenMode(Number penMode)
    
    Sets the pen setting of a turtle to penMode.
    Parameters:
    penMode - a pen mode, PEN_UP or PEN_DOWN
  - public void setPenSize(Number penSize)
    
    Sets the pen width of a turtle to penSize.
    Parameters:
    penSize - a number
  - public void setShape(String shape)
    
    Sets the shape of a turtle to shape.
    Parameters:
    shape - a string
  - public void setShapeChanged(boolean changed)
  - public void setSize(Number size)
    
    Sets the size of a turtle to size.
    Parameters:
    size - a number
  - public void setVisibilityChanged(boolean b)
  - public void setXcor(Number number)
    
    Sets the x coordinate of a turtle to number.
    Parameters:
    number - a number
  - public void setYcor(Number number)
    
    Sets the y coordinate of a turtle to number.
    Parameters:
    number - a number
  - public void setxy(Number x, Number y)
    
    Sets the x-y coordinates of a turtle to (nX, nY).
    Parameters:
    nX - a number
    nY - a number
  - public void show(Object value)
    
    Prints value with agent identifier to the console.
    Parameters:
    value - any object
  - public void showTurtle()
    
    Makes turtle visible.
  - public void st()
    
    Makes turtle visible.
  - public String toString()
    
    This method provides a human-readable name for the agent.
    method:
    toString
  - public double towards(Turtle t)
    
    Returns the direction to turtle t.
    Parameters:
    t - a turtle
    Returns:
    direction from this turtle to turtle t
  - public double towards(Patch p)
    
    Returns the direction to patch p.
    Parameters:
    p - a patch
    Returns:
    direction from this patch to patch p
  - public double towardsxy(Number x, Number y)
    
    Returns the direction from a turtle or patch to a point.
    Parameters:
    x - a number
    y - a number
    Returns:
    direction from a turtle or patch to the point (x, y)
  - public Turtle turtle(Number number)
    
    Returns the turtle of the given number.
    Parameters:
    number - a number
    Returns:
    turtle number
  - public AgentSet<Turtle> turtles()
    
    Returns an agentset containing all turtles.
    Returns:
    agentset of all turtles
  - public AgentSet<Turtle> turtlesAt(Number ndx, Number ndy)
    
    Returns the agentset on the patch at the direction (ndx, ndy) from the caller.
    returns:
    agentset at the direction (ndx, ndy) from the caller
    
    Parameters:
    ndx - a number
    ndy - a number
  - public AgentSet<Turtle> turtlesHere()
    
    Returns an agentset of turtles from the patch of the caller.
    Returns:
    agentset of turtles from the caller's patch
  - public AgentSet<Turtle> turtlesOn(Patch p)
    
    Returns an agentset of turtles on a given patch.
    Parameters:
    p - a patch
    Returns:
    agentset of turtles on patch p
  - public AgentSet<Turtle> turtlesOn(Turtle t)
    
    Returns an agentset of turtles on the same patch as a turtle.
    Parameters:
    t - a turtle
    Returns:
    agentset of turtles on the same patch at turtle t
  - public AgentSet<Turtle> turtlesOn(Collection a)
    
    Returns an agentset of turtles on the patches in a collection or on the patches that a collection of turtles are.
    Parameters:
    a - a collection
    Returns:
    agentset of turtles on the patches in collection a or on the patches that collection a turtles are
  - public void uphill(String patchVariable)
    
    Moves the turtle to the highest valued patch of patchVariable in the eight neighboring patches plus the current patch.
    Parameters:
    patchVariable - a string
  - public void uphill4(String patchVariable)
    
    Moves the turtle to the highest valued patch of patchVariable in the four neighboring patches plus the current patch.
    Parameters:
    patchVariable - a string
  - public void watchMe()
    
    Does nothing, included for translation compatibility.
  - public int worldHeight()
    
    Returns the height of the world.
    Returns:
    height of the world
  - public int worldWidth()
    
    Returns the width of the world.
    Returns:
    width of the world

Summary:
Property
Method

| Detail:
Property
Method

ReLogo API V2.11

[Java] Interface Turtle

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

Number color

double heading

boolean hiddenQ

Object label

double labelColor

double pcolor

int penMode

int penSize

String shape

boolean shapeChanged

double size

boolean visibilityChanged

double xcor

double ycor

Method Detail

public void addToFixedLeaves(Turtle t)

public void addToFreeLeaves(Turtle o)

public AgentSet<Link> allLinks()

public AgentSet<Link> allMyInLinks()

public AgentSet<Link> allMyLinks()

public AgentSet<Link> allMyOutLinks()

public boolean allQ(Collection a, Closure closure)

public void ask(AgentSet<? extends ReLogoAgent> a, Closure askBlock)

public void ask(Collection<? extends ReLogoAgent> c, Closure askBlock)

public void ask(Turtle t, Closure askBlock)

public void ask(Patch p, Closure askBlock)

public void ask(Link l, Closure askBlock)

public void askTurtle(Closure cl)

public void back(Number num)

public void bk(Number num)

public boolean canMoveQ(Number dist)

public Link createLinkFrom(Turtle t)

public Link createLinkFrom(Turtle t, Closure closure)

public Link createLinkTo(Turtle t)

public Link createLinkTo(Turtle t, Closure closure)

public Link createLinkWith(Turtle t)

public Link createLinkWith(Turtle t, Closure closure)

public AgentSet<Link> createLinksFrom(Collection<? extends Turtle> a)

public AgentSet<Link> createLinksFrom(Collection<? extends Turtle> a, Closure closure)

public AgentSet<Link> createLinksTo(Collection<? extends Turtle> a)

public AgentSet<Link> createLinksTo(Collection<? extends Turtle> a, Closure closure)

public AgentSet<Link> createLinksWith(Collection<? extends Turtle> a, Closure closure)

public AgentSet<Link> createLinksWith(Collection<? extends Turtle> a)

public void die()

public double distance(Turtle t)

public double distance(Patch p)

public double distancexy(Number nx, Number ny)

public void downhill(String patchVariable)

public void downhill4(String patchVariable)

public double dx()

public double dy()

public void face(Turtle t)

public void face(Patch p)

public void facexy(Number nX, Number nY)

public void fd(Number num)

public void fileShow(Object value)

public boolean fixedLeavesContains(Turtle t)

public void forward(Number num)

public boolean freeLeavesContains(Object o)

public double getColor()

public double getHeading()

public double getHeadingInRads()

public Object getLabel()

public double getLabelColor()

public int getMaxPxcor()

public int getMaxPycor()

public int getMinPxcor()

public int getMinPycor()

public double getPcolor()

public int getPenMode()

public int getPenSize()

public int getPxcor()

public int getPycor()

public String getShape()

public double getSize()